- Request
- Responses
- 200 OK
- OrderResponseData
- Delivery
- OrderResponseOperation
- Order
- Cart
- PaymentMethod
- ShippingMethod
- Coupon
- Discount
- CartItem
- Measurements
- CartTotal
- CourierOption
- PickupOption
- YandexDeliveryOption
- ItemQuantity
- ItemReceipt
- FlexibleCustomerChoice
- FlexibleTimeIntervals
- Location
- PickupSchedule
- Agent
- MarkQuantity
- Supplier
- TimeInterval
- FlexibleTimeIntervalsGridDescriptor
- PaymentsOperator
- TransferOperator
/v1/orders/
Запрос на получение деталей заказа.
Запрос возвращает детали заказа и список транзакций по возврату.
Request
GET
https://pay.yandex.ru/api/merchant/v1/orders/{order_id}
https://sandbox.pay.yandex.ru/api/merchant/v1/orders/{order_id}
Production
Sandbox
Path parameters
|
Name |
Type |
Description |
|
order_id* |
string |
ID заказа на стороне продавца, который был передан в ответе на /order/create. |
Responses
200 OK
Body
{
"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": [
{
"discountedUnitPrice": "123.45",
"finalPrice": "123.45",
"measurements": {
"height": 0,
"length": 0,
"weight": 0,
"width": 0
},
"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"
}
},
"created": "2022-12-29T18:02:01Z",
"currencyCode": "RUB",
"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 |
Type |
Description |
|
code |
number |
Default: |
|
data |
||
|
status |
string |
Enum: |
OrderResponseData
|
Name |
Type |
Description |
|
delivery |
||
|
operations |
||
|
order |
Delivery
|
Name |
Type |
Description |
|
actualPrice |
string<double> |
Цена доставки для продавца |
|
created |
string<date-time> |
Дата и время создания доставки (ISO 8601) |
|
price* |
string<double> |
Цена доставки для покупателя |
|
status |
string |
Статус доставки |
|
updated |
string<date-time> |
Дата и время обновления доставки (ISO 8601) |
OrderResponseOperation
|
Name |
Type |
Description |
|
amount* |
string<double> |
Сумма операции |
|
approvalCode |
string |
Код подтверждения транзакции от процессингового центра. |
|
created |
string<date-time> |
Дата и время создания операции (ISO 8601) |
|
externalOperationId |
string |
Идентификатор операции на стороне продавца |
|
operationId* |
string<uuid> |
|
|
operationType* |
string |
Enum: |
|
orderId* |
string |
|
|
params |
object |
|
|
reason |
string |
Причина ошибки |
|
status |
string |
Enum: |
|
updated |
string<date-time> |
Дата и время обновления операции (ISO 8601) |
Order
|
Name |
Type |
Description |
|
cart* |
Корзина |
|
|
created |
string<date-time> |
Дата и время создания заказа (ISO 8601) |
|
currencyCode* |
string |
Трехбуквенный код валюты заказа (ISO 4217) |
|
merchantId |
string<uuid> |
|
|
metadata |
string |
Произвольные данные, переданные при инициализации кнопки |
|
orderAmount |
string<double> |
Полная стоимость заказа к оплате с учётом возвратов, доставки, скидок и промокодов |
|
orderId |
string |
Id существующего заказа на стороне продавца, переданный при инициализации кнопки |
|
paymentMethod |
Выбранный способ оплаты |
|
|
paymentStatus |
string |
Enum: |
|
paymentUrl |
string |
Ссылка на оплату заказа |
|
reason |
string |
причина (применимо для статусов VOIDED/FAILED) |
|
shippingMethod |
Выбранный способ доставки |
|
|
updated |
string<date-time> |
Дата и время обновления заказа (ISO 8601) |
Cart
Корзина
|
Name |
Type |
Description |
|
cartId |
string |
Внутренний идентификатор корзины Яндекс Пэй. Бэкенд продавца должен использовать этот параметр как идентификатор корзины покупателя и как ключ идемпотентности для запроса |
|
coupons |
Coupon[] |
Купоны, применённые к корзине |
|
discounts |
Discount[] |
Скидки, применённые к корзине |
|
externalId |
string |
Переданный продавцом идентификатор корзины |
|
items* |
CartItem[] |
Позиция корзины |
|
measurements |
Размеры и вес товара. Обязательно для товара типа |
|
|
total |
Итоговая стоимость корзины, которая пойдет в оплату |
PaymentMethod
Выбранный способ оплаты
|
Name |
Type |
Description |
|
cardLast4 |
string |
|
|
cardNetwork |
string |
Платежная система |
|
methodType* |
string |
Enum: |
ShippingMethod
Выбранный способ доставки
|
Name |
Type |
Description |
|
courierOption |
если methodType == COURIER |
|
|
methodType* |
string |
Enum: |
|
pickupOption |
если methodType == PICKUP |
|
|
yandexDeliveryOption |
если methodType == YANDEX_DELIVERY |
Coupon
|
Name |
Type |
Description |
|
description |
string |
Описание. Например, "Скидка 3%" |
|
status |
string |
Enum: |
|
value* |
string |
Код купона |
Discount
|
Name |
Type |
Description |
|
amount* |
string<double> |
Сумма скидки |
|
description* |
string |
Текстовое описание |
|
discountId* |
string |
Идентификатор скидки в системе мерчанта |
CartItem
|
Name |
Type |
Description |
|
discountedUnitPrice |
string<double> |
Цена за единицу товара с учётом скидок на позицию |
|
finalPrice |
string<double> |
Цена за единицу товара с учётом всех скидок на позицию и на корзину |
|
measurements |
Размеры и вес товара. Обязательно для товара типа |
|
|
productId* |
string |
Id товара в системе продавца. В параметрах запроса каждый идентификатор товара |
|
quantity* |
Количество товара в заказе |
|
|
receipt |
Данные для формирования чека |
|
|
subtotal |
string<double> |
Суммарная цена за позицию без учета скидок |
|
title |
string |
Наименование товара |
|
total |
string<double> |
Суммарная цена за позицию с учётом скидок на позицию |
|
type |
string |
Тип товара. Важен для интеграции с доставками |
|
unitPrice |
string<double> |
Полная цена за единицу товара без учетка скидки |
Measurements
Размеры и вес товара. Обязательно для товара типа PHYSICAL
|
Name |
Type |
Description |
|
height* |
number<float> |
Высота, в метрах |
|
length* |
number<float> |
Длина, в метрах |
|
weight* |
number<float> |
Вес, в килограммах |
|
width* |
number<float> |
Ширина, в метрах |
CartTotal
Итоговая стоимость корзины, которая пойдет в оплату
|
Name |
Type |
Description |
|
amount* |
string<double> |
Стоимость корзины с учетом всех скидок, и без учета доставки |
|
label |
string |
CourierOption
если methodType == COURIER
|
Name |
Type |
Description |
|
allowedPaymentMethods |
string[] |
Индивидуальные методы оплаты для метода доставки. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в |
|
amount* |
string<double> |
Стоимость доставки |
|
category* |
string |
Enum: |
|
courierOptionId* |
string |
id выбранного варианта доставки в системе продавца |
|
customerChoice |
Выбранные пользователем дата и интервал. Только для |
|
|
fromDate |
string<date> |
Ближайшая дата доставки для |
|
fromTime |
string |
Начало интервала времени доставки. Только для |
|
provider |
string |
Тип службы доставки. |
|
receipt |
Данные для формирования чека |
|
|
timeIntervals |
Кодирует интервалы времени доставки, доступные для выбора. Только для |
|
|
title* |
string |
Название способа доставки. Показывается пользователю в списке вариантов |
|
toDate |
string<date> |
Самая поздняя дата доставки для |
|
toTime |
string |
Конец интервала времени доставки. Только для |
|
type |
string |
Тип опции.
Для
|
PickupOption
если methodType == PICKUP
|
Name |
Type |
Description |
|
address* |
string |
Адрес в виде строки |
|
allowedPaymentMethods |
string[] |
Индивидуальные методы оплаты для выбранного способа самовывоза. Доступные методы оплаты заказа при выбранном способе самовывоза. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в |
|
amount |
string<double> |
Стоимость доставки в точку |
|
description |
string |
Дополнительное описание |
|
fromDate |
string<date> |
YYYY-MM-DD. Ближайшая возможная дата доставки |
|
location* |
||
|
phones |
string[] |
Телефоны для связи |
|
pickupPointId* |
string |
Уникальный id точки самовывоза в системе продавца |
|
provider |
string |
Тип точки вывоза. |
|
receipt |
Данные для формирования чека |
|
|
schedule |
График работы точки |
|
|
storagePeriod |
integer<int32> |
Опционально. Срок хранения товара в точке самовывоза в днях |
|
title* |
string |
Название точки самовывоза |
|
toDate |
string<date> |
YYYY-MM-DD. Самая поздняя дата доставки |
YandexDeliveryOption
если methodType == YANDEX_DELIVERY
|
Name |
Type |
Description |
|
allowedPaymentMethods |
string[] |
Индивидуальные методы оплаты для метода доставки. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в |
|
amount* |
string<double> |
Стоимость доставки |
|
category* |
string |
Enum: |
|
fromDatetime |
string<date-time> |
|
|
receipt |
Данные для формирования чека |
|
|
title* |
string |
Название способа доставки. Показывается пользователю в списке вариантов |
|
toDatetime |
string<date-time> |
|
|
yandexDeliveryOptionId* |
string |
Id предложения Яндекс Доставки |
ItemQuantity
Количество товара в заказе
|
Name |
Type |
Description |
|
available |
string<double> |
Максимально доступное количество товара |
|
count* |
string<double> |
Количество товара в заказе |
|
label |
string |
Название единиц измерения, например "кг" или "шт" |
ItemReceipt
Данные для формирования чека
|
Name |
Type |
Description |
|
agent |
||
|
excise |
string<double> |
Не должно содержать больше двух знаков после запятой.
Например: 1.12, 5.1, 10, 11.00 . |
|
markQuantity |
||
|
measure |
integer |
Описание значений: Ссылка |
|
paymentMethodType |
integer |
Описание значений: Ссылка |
|
paymentSubjectType |
integer |
Описание значений: Ссылка |
|
productCode |
string<base64> |
Код товара (base64 кодированный массив от 1 до 32 байт) |
|
supplier |
||
|
tax* |
integer |
Описание значений: Ссылка |
|
title |
string |
FlexibleCustomerChoice
Выбранные пользователем дата и интервал. Только для type: FLEXIBLE
|
Name |
Type |
Description |
|
date* |
string<date> |
|
|
time |
FlexibleTimeIntervals
Кодирует интервалы времени доставки, доступные для выбора. Только для type: FLEXIBLE
|
Name |
Type |
Description |
|
grid |
Кодирует интервалы в виде сетки. Используйте этот формат, если необходимо задать больше 20 интервалов доставки.
Пример: |
|
|
type* |
string |
Если указан тип |
|
values |
Задаёт список интервалов напрямую. Подходит для небольшого количества интервалов доставки. Рекомендуемое максимальная количество интервалов - 20 |
Location
|
Name |
Type |
Description |
|
latitude* |
number<float> |
|
|
longitude* |
number<float> |
PickupSchedule
|
Name |
Type |
Description |
|
fromTime* |
string |
HH:mm, "08:00" |
|
label* |
string |
Например, "пн-пт" |
|
toTime* |
string |
HH:mm, "20:00" |
Agent
|
Name |
Type |
Description |
|
agentType* |
integer |
Описание значений: Ссылка |
|
operation |
string |
|
|
paymentsOperator |
||
|
phones |
string[] |
|
|
transferOperator |
MarkQuantity
|
Name |
Type |
Description |
|
denominator* |
integer<int32> |
|
|
numerator* |
integer<int32> |
Supplier
|
Name |
Type |
Description |
|
inn |
string |
|
|
name |
string |
|
|
phones |
string[] |
TimeInterval
|
Name |
Type |
Description |
|
end* |
string |
Время конца интервала |
|
start* |
string |
Время начала интервала |
FlexibleTimeIntervalsGridDescriptor
Кодирует интервалы в виде сетки. Используйте этот формат, если необходимо задать больше 20 интервалов доставки.
Пример: {"start": "09:00", "end": "21:00", "duration": "00:20", "step": "01:00"} трактуется как набор интервалов: [{"start": "09:00", "end": "09:20"}, {"start": "10:00", "end": "10:20"}, ..., {"start": "20:00", "end": "20:20"}]
|
Name |
Type |
Description |
|
duration* |
string |
Продолжительность каждого интервала |
|
end* |
string |
Максимальное время начала самого последнего интервала |
|
start* |
string |
Время начала самого первого интервала |
|
step* |
string |
Разница во времени между началами двух соседних интервалов |
PaymentsOperator
|
Name |
Type |
Description |
|
phones |
string[] |
TransferOperator
|
Name |
Type |
Description |
|
address |
string |
|
|
inn |
string |
|
|
name |
string |
|
|
phones |
string[] |