/v1/orders/

Запрос на получение деталей заказа.

Запрос возвращает детали заказа и список транзакций по возврату.

Request

GET

https://pay.yandex.uz/api/merchant/v1/orders/{order_id}

Production

GET

https://sandbox.pay.yandex.uz/api/merchant/v1/orders/{order_id}

Sandbox

Path parameters

Name

Description

order_id

Type: string

ID заказа на стороне продавца, который был передан в запросе /orders при создании заказа.

Max length: 2048

Example: ``

Responses

200 OK

Body

application/json

{
  "code": 200,
  "data": {
    "delivery": {
      "actualPrice": "123.45",
      "created": "2025-01-01T00:00:00Z",
      "price": "123.45",
      "status": "NEW",
      "updated": "2025-01-01T00:00:00Z"
    },
    "operations": [
      {
        "amount": "123.45",
        "approvalCode": "example",
        "created": "2025-01-01T00:00:00Z",
        "externalOperationId": "example",
        "operationId": "123e4567-e89b-12d3-a456-426614174000",
        "operationType": "AUTHORIZE",
        "orderId": "example",
        "params": {},
        "reason": "example",
        "status": "PENDING",
        "updated": "2025-01-01T00:00:00Z"
      }
    ],
    "order": {
      "cart": {
        "cartId": "example",
        "coupons": [
          null
        ],
        "discounts": [
          null
        ],
        "externalId": "example",
        "items": [
          null
        ],
        "measurements": {},
        "total": null
      },
      "coolingPeriodExpiresAt": "2025-01-01T00:00:00Z",
      "created": "2025-01-01T00:00:00Z",
      "currencyCode": "RUB",
      "isPrepayment": false,
      "merchantId": "123e4567-e89b-12d3-a456-426614174000",
      "metadata": "example",
      "orderAmount": "123.45",
      "orderId": "example",
      "paymentMethod": {
        "cardLast4": "example",
        "cardNetwork": "AMEX",
        "methodType": "SPLIT"
      },
      "paymentStatus": "PENDING",
      "paymentUrl": "example",
      "reason": "example",
      "updated": "2025-01-01T00:00:00Z"
    }
  },
  "status": "success"
}

Name	Description
code	Type: unknown Default: `200`
data	Type: OrderResponseData Example { "delivery": { "actualPrice": "123.45", "created": "2025-01-01T00:00:00Z", "price": "123.45", "status": "NEW", "updated": "2025-01-01T00:00:00Z" }, "operations": [ { "amount": "123.45", "approvalCode": "example", "created": "2025-01-01T00:00:00Z", "externalOperationId": "example", "operationId": "123e4567-e89b-12d3-a456-426614174000", "operationType": "AUTHORIZE", "orderId": "example", "params": {}, "reason": "example", "status": "PENDING", "updated": "2025-01-01T00:00:00Z" } ], "order": { "cart": { "cartId": "example", "coupons": [ {} ], "discounts": [ {} ], "externalId": "example", "items": [ {} ], "measurements": { "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }, "total": null }, "coolingPeriodExpiresAt": "2025-01-01T00:00:00Z", "created": "2025-01-01T00:00:00Z", "currencyCode": "RUB", "isPrepayment": false, "merchantId": "123e4567-e89b-12d3-a456-426614174000", "metadata": "example", "orderAmount": "123.45", "orderId": "example", "paymentMethod": { "cardLast4": "example", "cardNetwork": "AMEX", "methodType": "SPLIT" }, "paymentStatus": "PENDING", "paymentUrl": "example", "reason": "example", "updated": "2025-01-01T00:00:00Z" } }
status	Type: string Default: `success` Const: `success`

Delivery

Name	Description
price	Type: string<double> Цена доставки для покупателя Example: `123.45`
actualPrice	Type: string<double> Цена доставки для продавца Example: `123.45`
created	Type: string<date-time> Дата и время создания доставки (ISO 8601) Example: `2025-01-01T00:00:00Z`
status	Type: string Статус доставки Default: `NEW` Enum: `NEW`, `ESTIMATING`, `EXPIRED`, `READY_FOR_APPROVAL`, `COLLECTING`, `PREPARING`, `DELIVERING`, `DELIVERED`, `RETURNING`, `RETURNED`, `FAILED`, `CANCELLED`
updated	Type: string<date-time> Дата и время обновления доставки (ISO 8601) Example: `2025-01-01T00:00:00Z`

Example

{
  "actualPrice": "123.45",
  "created": "2025-01-01T00:00:00Z",
  "price": "123.45",
  "status": "NEW",
  "updated": "2025-01-01T00:00:00Z"
}

OrderResponseOperation

Name	Description
amount	Type: string<double> Сумма операции в фиатной валюте Example: `123.45`
operationId	Type: string<uuid> Max length: `2048` Example: `123e4567-e89b-12d3-a456-426614174000`
operationType	Type: string Enum: `AUTHORIZE`, `BIND_CARD`, `REFUND`, `CAPTURE`, `VOID`, `RECURRING`, `PREPAYMENT`, `SUBMIT`
orderId	Type: string Max length: `2048` Example: `example`
approvalCode	Type: string Код подтверждения транзакции от процессингового центра. Example: `example`
created	Type: string<date-time> Дата и время создания операции (ISO 8601) Example: `2025-01-01T00:00:00Z`
externalOperationId	Type: string Идентификатор операции на стороне продавца Max length: `2048` Example: `example`
params	Type: object Example `{}`
reason	Type: string Причина ошибки Max length: `2048` Example: `example`
status	Type: string Default: `PENDING` Enum: `PENDING`, `SUCCESS`, `FAIL`
updated	Type: string<date-time> Дата и время обновления операции (ISO 8601) Example: `2025-01-01T00:00:00Z`

Example

{
  "amount": "123.45",
  "approvalCode": "example",
  "created": "2025-01-01T00:00:00Z",
  "externalOperationId": "example",
  "operationId": "123e4567-e89b-12d3-a456-426614174000",
  "operationType": "AUTHORIZE",
  "orderId": "example",
  "params": {},
  "reason": "example",
  "status": "PENDING",
  "updated": "2025-01-01T00:00:00Z"
}

Coupon

Name	Description
value	Type: string Код купона Max length: `2048` Example: `example`
description	Type: string Описание купона Max length: `2048` Example: `Скидка 3%`
status	Type: string Enum: `VALID`, `INVALID`, `EXPIRED`, `null` Example: `VALID`

Example

{
  "description": "Скидка 3%",
  "status": "VALID",
  "value": "example"
}

Discount

Name	Description
amount	Type: string<double> Сумма скидки Example: `123.45`
description	Type: string Текстовое описание Max length: `2048` Example: `example`
discountId	Type: string Идентификатор скидки в системе продавца Max length: `2048` Example: `example`

Example

{
  "amount": "123.45",
  "description": "example",
  "discountId": "example"
}

CartItemFeatures

Name

Description

pointsDisabled

Type: boolean

Недоступно в Узбекистане.

Default: false

tariffModifier

Type: string

Модификатор тарифа для расчета комиссии. Определяет, какой тариф будет применяться при расчете комиссии за обработку позиции в корзине.

Enum: VERY_LOW, LOW, MEDIUM, HIGH, VERY_HIGH, null

Example: VERY_LOW

Example

{
  "pointsDisabled": false,
  "tariffModifier": "VERY_LOW"
}

Measurements

Name	Description
height	Type: number Высота, в метрах
length	Type: number Длина, в метрах
weight	Type: number Вес, в килограммах
width	Type: number Ширина, в метрах

Example

{
  "height": 0.5,
  "length": 0.5,
  "weight": 0.5,
  "width": 0.5
}

ItemQuantity

Name

Description

count

Type: string<double>

Количество товара в заказе

Example: 123.45

available

Type: string<double>

Максимально доступное количество товара

Example: 123.45

Example

{
  "available": "123.45",
  "count": "123.45"
}

CartItem

Name	Description
productId	Type: string ID товара в системе продавца. В параметрах запроса каждый идентификатор товара `productId` должен быть уникальным Max length: `2048` Example: `example`
quantity	All of 1 type Type: ItemQuantity Example `{ "available": "123.45", "count": "123.45" }` Количество товара в заказе Example `{ "available": "123.45", "count": "123.45" }`
description	Type: string Описание товара Max length: `2048` Example: `example`
discountedUnitPrice	Type: string<double> Цена за единицу товара с учетом скидок на позицию Example: `123.45`
features	All of 1 type Type: CartItemFeatures Example `{ "pointsDisabled": false, "tariffModifier": "VERY_LOW" }` Промо параметры товара Example `{ "pointsDisabled": false, "tariffModifier": "VERY_LOW" }`
finalPrice	Type: string<double> Цена за единицу товара с учетом всех скидок на позицию и на корзину Example: `123.45`
measurements	All of 1 type Type: Measurements Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }` Размеры и вес товара. Обязательно для товара типа `PHYSICAL` Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }`
pointsAmount	Type: string<double> Недоступно в Узбекистане. Example: `123.45`
skuId	Type: string Уникальный ID, который описывает единицу ассортимента. Необходим для применения индивидуального тарифа. Max length: `2048` Example: `example`
subtotal	Type: string<double> Суммарная цена за позицию без учета скидок Example: `123.45`
title	Type: string Наименование товара Max length: `2048` Example: `example`
total	Type: string<double> Суммарная цена за позицию с учетом скидок на позицию Example: `123.45`
type	Type: string Тип товара. Важен для интеграции с доставками Default: `UNSPECIFIED` Enum: `PHYSICAL`, `DIGITAL`, `UNSPECIFIED`
unitPrice	Type: string<double> Полная цена за единицу товара без учета скидки Example: `123.45`

Example

{
  "description": "example",
  "discountedUnitPrice": "123.45",
  "features": {
    "pointsDisabled": false,
    "tariffModifier": "VERY_LOW"
  },
  "finalPrice": "123.45",
  "measurements": {
    "height": 0.5,
    "length": 0.5,
    "weight": 0.5,
    "width": 0.5
  },
  "pointsAmount": "123.45",
  "productId": "example",
  "quantity": {
    "available": "123.45",
    "count": "123.45"
  },
  "skuId": "example",
  "subtotal": "123.45",
  "title": "example",
  "total": "123.45",
  "type": "UNSPECIFIED",
  "unitPrice": "123.45"
}

CartTotal

Name

Description

amount

Type: string<double>

Стоимость корзины с учетом всех скидок.

Example: 123.45

pointsAmount

Type: string<double>

Недоступно в Узбекистане.

Example: 123.45

Example

{
  "amount": "123.45",
  "pointsAmount": "123.45"
}

Cart

Name	Description
items	Type: CartItem[] Список товаров в корзине Example `[ { "description": "example", "discountedUnitPrice": "123.45", "features": { "pointsDisabled": false, "tariffModifier": "VERY_LOW" }, "finalPrice": "123.45", "measurements": { "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }, "pointsAmount": "123.45", "productId": "example", "quantity": { "available": "123.45", "count": "123.45" }, "skuId": "example", "subtotal": "123.45", "title": "example", "total": "123.45", "type": "UNSPECIFIED", "unitPrice": "123.45" } ]`
cartId	Type: string Идентификатор корзины на стороне Яндекса. Max length: `2048` Example: `example`
coupons	Type: Coupon[] Купоны, примененные к корзине Example `[ { "description": "Скидка 3%", "status": "VALID", "value": "example" } ]`
discounts	Type: Discount[] Скидки, примененные к корзине Example `[ { "amount": "123.45", "description": "example", "discountId": "example" } ]`
externalId	Type: string Идентификатор корзины на стороне продавца Max length: `2048` Example: `example`
measurements	Type: Measurements Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }`
total	All of 1 type Type: CartTotal Example `{ "amount": "123.45", "pointsAmount": "123.45" }` Итоговая стоимость корзины, которая пойдет в оплату Default: `null`

Example

{
  "cartId": "example",
  "coupons": [
    {
      "description": "Скидка 3%",
      "status": "VALID",
      "value": "example"
    }
  ],
  "discounts": [
    {
      "amount": "123.45",
      "description": "example",
      "discountId": "example"
    }
  ],
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "123.45",
      "features": {
        "pointsDisabled": false,
        "tariffModifier": "VERY_LOW"
      },
      "finalPrice": "123.45",
      "measurements": {
        "height": 0.5,
        "length": 0.5,
        "weight": 0.5,
        "width": 0.5
      },
      "pointsAmount": "123.45",
      "productId": "example",
      "quantity": {
        "available": "123.45",
        "count": "123.45"
      },
      "skuId": "example",
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "type": "UNSPECIFIED",
      "unitPrice": "123.45"
    }
  ],
  "measurements": null,
  "total": null
}

PaymentMethod

Name	Description
methodType	Type: string Const: `SPLIT` Example: `example`
cardLast4	Type: string Max length: `2048` Example: `example`
cardNetwork	Type: string Платежная система Enum: `AMEX`, `DISCOVER`, `JCB`, `MASTERCARD`, `MAESTRO`, `VISAELECTRON`, `VISA`, `MIR`, `UNIONPAY`, `UZCARD`, `HUMOCARD`, `UNKNOWN`, `UNDEFINED`, `null` Example: `AMEX`

Example

{
  "cardLast4": "example",
  "cardNetwork": "AMEX",
  "methodType": "SPLIT"
}

BaseMerchantApiOrder

Name	Description
cart	All of 1 type Type: Cart Example { "cartId": "example", "coupons": [ { "description": "Скидка 3%", "status": "VALID", "value": "example" } ], "discounts": [ { "amount": "123.45", "description": "example", "discountId": "example" } ], "externalId": "example", "items": [ { "description": "example", "discountedUnitPrice": "123.45", "features": { "pointsDisabled": false, "tariffModifier": "VERY_LOW" }, "finalPrice": "123.45", "measurements": { "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }, "pointsAmount": "123.45", "productId": "example", "quantity": { "available": "123.45", "count": "123.45" }, "skuId": "example", "subtotal": "123.45", "title": "example", "total": "123.45", "type": "UNSPECIFIED", "unitPrice": "123.45" } ], "measurements": null, "total": null } Корзина Example { "cartId": "example", "coupons": [ { "description": "Скидка 3%", "status": "VALID", "value": "example" } ], "discounts": [ { "amount": "123.45", "description": "example", "discountId": "example" } ], "externalId": "example", "items": [ { "description": "example", "discountedUnitPrice": "123.45", "features": null, "finalPrice": "123.45", "measurements": null, "pointsAmount": "123.45", "productId": "example", "quantity": null, "skuId": "example", "subtotal": "123.45", "title": "example", "total": "123.45", "type": "UNSPECIFIED", "unitPrice": "123.45" } ], "measurements": null, "total": null }
currencyCode	Type: string Трехбуквенный код валюты заказа (ISO 4217) Enum: `RUB`, `UZS` Max length: `2048`
coolingPeriodExpiresAt	Type: string<date-time> Дата и время окончания периода охлаждения (ISO 8601) Example: `2025-01-01T00:00:00Z`
created	Type: string<date-time> Дата и время создания заказа (ISO 8601) Example: `2025-01-01T00:00:00Z`
isPrepayment	Type: boolean Проводить ли заказ по флоу «отложенной оплаты». Если параметр установлен в `true`, то заказ будет оформляться как заказ с отложенной оплатой. Default: `false`
merchantId	Type: string<uuid> Max length: `2048` Example: `123e4567-e89b-12d3-a456-426614174000`
metadata	Type: string Произвольные данные, переданные при инициализации кнопки Max length: `2048` Example: `example`
orderAmount	Type: string<double> Полная стоимость заказа к оплате с учетом возвратов, доставки, скидок и промокодов Example: `123.45`
orderId	Type: string ID заказа на стороне продавца, который был передан в /orders. Max length: `2048` Example: `example`
paymentMethod	Type: PaymentMethod Example `{ "cardLast4": "example", "cardNetwork": "AMEX", "methodType": "SPLIT" }`
paymentStatus	Type: string Подробнее читайте в разделе Статусы операций. Enum: `PENDING`, `AUTHORIZED`, `CAPTURED`, `VOIDED`, `REFUNDED`, `CONFIRMED`, `PARTIALLY_REFUNDED`, `FAILED`, `null` Example: `PENDING`
paymentUrl	Type: string Ссылка на оплату заказа Max length: `2048` Example: `example`
reason	Type: string Причина отмены заказа. Применимо для статусов `VOIDED` и `FAILED`. Max length: `2048` Example: `example`
updated	Type: string<date-time> Дата и время обновления заказа (ISO 8601) Example: `2025-01-01T00:00:00Z`

Example

{
  "cart": {
    "cartId": "example",
    "coupons": [
      {
        "description": "Скидка 3%",
        "status": "VALID",
        "value": "example"
      }
    ],
    "discounts": [
      {
        "amount": "123.45",
        "description": "example",
        "discountId": "example"
      }
    ],
    "externalId": "example",
    "items": [
      {
        "description": "example",
        "discountedUnitPrice": "123.45",
        "features": null,
        "finalPrice": "123.45",
        "measurements": null,
        "pointsAmount": "123.45",
        "productId": "example",
        "quantity": null,
        "skuId": "example",
        "subtotal": "123.45",
        "title": "example",
        "total": "123.45",
        "type": "UNSPECIFIED",
        "unitPrice": "123.45"
      }
    ],
    "measurements": {
      "height": 0.5,
      "length": 0.5,
      "weight": 0.5,
      "width": 0.5
    },
    "total": null
  },
  "coolingPeriodExpiresAt": "2025-01-01T00:00:00Z",
  "created": "2025-01-01T00:00:00Z",
  "currencyCode": "RUB",
  "isPrepayment": false,
  "merchantId": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": "example",
  "orderAmount": "123.45",
  "orderId": "example",
  "paymentMethod": {
    "cardLast4": "example",
    "cardNetwork": "AMEX",
    "methodType": "SPLIT"
  },
  "paymentStatus": "PENDING",
  "paymentUrl": "example",
  "reason": "example",
  "updated": "2025-01-01T00:00:00Z"
}

OrderResponseData

Name	Description
delivery	Type: Delivery Example `{ "actualPrice": "123.45", "created": "2025-01-01T00:00:00Z", "price": "123.45", "status": "NEW", "updated": "2025-01-01T00:00:00Z" }`
operations	Type: OrderResponseOperation[] Example `[ { "amount": "123.45", "approvalCode": "example", "created": "2025-01-01T00:00:00Z", "externalOperationId": "example", "operationId": "123e4567-e89b-12d3-a456-426614174000", "operationType": "AUTHORIZE", "orderId": "example", "params": {}, "reason": "example", "status": "PENDING", "updated": "2025-01-01T00:00:00Z" } ]`
order	Type: BaseMerchantApiOrder Example { "cart": { "cartId": "example", "coupons": [ { "description": "Скидка 3%", "status": "VALID", "value": "example" } ], "discounts": [ { "amount": "123.45", "description": "example", "discountId": "example" } ], "externalId": "example", "items": [ { "description": "example", "discountedUnitPrice": "123.45", "features": null, "finalPrice": "123.45", "measurements": null, "pointsAmount": "123.45", "productId": "example", "quantity": null, "skuId": "example", "subtotal": "123.45", "title": "example", "total": "123.45", "type": "UNSPECIFIED", "unitPrice": "123.45" } ], "measurements": { "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }, "total": null }, "coolingPeriodExpiresAt": "2025-01-01T00:00:00Z", "created": "2025-01-01T00:00:00Z", "currencyCode": "RUB", "isPrepayment": false, "merchantId": "123e4567-e89b-12d3-a456-426614174000", "metadata": "example", "orderAmount": "123.45", "orderId": "example", "paymentMethod": { "cardLast4": "example", "cardNetwork": "AMEX", "methodType": "SPLIT" }, "paymentStatus": "PENDING", "paymentUrl": "example", "reason": "example", "updated": "2025-01-01T00:00:00Z" }

Example

{
  "delivery": {
    "actualPrice": "123.45",
    "created": "2025-01-01T00:00:00Z",
    "price": "123.45",
    "status": "NEW",
    "updated": "2025-01-01T00:00:00Z"
  },
  "operations": [
    {
      "amount": "123.45",
      "approvalCode": "example",
      "created": "2025-01-01T00:00:00Z",
      "externalOperationId": "example",
      "operationId": "123e4567-e89b-12d3-a456-426614174000",
      "operationType": "AUTHORIZE",
      "orderId": "example",
      "params": {},
      "reason": "example",
      "status": "PENDING",
      "updated": "2025-01-01T00:00:00Z"
    }
  ],
  "order": {
    "cart": {
      "cartId": "example",
      "coupons": [
        {}
      ],
      "discounts": [
        {}
      ],
      "externalId": "example",
      "items": [
        {}
      ],
      "measurements": {
        "height": 0.5,
        "length": 0.5,
        "weight": 0.5,
        "width": 0.5
      },
      "total": null
    },
    "coolingPeriodExpiresAt": "2025-01-01T00:00:00Z",
    "created": "2025-01-01T00:00:00Z",
    "currencyCode": "RUB",
    "isPrepayment": false,
    "merchantId": "123e4567-e89b-12d3-a456-426614174000",
    "metadata": "example",
    "orderAmount": "123.45",
    "orderId": "example",
    "paymentMethod": {
      "cardLast4": "example",
      "cardNetwork": "AMEX",
      "methodType": "SPLIT"
    },
    "paymentStatus": "PENDING",
    "paymentUrl": "example",
    "reason": "example",
    "updated": "2025-01-01T00:00:00Z"
  }
}

Была ли статья полезна?

/v1/orders

/v1/orders/{order_id}/cancel