/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

Responses

200 OK

Body

application/json

{
    "code": 200,
    "data": {
        "delivery": {
            "actualPrice": "123.45",
            "created": "2022-12-29T18:02:01Z",
            "price": "123.45",
            "status": "NEW",
            "updated": "2022-12-29T18:02:01Z"
        },
        "operations": [
            {
                "amount": "123.45",
                "approvalCode": "string",
                "created": "2022-12-29T18:02:01Z",
                "externalOperationId": "string",
                "operationId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
                "operationType": "AUTHORIZE",
                "orderId": "string",
                "params": {},
                "reason": "string",
                "status": "PENDING",
                "updated": "2022-12-29T18:02:01Z"
            }
        ],
        "order": {
            "cart": {
                "cartId": "string",
                "coupons": [
                    {
                        "description": "Скидка 3%",
                        "status": "VALID",
                        "value": "string"
                    }
                ],
                "discounts": [
                    {
                        "amount": "123.45",
                        "description": "string",
                        "discountId": "string"
                    }
                ],
                "externalId": "string",
                "items": [
                    {
                        "description": "string",
                        "discountedUnitPrice": "123.45",
                        "features": {
                            "pointsDisabled": false,
                            "tariffModifier": "VERY_LOW"
                        },
                        "finalPrice": "123.45",
                        "measurements": {
                            "height": 0,
                            "length": 0,
                            "weight": 0,
                            "width": 0
                        },
                        "pointsAmount": "123.45",
                        "productId": "string",
                        "quantity": {
                            "available": "123.45",
                            "count": "123.45"
                        },
                        "skuId": "string",
                        "subtotal": "123.45",
                        "title": "string",
                        "total": "123.45",
                        "type": "PHYSICAL",
                        "unitPrice": "123.45"
                    }
                ],
                "measurements": {
                    "height": 0,
                    "length": 0,
                    "weight": 0,
                    "width": 0
                },
                "total": {
                    "amount": "123.45",
                    "pointsAmount": "123.45"
                }
            },
            "coolingPeriodExpiresAt": "2022-12-29T18:02:01Z",
            "created": "2022-12-29T18:02:01Z",
            "currencyCode": "RUB",
            "isPrepayment": false,
            "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
            "metadata": "string",
            "orderAmount": "123.45",
            "orderId": "string",
            "paymentMethod": {
                "cardLast4": "string",
                "cardNetwork": "AMEX",
                "methodType": "SPLIT"
            },
            "paymentStatus": "PENDING",
            "paymentUrl": "string",
            "reason": "string",
            "updated": "2022-12-29T18:02:01Z"
        }
    },
    "status": "success"
}

Name	Description
code	Type: number Default: `200`
data	Type: OrderResponseData
status	Type: string Default: `success` Enum: `success`

OrderResponseData

Name	Description
delivery	Type: Delivery
operations	Type: OrderResponseOperation[]
order	Type: BaseMerchantApiOrder

Delivery

Name	Description
price*	Type: string<double> Цена доставки для покупателя Example: `123.45`
actualPrice	Type: string<double> Цена доставки для продавца Example: `123.45`
created	Type: string<date-time> Дата и время создания доставки (ISO 8601)
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)

OrderResponseOperation

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

BaseMerchantApiOrder

Name	Description
cart*	Type: Cart Корзина
currencyCode*	Type: string Трехбуквенный код валюты заказа (ISO 4217) Max length: `2048` Enum: `RUB`, `UZS`
coolingPeriodExpiresAt	Type: string<date-time> Дата и время окончания периода охлаждения (ISO 8601)
created	Type: string<date-time> Дата и время создания заказа (ISO 8601)
isPrepayment	Type: boolean Проводить ли заказ по флоу «отложенной оплаты». Если параметр установлен в `true`, то заказ будет оформляться как заказ с отложенной оплатой. Default: `false`
merchantId	Type: string<uuid> Max length: `2048`
metadata	Type: string Произвольные данные, переданные при инициализации кнопки Max length: `2048`
orderAmount	Type: string<double> Полная стоимость заказа к оплате с учетом возвратов, доставки, скидок и промокодов Example: `123.45`
orderId	Type: string ID заказа на стороне продавца, который был передан в /orders. Max length: `2048`
paymentMethod	Type: PaymentMethod
paymentStatus	Type: string Подробнее читайте в разделе Статусы операций. Enum: `PENDING`, `AUTHORIZED`, `CAPTURED`, `VOIDED`, `REFUNDED`, `CONFIRMED`, `PARTIALLY_REFUNDED`, `FAILED`, `null`
paymentUrl	Type: string Ссылка на оплату заказа Max length: `2048`
reason	Type: string Причина отмены заказа. Применимо для статусов `VOIDED` и `FAILED`. Max length: `2048`
updated	Type: string<date-time> Дата и время обновления заказа (ISO 8601)

Cart

Name	Description
items*	Type: CartItem[] Список товаров в корзине
cartId	Type: string Идентификатор корзины на стороне Яндекса. Max length: `2048`
coupons	Type: Coupon[] Купоны, примененные к корзине
discounts	Type: Discount[] Скидки, примененные к корзине
externalId	Type: string Идентификатор корзины на стороне продавца Max length: `2048`
measurements	Type: Measurements
total	Type: CartTotal Итоговая стоимость корзины, которая пойдет в оплату

PaymentMethod

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

CartItem

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

Coupon

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

Discount

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

Measurements

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

CartTotal

Name

Description

amount*

Type: string<double>

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

Example: 123.45

pointsAmount

Type: string<double>

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

Example: 123.45

ItemQuantity

Name

Description

count*

Type: string<double>

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

Example: 123.45

available

Type: string<double>

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

Example: 123.45

CartItemFeatures

Name

Description

pointsDisabled

Type: boolean

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

Default: false

tariffModifier

Type: string

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

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

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

/v1/orders

/v1/orders/{order_id}/cancel