/v1/orders/

Request to retrieve the order details.

The request returns the order details and the refund transactions.

Request

GET

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

Production

GET

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

Sandbox

Path parameters

Name

Description

order_id*

Type: string

Order ID on the merchant's side that was passed in response to /order/create.

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": "string",
                        "status": "VALID",
                        "value": "string"
                    }
                ],
                "discounts": [
                    {
                        "amount": "123.45",
                        "description": "string",
                        "discountId": "string"
                    }
                ],
                "externalId": "string",
                "items": [
                    {
                        "description": "string",
                        "discountedUnitPrice": "123.45",
                        "finalPrice": "123.45",
                        "measurements": {
                            "height": 0,
                            "length": 0,
                            "weight": 0,
                            "width": 0
                        },
                        "pointsAmount": "123.45",
                        "productId": "string",
                        "quantity": {
                            "available": "123.45",
                            "count": "123.45",
                            "label": "string"
                        },
                        "receipt": {
                            "agent": {
                                "agentType": 1,
                                "operation": "string",
                                "paymentsOperator": {
                                    "phones": [
                                        "string"
                                    ]
                                },
                                "phones": [
                                    "string"
                                ],
                                "transferOperator": {
                                    "address": "string",
                                    "inn": "string",
                                    "name": "string",
                                    "phones": [
                                        "string"
                                    ]
                                }
                            },
                            "excise": "123.45",
                            "markQuantity": {
                                "denominator": 0,
                                "numerator": 0
                            },
                            "measure": 0,
                            "paymentMethodType": 1,
                            "paymentSubjectType": 1,
                            "productCode": "string",
                            "supplier": {
                                "inn": "string",
                                "name": "string",
                                "phones": [
                                    "string"
                                ]
                            },
                            "tax": 1,
                            "title": "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",
                    "label": "string",
                    "pointsAmount": "123.45"
                }
            },
            "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": "CARD"
            },
            "paymentStatus": "PENDING",
            "paymentUrl": "string",
            "reason": "string",
            "shippingMethod": {
                "courierOption": {
                    "allowedPaymentMethods": [
                        "CARD"
                    ],
                    "amount": "123.45",
                    "category": "EXPRESS",
                    "courierOptionId": "string",
                    "customerChoice": {
                        "date": "string",
                        "time": {
                            "end": "string",
                            "start": "string"
                        }
                    },
                    "fromDate": "string",
                    "fromTime": "string",
                    "provider": "BOXBERRY",
                    "receipt": {
                        "agent": {
                            "agentType": 1,
                            "operation": "string",
                            "paymentsOperator": {
                                "phones": [
                                    "string"
                                ]
                            },
                            "phones": [
                                "string"
                            ],
                            "transferOperator": {
                                "address": "string",
                                "inn": "string",
                                "name": "string",
                                "phones": [
                                    "string"
                                ]
                            }
                        },
                        "excise": "123.45",
                        "markQuantity": {
                            "denominator": 0,
                            "numerator": 0
                        },
                        "measure": 0,
                        "paymentMethodType": 1,
                        "paymentSubjectType": 1,
                        "productCode": "string",
                        "supplier": {
                            "inn": "string",
                            "name": "string",
                            "phones": [
                                "string"
                            ]
                        },
                        "tax": 1,
                        "title": "string"
                    },
                    "timeIntervals": {
                        "grid": {
                            "duration": "string",
                            "end": "string",
                            "start": "string",
                            "step": "string"
                        },
                        "type": "GRID",
                        "values": [
                            {
                                "end": "string",
                                "start": "string"
                            }
                        ]
                    },
                    "title": "string",
                    "toDate": "string",
                    "toTime": "string",
                    "type": "PLAIN"
                },
                "methodType": "DIRECT",
                "pickupOption": {
                    "address": "string",
                    "allowedPaymentMethods": [
                        "CARD"
                    ],
                    "amount": "123.45",
                    "description": "string",
                    "fromDate": "string",
                    "location": {
                        "latitude": 0,
                        "longitude": 0
                    },
                    "phones": [
                        "string"
                    ],
                    "pickupPointId": "string",
                    "provider": "YANDEX_MARKET",
                    "receipt": {
                        "agent": {
                            "agentType": 1,
                            "operation": "string",
                            "paymentsOperator": {
                                "phones": [
                                    "string"
                                ]
                            },
                            "phones": [
                                "string"
                            ],
                            "transferOperator": {
                                "address": "string",
                                "inn": "string",
                                "name": "string",
                                "phones": [
                                    "string"
                                ]
                            }
                        },
                        "excise": "123.45",
                        "markQuantity": {
                            "denominator": 0,
                            "numerator": 0
                        },
                        "measure": 0,
                        "paymentMethodType": 1,
                        "paymentSubjectType": 1,
                        "productCode": "string",
                        "supplier": {
                            "inn": "string",
                            "name": "string",
                            "phones": [
                                "string"
                            ]
                        },
                        "tax": 1,
                        "title": "string"
                    },
                    "schedule": [
                        {
                            "fromTime": "string",
                            "label": "string",
                            "toTime": "string"
                        }
                    ],
                    "storagePeriod": 0,
                    "title": "string",
                    "toDate": "string"
                },
                "yandexDeliveryOption": {
                    "allowedPaymentMethods": [
                        "CARD"
                    ],
                    "amount": "123.45",
                    "category": "EXPRESS",
                    "fromDatetime": "2022-12-29T18:02:01Z",
                    "receipt": {
                        "agent": {
                            "agentType": 1,
                            "operation": "string",
                            "paymentsOperator": {
                                "phones": [
                                    "string"
                                ]
                            },
                            "phones": [
                                "string"
                            ],
                            "transferOperator": {
                                "address": "string",
                                "inn": "string",
                                "name": "string",
                                "phones": [
                                    "string"
                                ]
                            }
                        },
                        "excise": "123.45",
                        "markQuantity": {
                            "denominator": 0,
                            "numerator": 0
                        },
                        "measure": 0,
                        "paymentMethodType": 1,
                        "paymentSubjectType": 1,
                        "productCode": "string",
                        "supplier": {
                            "inn": "string",
                            "name": "string",
                            "phones": [
                                "string"
                            ]
                        },
                        "tax": 1,
                        "title": "string"
                    },
                    "title": "string",
                    "toDatetime": "2022-12-29T18:02:01Z",
                    "yandexDeliveryOptionId": "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: Order

Delivery

Name	Description
price*	Type: string<double> Delivery cost for the customer Example: `123.45`
actualPrice	Type: string<double> Delivery cost for the merchant Example: `123.45`
created	Type: string<date-time> Date and time when the delivery was created (ISO 8601)
status	Type: string Delivery status Default: `NEW` Enum: `NEW`, `ESTIMATING`, `EXPIRED`, `READY_FOR_APPROVAL`, `COLLECTING`, `PREPARING`, `DELIVERING`, `DELIVERED`, `RETURNING`, `RETURNED`, `FAILED`, `CANCELLED`
updated	Type: string<date-time> Date and time when the delivery was updated (ISO 8601)

OrderResponseOperation

Name	Description
amount*	Type: string<double> Transaction amount in a fiat currency 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 Code of transaction confirmation received from the processing center.
created	Type: string<date-time> Date and time when the operation was created (ISO 8601)
externalOperationId	Type: string Operation ID on the merchant side Max length: `2048`
params	Type: object
reason	Type: string Error cause Max length: `2048`
status	Type: string Default: `PENDING` Enum: `PENDING`, `SUCCESS`, `FAIL`
updated	Type: string<date-time> Date and time when the operation was updated (ISO 8601)

Order

Name	Description
cart*	Type: Cart Cart
currencyCode*	Type: string Three-letter code of the order currency code (ISO 4217) Max length: `2048` Enum: `RUB`
created	Type: string<date-time> Date and time when the order was created (ISO 8601)
isPrepayment	Type: boolean Flag indicating if the "deferred payment" flow is used for the order Default:
merchantId	Type: string<uuid> Max length: `2048`
metadata	Type: string Arbitrary data transmitted at button initialization Max length: `2048`
orderAmount	Type: string<double> Total cost of the order to be paid, including refunds, delivery costs, discounts, and promo codes Example: `123.45`
orderId	Type: string ID assigned to the existing order on the merchant side and transmitted at button initialization Max length: `2048`
paymentMethod	Type: PaymentMethod Selected payment method
paymentStatus	Type: string Enum: `PENDING`, `AUTHORIZED`, `CAPTURED`, `VOIDED`, `REFUNDED`, `CONFIRMED`, `PARTIALLY_REFUNDED`, `FAILED`, `null`
paymentUrl	Type: string Link to paying for the order Max length: `2048`
reason	Type: string reason (applicable to the VOIDED/FAILED statuses) Max length: `2048`
shippingMethod	Type: ShippingMethod Selected delivery method.
updated	Type: string<date-time> Date and time when the order was updated (ISO 8601)

Cart

Name	Description
items*	Type: CartItem[] Cart item
cartId	Type: string The internal ID of the Yandex Pay cart. The store's backend must use this parameter as the ID of the customer cart and the idempotency key for the `/order/create` request. If the store's backend receives a repeat `/order/create` request, return the existing order ID. The store's backend can create no more than one order (`orderId`) per cart (`cartId`). Max length: `2048`
coupons	Type: Coupon[] Coupons applied to the cart
discounts	Type: Discount[] Discounts applied to the cart
externalId	Type: string Cart ID passed by the merchant Max length: `2048`
measurements	Type: Measurements
total	Type: CartTotal Total cart cost that the customer is to pay

PaymentMethod

Name	Description
methodType*	Type: string Enum: `CARD`, `SPLIT`, `SBP`, `SPLIT_SBP`, `CASH_ON_DELIVERY`, `CARD_ON_DELIVERY`
cardLast4	Type: string Max length: `2048`
cardNetwork	Type: string Payment system Enum: `AMEX`, `DISCOVER`, `JCB`, `MASTERCARD`, `MAESTRO`, `VISAELECTRON`, `VISA`, `MIR`, `UNIONPAY`, `UZCARD`, `HUMOCARD`, `UNKNOWN`, `UNDEFINED`, `null`

ShippingMethod

Name	Description
methodType*	Type: string Enum: `DIRECT`, `PICKUP`, `COURIER`, `YANDEX_DELIVERY`
courierOption	Type: CourierOption if methodType == COURIER
pickupOption	Type: PickupOption if methodType == PICKUP
yandexDeliveryOption	Type: YandexDeliveryOption if methodType == YANDEX_DELIVERY

CartItem

Name	Description
productId*	Type: string Product ID in the merchant system Make sure that each `productId` in the request parameters is unique. Max length: `2048`
quantity*	Type: ItemQuantity Product quantity in the order
description	Type: string Product description Max length: `2048`
discountedUnitPrice	Type: string<double> Price per product unit with discount per item Example: `123.45`
finalPrice	Type: string<double> Price per product unit with all discounts per item and on the cart Example: `123.45`
measurements	Type: Measurements Product dimensions and weight. Required for the `PHYSICAL` product
pointsAmount	Type: string<double> Number of Plus points Example: `123.45`
receipt	Type: ItemReceipt Data for receipt generation
subtotal	Type: string<double> Total price per item without discount Example: `123.45`
title	Type: string Product name Max length: `2048`
total	Type: string<double> Total price per item with item discount Example: `123.45`
type	Type: string Product type. Important for integrating with delivery services Default: `UNSPECIFIED` Enum: `PHYSICAL`, `DIGITAL`, `UNSPECIFIED`
unitPrice	Type: string<double> Total price per product unit without discount Example: `123.45`

Coupon

Name	Description
value*	Type: string Coupon code Max length: `2048`
description	Type: string Description For example, "3% discount" Max length: `2048`
status	Type: string Enum: `VALID`, `INVALID`, `EXPIRED`, `null`

Discount

Name	Description
amount*	Type: string<double> Discount amount Example: `123.45`
description*	Type: string Text description Max length: `2048`
discountId*	Type: string Discount ID in the merchant system Max length: `2048`

Measurements

Name	Description
height*	Type: number<float> Height, in meters
length*	Type: number<float> Length, in meters
weight*	Type: number<float> Weight, in kilograms
width*	Type: number<float> Width, in meters

CartTotal

Name	Description
amount*	Type: string<double> Cart cost with all discounts Example: `123.45`
label	Type: string Name of measurement units, for example, "kg" or "pcs" Max length: `2048`
pointsAmount	Type: string<double> Number of plus points Example: `123.45`

CourierOption

Name	Description
amount*	Type: string<double> Delivery cost Example: `123.45`
category*	Type: string Enum: `EXPRESS`, `TODAY`, `STANDARD`
courierOptionId*	Type: string ID of the selected delivery method in the merchant system Max length: `2048`
title*	Type: string Delivery method name. Shown to the user in the option list Max length: `2048`
allowedPaymentMethods	Type: string[] Individual payment methods for the delivery method. Use this parameter if you want to restrict the payment methods specified in `availablePaymentMethods`. If the parameter is omitted, all the payment methods listed in `availablePaymentMethods` are used. Enum: `CARD`, `SPLIT`, `CASH_ON_DELIVERY`, `CARD_ON_DELIVERY`
customerChoice	Type: FlexibleCustomerChoice Date and interval selected by the user. Only for `type: FLEXIBLE`
fromDate	Type: string<date> Closest delivery date for `type: PLAIN`. Start of the interval of the delivery date selection for `type: FLEXIBLE`
fromTime	Type: string Start of the delivery time interval. Only for `type: PLAIN`
provider	Type: string Delivery service type. Enum: `BOXBERRY`, `CDEK`, `RUSSIAN_POST`, `EMS`, `COURIER`, `DHL`, `EXPRESS_DELIVERY`, `FIVEPOST`, `OZON_ROCKET`, `DPD`, `SBER_LOGISTICS`, `PEK`, `PICKPOINT`, `KCE`, `PONY_EXPRESS`, `YANDEX_DELIVERY`, `null`
receipt	Type: ItemReceipt
timeIntervals	Type: FlexibleTimeIntervals Codes the intervals of the delivery time available for selection. Only for `type: FLEXIBLE`
toDate	Type: string<date> Latest delivery date for `type: PLAIN`. End of the interval of the delivery date selection for `type: FLEXIBLE`
toTime	Type: string End of the delivery time interval. Only for `type: PLAIN`
type	Type: string Option type. For `FLEXIBLE` delivery options, the user can select the desirable date and interval: The delivery date is selected by the user in the interval `[fromDate, toDate]` To give the user an option to select an interval within a day, fill out `timeIntervals` No such choice is provided for `PLAIN` options. Default: `PLAIN` Enum: `PLAIN`, `FLEXIBLE`

PickupOption

Name	Description
address*	Type: string Address in string format Max length: `2048`
location*	Type: Location
pickupPointId*	Type: string Unique pickup point ID in the merchant's system Max length: `2048`
title*	Type: string Pickup point's name Max length: `2048`
allowedPaymentMethods	Type: string[] Individual payment methods for the selected pickup method. Methods that can be used to pay for the order with the selected pickup method. Use this parameter if you want to restrict the payment methods specified in `availablePaymentMethods`. If the parameter is omitted, all the payment methods listed in `availablePaymentMethods` are used. Enum: `CARD`, `SPLIT`, `CASH_ON_DELIVERY`, `CARD_ON_DELIVERY`
amount	Type: string<double> Cost of delivery to the location Example: `123.45`
description	Type: string Additional description Max length: `2048`
fromDate	Type: string<date> YYYY-MM-DD. Closest possible delivery date
phones	Type: string[] Contact phone numbers Max length: `2048`
provider	Type: string Pickup point's type. Enum: `YANDEX_MARKET`, `BOXBERRY`, `CDEK`, `IN_STORE`, `RUSSIAN_POST`, `PICKPOINT`, `DPD`
receipt	Type: ItemReceipt
schedule	Type: PickupSchedule[] Pickup point's schedule
storagePeriod	Type: integer<int32> Optional. Storage period at the pickup point, in days.
toDate	Type: string<date> YYYY-MM-DD. Latest delivery date

YandexDeliveryOption

Name	Description
amount*	Type: string<double> Delivery cost Example: `123.45`
category*	Type: string Enum: `EXPRESS`, `TODAY`, `STANDARD`
title*	Type: string Delivery method name. Shown to the user in the option list Max length: `2048`
yandexDeliveryOptionId*	Type: string ID of the Yandex Delivery offer Max length: `2048`
allowedPaymentMethods	Type: string[] Individual payment methods for the delivery method. Use this parameter if you want to restrict the payment methods specified in `availablePaymentMethods`. If the parameter is omitted, all the payment methods listed in `availablePaymentMethods` are used. Enum: `CARD`, `SPLIT`, `CASH_ON_DELIVERY`, `CARD_ON_DELIVERY`
fromDatetime	Type: string<date-time>
receipt	Type: ItemReceipt
toDatetime	Type: string<date-time>

ItemQuantity

Name	Description
count*	Type: string<double> Product quantity in the order Example: `123.45`
available	Type: string<double> Maximum available product quantity Example: `123.45`
label	Type: string Name of measurement units, for example, "kg" or "pcs" Max length: `2048`

ItemReceipt

Name	Description
tax*	Type: integer Value description: Link Enum: `1`, `2`, `3`, `4`, `5`, `6`
agent	Type: Agent
excise	Type: string<double> It shouldn't include more than two decimal digits. For example: 1.12, 5.1, 10, 11.00 . Example: `123.45`
markQuantity	Type: MarkQuantity
measure	Type: integer Value description: Link Enum: `0`, `10`, `11`, `12`, `20`, `21`, `22`, `30`, `31`, `32`, `40`, `41`, `42`, `50`, `51`, `70`, `71`, `72`, `73`, `80`, `81`, `82`, `83`, `255`, `null`
paymentMethodType	Type: integer Value description: Link Enum: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `null`
paymentSubjectType	Type: integer Value description: Link Enum: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `20`, `21`, `22`, `23`, `24`, `25`, `26`, `null`
productCode	Type: string<base64> Product code (a base64-encoded array of 1 to 32 bytes)
supplier	Type: Supplier
title	Type: string Max length: `2048`

FlexibleCustomerChoice

Name	Description
date*	Type: string<date>
time	Type: TimeInterval

FlexibleTimeIntervals

Name	Description
type*	Type: string For the `GRID` type, fill in the `grid` field. If the `VALUES` type is specified, set the `values` field. Enum: `GRID`, `VALUES`
grid	Type: FlexibleTimeIntervalsGridDescriptor Encodes the intervals as a grid. Use this format if you want to set more than 20 delivery intervals. Example: `{"start": "09:00", "end": "21:00", "duration": "00:20", "step": "01:00"}` is treated as a set of intervals: `[{"start": "09:00", "end": "09:20"}, {"start": "10:00", "end": "10:20"}, ..., {"start": "20:00", "end": "20:20"}]`
values	Type: TimeInterval[] Set the list of intervals directly. Suitable for a small number of delivery intervals. The maximum recommended number of intervals is 20

Location

Name	Description
latitude*	Type: number<float>
longitude*	Type: number<float>

PickupSchedule

Name	Description
fromTime*	Type: string HH:mm, "08:00"
label*	Type: string For example, "Mon-Fri" Max length: `2048`
toTime*	Type: string HH:mm, "20:00"

Agent

Name	Description
agentType*	Type: integer Agent type by taxable object. See values Enum: `1`, `2`, `3`, `4`, `5`, `6`, `7`
operation	Type: string Max length: `2048`
paymentsOperator	Type: PaymentsOperator
phones	Type: string[] Max length: `2048`
transferOperator	Type: TransferOperator

MarkQuantity

Name	Description
denominator*	Type: integer<int32>
numerator*	Type: integer<int32>

Supplier

Name	Description
inn	Type: string Max length: `2048`
name	Type: string Max length: `2048`
phones	Type: string[] Max length: `2048`

TimeInterval

Name

Description

end*

Type: string

Interval end time

start*

Type: string

Interval start time

FlexibleTimeIntervalsGridDescriptor

Name	Description
duration*	Type: string Duration of each interval
end*	Type: string Maximum start time for the latest interval
start*	Type: string Start time for the very first interval
step*	Type: string Difference in time between the starts of two neighboring intervals

PaymentsOperator

Name

Description

phones

Type: string[]

Max length: 2048

TransferOperator

Name	Description
address	Type: string Max length: `2048`
inn	Type: string Max length: `2048`
name	Type: string Max length: `2048`
phones	Type: string[] Max length: `2048`

/v1/orders/

Request

Path parameters

Responses

200 OK

Body

OrderResponseData

Delivery

OrderResponseOperation

Order

Cart

PaymentMethod

ShippingMethod

CartItem

Coupon

Discount

Measurements

CartTotal

CourierOption

PickupOption

YandexDeliveryOption

ItemQuantity

ItemReceipt

FlexibleCustomerChoice

FlexibleTimeIntervals

Location

PickupSchedule

Agent

MarkQuantity

Supplier

TimeInterval

FlexibleTimeIntervalsGridDescriptor

PaymentsOperator

TransferOperator

Was the article helpful?