/v1/order/render

Запрос информации для отображения корзины.

В параметрах запроса передаются идентификаторы товаров и их количество или номер заказа. В ответе возвращаются параметры и контент для формы Яндекс Пэй.

На входе идентификаторы товаров и их количество.
Имеется возможность передать произвольные данные в поле metadata с фронтенда продавца на бэкенд магазина. Метод вызывается при изменении состава корзины, выборе адреса, способа доставки, вводе промокодов. Продавцу необходимо проверять состав заказа и заполнять детальную информацию для товаров, способов доставки и промокодов, пересчитывать стоимости товаров и всего заказа.

В ответе ожидаются детальная информация по заказу и товарам:

Доступные типы способов оплаты и доставки в availablePaymentMethods, shipping.availableMethods
Дополнительные данные пользователя необходимые для оформления заказа, в requiredFields
Стоимость каждого товара и название. Опционально, максимально доступное количество товара
Информация о скидках, примененных к корзине, в discounts

Request

POST

https://example.merchant.ru/v1/order/render

Production

POST

https://sandbox.example.merchant.ru/v1/order/render

Sandbox

Body

application/json

{
    "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",
                "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"
        }
    },
    "currencyCode": "RUB",
    "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
    "metadata": "string",
    "orderId": "string",
    "paymentMethod": {
        "cardLast4": "string",
        "cardNetwork": "AMEX",
        "methodType": "CARD"
    },
    "shippingAddress": {
        "addressLine": "string",
        "building": "string",
        "comment": "string",
        "country": "string",
        "district": "string",
        "entrance": "string",
        "floor": "string",
        "intercom": "string",
        "locale": "string",
        "locality": "string",
        "location": {
            "latitude": 0,
            "longitude": 0
        },
        "region": "string",
        "room": "string",
        "street": "string",
        "zip": "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"
        }
    }
}

Name	Type	Description
cart*	CartWithoutFinalPrice	Корзина c ценами, размером и весом товаров
currencyCode*	string	Трехбуквенный код валюты заказа (ISO 4217) Enum: `RUB`
merchantId	string<uuid>
metadata	string	Произвольные данные, переданные при инициализации кнопки
orderId	string	Id существующего заказа на стороне продавца, переданный при инициализации кнопки
paymentMethod	PaymentMethod	Выбранный способ оплаты
shippingAddress	Address	Адрес доставки доступен, если выбран метод COURIER
shippingMethod	ShippingMethod	Выбранный способ доставки

CartWithoutFinalPrice

Корзина c ценами, размером и весом товаров

Name	Type	Description
cartId	string	Внутренний идентификатор корзины Яндекс Пэй. Бэкенд магазина должен использовать этот параметр как идентификатор корзины покупателя и как ключ идемпотентности для запроса `/order/create`. Если бэкенд магазина получает повторный запрос `/order/create`, то необходимо вернуть уже созданный номер заказа. На одну корзину (`cartId`) бэкенд магазина может создать не больше одного заказа (`orderId`).
coupons	Coupon[]	Купоны, применённые к корзине
discounts	Discount[]	Скидки, применённые к корзине
externalId	string	Переданный продавцом идентификатор корзины
items	CartItemWithoutFinalPrice[]
measurements	Measurements	Размеры и вес товара. Обязательно для товара типа `PHYSICAL`
total	CartTotal	Итоговая стоимость корзины, которая пойдет в оплату

PaymentMethod

Выбранный способ оплаты

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

Address

Адрес доставки доступен, если выбран метод COURIER

Name	Type	Description
addressLine	string	Полный адрес
building*	string
comment	string
country*	string
district	string
entrance	string
floor	string
intercom	string
locale	string
locality	string
location	Location
region	string
room	string
street	string
zip	string

ShippingMethod

Выбранный способ доставки

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

Coupon

Name	Type	Description
description	string	Описание. Например, "Скидка 3%"
status	string	Enum: `VALID`, `INVALID`, `EXPIRED`, `null`
value*	string	Код купона

Discount

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

CartItemWithoutFinalPrice

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

Measurements

Размеры и вес товара. Обязательно для товара типа PHYSICAL

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

CartTotal

Итоговая стоимость корзины, которая пойдет в оплату

Name	Type	Description
amount*	string<double>	Стоимость корзины с учетом всех скидок, и без учета доставки Example: `123.45`
label	string

Location

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

CourierOption

если methodType == COURIER

Name	Type	Description
allowedPaymentMethods	string[]	Индивидуальные методы оплаты для метода доставки. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в `availablePaymentMethods`. Если параметр не указан, то используются все методы оплаты, перечисленные в `availablePaymentMethods`. Enum: `CARD`, `SPLIT`, `CASH_ON_DELIVERY`, `CARD_ON_DELIVERY`
amount*	string<double>	Стоимость доставки Example: `123.45`
category*	string	Enum: `EXPRESS`, `TODAY`, `STANDARD`
courierOptionId*	string	id выбранного варианта доставки в системе продавца
customerChoice	FlexibleCustomerChoice	Выбранные пользователем дата и интервал. Только для `type: FLEXIBLE`
fromDate	string<date>	Ближайшая дата доставки для `type: PLAIN`. Начало интервала выбора даты доставки для `type: FLEXIBLE`
fromTime	string	Начало интервала времени доставки. Только для `type: PLAIN`
provider	string	Тип службы доставки. 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	ItemReceipt	Данные для формирования чека
timeIntervals	FlexibleTimeIntervals	Кодирует интервалы времени доставки, доступные для выбора. Только для `type: FLEXIBLE`
title*	string	Название способа доставки. Показывается пользователю в списке вариантов
toDate	string<date>	Самая поздняя дата доставки для `type: PLAIN`. Конец интервала выбора даты доставки для `type: FLEXIBLE`
toTime	string	Конец интервала времени доставки. Только для `type: PLAIN`
type	string	Тип опции. Для `FLEXIBLE` вариантов доставки пользователю дается возможность выбрать желаемые дату и интервал: дата доставки выбирается покупателем в отрезке `[fromDate, toDate]` чтобы предоставить пользователю выбор интервала в течении дня, заполните `timeIntervals` Для `PLAIN` вариантов такой выбор отсутствует. Enum: `PLAIN`, `FLEXIBLE` Default: `PLAIN`

PickupOption

если methodType == PICKUP

Name	Type	Description
address*	string	Адрес в виде строки
allowedPaymentMethods	string[]	Индивидуальные методы оплаты для выбранного способа самовывоза. Доступные методы оплаты заказа при выбранном способе самовывоза. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в `availablePaymentMethods`. Если параметр не указан, то используются все методы оплаты, перечисленные в `availablePaymentMethods`. Enum: `CARD`, `SPLIT`, `CASH_ON_DELIVERY`, `CARD_ON_DELIVERY`
amount	string<double>	Стоимость доставки в точку Example: `123.45`
description	string	Дополнительное описание
fromDate	string<date>	YYYY-MM-DD. Ближайшая возможная дата доставки
location*	Location
phones	string[]	Телефоны для связи
pickupPointId*	string	Уникальный id точки самовывоза в системе продавца
provider	string	Тип точки вывоза. Enum: `YANDEX_MARKET`, `BOXBERRY`, `CDEK`, `IN_STORE`, `RUSSIAN_POST`, `PICKPOINT`, `DPD`
receipt	ItemReceipt	Данные для формирования чека
schedule	PickupSchedule[]	График работы точки
storagePeriod	integer<int32>	Опционально. Срок хранения товара в точке самовывоза в днях
title*	string	Название точки самовывоза
toDate	string<date>	YYYY-MM-DD. Самая поздняя дата доставки

YandexDeliveryOption

если methodType == YANDEX_DELIVERY

Name	Type	Description
allowedPaymentMethods	string[]	Индивидуальные методы оплаты для метода доставки. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в `availablePaymentMethods`. Если параметр не указан, то используются все методы оплаты, перечисленные в `availablePaymentMethods`. Enum: `CARD`, `SPLIT`, `CASH_ON_DELIVERY`, `CARD_ON_DELIVERY`
amount*	string<double>	Стоимость доставки Example: `123.45`
category*	string	Enum: `EXPRESS`, `TODAY`, `STANDARD`
fromDatetime	string<date-time>
receipt	ItemReceipt	Данные для формирования чека
title*	string	Название способа доставки. Показывается пользователю в списке вариантов
toDatetime	string<date-time>
yandexDeliveryOptionId*	string	Id предложения Яндекс Доставки

ItemQuantity

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

Name	Type	Description
available	string<double>	Максимально доступное количество товара Example: `123.45`
count*	string<double>	Количество товара в заказе Example: `123.45`
label	string	Название единиц измерения, например "кг" или "шт"

ItemReceipt

Данные для формирования чека

Name	Type	Description
agent	Agent
excise	string<double>	Не должно содержать больше двух знаков после запятой. Например: 1.12, 5.1, 10, 11.00 . Example: `123.45`
markQuantity	MarkQuantity
measure	integer	Описание значений: Ссылка 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	integer	Описание значений: Ссылка Enum: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `null`
paymentSubjectType	integer	Описание значений: Ссылка 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	string<base64>	Код товара (base64 кодированный массив от 1 до 32 байт)
supplier	Supplier
tax*	integer	Описание значений: Ссылка Enum: `1`, `2`, `3`, `4`, `5`, `6`
title	string

FlexibleCustomerChoice

Выбранные пользователем дата и интервал. Только для type: FLEXIBLE

Name	Type	Description
date*	string<date>
time	TimeInterval

FlexibleTimeIntervals

Кодирует интервалы времени доставки, доступные для выбора. Только для type: FLEXIBLE

Name	Type	Description
grid	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"}]`
type*	string	Если указан тип `GRID`, то необходимо задать поле `grid`. Если указан тип `VALUES`, то необходимо задать поле `values` Enum: `GRID`, `VALUES`
values	TimeInterval[]	Задаёт список интервалов напрямую. Подходит для небольшого количества интервалов доставки. Рекомендуемое максимальная количество интервалов - 20

PickupSchedule

Name	Type	Description
fromTime*	string	HH:mm, "08:00"
label*	string	Например, "пн-пт"
toTime*	string	HH:mm, "20:00"

Agent

Name	Type	Description
agentType*	integer	Описание значений: Ссылка Enum: `1`, `2`, `3`, `4`, `5`, `6`, `7`
operation	string
paymentsOperator	PaymentsOperator
phones	string[]
transferOperator	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[]

Responses

200 OK

success

Body

application/json

{
    "data": {
        "availablePaymentMethods": [
            "CARD"
        ],
        "cart": {
            "coupons": [
                {
                    "description": "string",
                    "status": "VALID",
                    "value": "string"
                }
            ],
            "discounts": [
                {
                    "amount": "123.45",
                    "description": "string",
                    "discountId": "string"
                }
            ],
            "externalId": "string",
            "items": [
                {
                    "description": "string",
                    "discountedUnitPrice": "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"
            }
        },
        "currencyCode": "RUB",
        "enableCommentField": false,
        "enableCoupons": false,
        "metadata": "string",
        "orderAmount": "123.45",
        "requiredFields": {
            "billingContact": {
                "email": false
            },
            "shippingContact": {
                "email": false,
                "name": false,
                "phone": false
            }
        },
        "shipping": {
            "availableCourierOptions": [
                {
                    "allowedPaymentMethods": [
                        "CARD"
                    ],
                    "amount": "123.45",
                    "category": "EXPRESS",
                    "courierOptionId": "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"
                }
            ],
            "availableMethods": [
                "DIRECT"
            ],
            "courierOptionsError": "WRONG_ADDRESS",
            "yandexDelivery": {
                "warehouse": {
                    "address": {
                        "addressLine": "string",
                        "building": "string",
                        "comment": "string",
                        "country": "string",
                        "district": "string",
                        "entrance": "string",
                        "floor": "string",
                        "intercom": "string",
                        "locale": "string",
                        "locality": "string",
                        "location": {
                            "latitude": 0,
                            "longitude": 0
                        },
                        "region": "string",
                        "room": "string",
                        "street": "string",
                        "zip": "string"
                    },
                    "contact": {
                        "email": "string",
                        "firstName": "string",
                        "lastName": "string",
                        "phone": "string",
                        "phoneAdditionalCode": "string",
                        "secondName": "string"
                    },
                    "emergencyContact": {
                        "email": "string",
                        "firstName": "string",
                        "lastName": "string",
                        "phone": "string",
                        "phoneAdditionalCode": "string",
                        "secondName": "string"
                    },
                    "schedule": {
                        "custom": {
                            "end": "string",
                            "start": "string"
                        },
                        "tzoffset": 0,
                        "weekly": {
                            "fri": {
                                "end": "string",
                                "start": "string"
                            },
                            "mon": {
                                "end": "string",
                                "start": "string"
                            },
                            "sat": {
                                "end": "string",
                                "start": "string"
                            },
                            "sun": {
                                "end": "string",
                                "start": "string"
                            },
                            "thu": {
                                "end": "string",
                                "start": "string"
                            },
                            "tue": {
                                "end": "string",
                                "start": "string"
                            },
                            "wed": {
                                "end": "string",
                                "start": "string"
                            }
                        }
                    }
                }
            }
        }
    },
    "status": "string"
}

Name	Type	Description
data*	MerchantRenderOrderResponseData
status*	string

MerchantRenderOrderResponseData

Name	Type	Description
availablePaymentMethods	string[]	Доступные методы оплаты на платежной форме Яндекс Пэй. Нужно указать все возможные методы, которые может выбрать пользователь - при оплате онлайн и доставке. Если вы интегрируете оплату только одним методом, например, Сплит — указывается один метод `["SPLIT"]`. Enum: `CARD`, `SPLIT`, `CASH_ON_DELIVERY`, `CARD_ON_DELIVERY`
cart*	RenderedCart	Корзина
currencyCode*	string	Трехбуквенный код валюты заказа (ISO 4217) Enum: `RUB`
enableCommentField	boolean
enableCoupons	boolean
metadata	string	Произвольные данные, переданные при инициализации кнопки
orderAmount	string<double>	Полная стоимость заказа к оплате с учётом возвратов, доставки, скидок и промокодов Example: `123.45`
requiredFields	RequiredFields	Данные пользователя, необходимые для оформления заказа
shipping	ShippingOptions

RenderedCart

Корзина

Name	Type	Description
coupons	Coupon[]	Купоны, применённые к корзине
discounts	Discount[]	Скидки, применённые к корзине
externalId	string	Переданный продавцом идентификатор корзины
items*	RenderedCartItem[]
measurements	Measurements	Размеры и вес товара. Обязательно для товара типа `PHYSICAL`
total*	CartTotal	Итоговая стоимость корзины, которая пойдет в оплату

RequiredFields

Данные пользователя, необходимые для оформления заказа

Name	Type	Description
billingContact	BillingContactFields
shippingContact	ContactFields

ShippingOptions

Name	Type	Description
availableCourierOptions	CourierOption1[]	Доступные варианты доставки (при наличии адреса в запросе)
availableMethods*	string[]	Enum: `DIRECT`, `PICKUP`, `COURIER`, `YANDEX_DELIVERY`
courierOptionsError	string	Ошибка при определении доставки. При указании этого параметра, в интерфейсе пользователя будет отображаться описание ошибки. Enum: `WRONG_ADDRESS`, `DELIVERY_NOT_AVAILABLE_FOR_ADDRESS`, `null`
yandexDelivery	YandexDeliveryShippingParams

RenderedCartItem

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

BillingContactFields

Name	Type	Description
email	boolean

ContactFields

Name	Type	Description
email	boolean
name	boolean
phone	boolean

CourierOption1

Name	Type	Description
allowedPaymentMethods	string[]	Индивидуальные методы оплаты для метода доставки. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в `availablePaymentMethods`. Если параметр не указан, то используются все методы оплаты, перечисленные в `availablePaymentMethods`. Enum: `CARD`, `SPLIT`, `CASH_ON_DELIVERY`, `CARD_ON_DELIVERY`
amount*	string<double>	Стоимость доставки Example: `123.45`
category*	string	Enum: `EXPRESS`, `TODAY`, `STANDARD`
courierOptionId*	string	id выбранного варианта доставки в системе продавца
fromDate	string<date>	Ближайшая дата доставки для `type: PLAIN`. Начало интервала выбора даты доставки для `type: FLEXIBLE`
fromTime	string	Начало интервала времени доставки. Только для `type: PLAIN`
provider	string	Тип службы доставки. 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	ItemReceipt	Данные для формирования чека
timeIntervals	FlexibleTimeIntervals	Кодирует интервалы времени доставки, доступные для выбора. Только для `type: FLEXIBLE`
title*	string	Название способа доставки. Показывается пользователю в списке вариантов
toDate	string<date>	Самая поздняя дата доставки для `type: PLAIN`. Конец интервала выбора даты доставки для `type: FLEXIBLE`
toTime	string	Конец интервала времени доставки. Только для `type: PLAIN`
type	string	Тип опции. Для `FLEXIBLE` вариантов доставки пользователю дается возможность выбрать желаемые дату и интервал: дата доставки выбирается покупателем в отрезке `[fromDate, toDate]` чтобы предоставить пользователю выбор интервала в течении дня, заполните `timeIntervals` Для `PLAIN` вариантов такой выбор отсутствует. Enum: `PLAIN`, `FLEXIBLE` Default: `PLAIN`

YandexDeliveryShippingParams

Name	Type	Description
warehouse	ShippingWarehouse

ShippingWarehouse

Name	Type	Description
address*	Address	Адрес доставки доступен, если выбран метод COURIER
contact*	Contact
emergencyContact*	Contact
schedule	Schedule	Расписание работы

Contact

Name	Type	Description
email	string
firstName	string
lastName	string
phone	string
phoneAdditionalCode	string
secondName	string

Schedule

Расписание работы

Name	Type	Description
custom	TimeInterval1	Переопределённое расписание для конкретных дат. Ключи - даты в формате "YYYY-MM-DD", значения - объекты {"start": string, "end": string} или null для указания выходных
tzoffset*	integer<int32>	Смещение часового пояса относительно UTC в минутах. Например, 180 для Москвы (UTC+3)
weekly*	WeeklySchedule	Еженедельное расписание работы

TimeInterval1

Переопределённое расписание для конкретных дат. Ключи - даты в формате "YYYY-MM-DD", значения - объекты {"start": string, "end": string} или null для указания выходных

Name	Type	Description
end*	string	Время конца интервала
start*	string	Время начала интервала

WeeklySchedule

Еженедельное расписание работы

Name	Type	Description
fri	TimeInterval	Пятница
mon	TimeInterval	Понедельник
sat	TimeInterval	Суббота
sun	TimeInterval	Воскресенье
thu	TimeInterval	Четверг
tue	TimeInterval	Вторник
wed	TimeInterval	Среда

400 Bad Request

bad request

Body

application/json

{
    "reason": "string",
    "reasonCode": "FORBIDDEN",
    "status": "fail"
}

Name	Type	Description
reason	string
reasonCode*	string	Enum: `FORBIDDEN`, `ITEM_NOT_FOUND`, `ORDER_NOT_FOUND`, `ORDER_AMOUNT_MISMATCH`, `ORDER_DETAILS_MISMATCH`, `OUT_OF_INVENTORY`, `PICKUP_POINT_NOT_FOUND`, `SHIPPING_DETAILS_MISMATCH`, `OTHER`, `UNAUTHORIZED`, `TOKEN_EXPIRED`, `CONFLICT`
status	string	Default: `fail`

/v1/order/render

RequestRequest

BodyBody

CartWithoutFinalPriceCartWithoutFinalPrice

PaymentMethodPaymentMethod

AddressAddress

ShippingMethodShippingMethod

CouponCoupon

DiscountDiscount

CartItemWithoutFinalPriceCartItemWithoutFinalPrice

MeasurementsMeasurements

CartTotalCartTotal

LocationLocation

CourierOptionCourierOption

PickupOptionPickupOption

YandexDeliveryOptionYandexDeliveryOption

ItemQuantityItemQuantity

ItemReceiptItemReceipt

FlexibleCustomerChoiceFlexibleCustomerChoice

FlexibleTimeIntervalsFlexibleTimeIntervals

PickupSchedulePickupSchedule

AgentAgent

MarkQuantityMarkQuantity

SupplierSupplier

TimeIntervalTimeInterval

FlexibleTimeIntervalsGridDescriptorFlexibleTimeIntervalsGridDescriptor

PaymentsOperatorPaymentsOperator

TransferOperatorTransferOperator

ResponsesResponses

200 OK200 OK

BodyBody

MerchantRenderOrderResponseDataMerchantRenderOrderResponseData

RenderedCartRenderedCart

RequiredFieldsRequiredFields

ShippingOptionsShippingOptions

RenderedCartItemRenderedCartItem

BillingContactFieldsBillingContactFields

ContactFieldsContactFields

CourierOption1CourierOption1

YandexDeliveryShippingParamsYandexDeliveryShippingParams

ShippingWarehouseShippingWarehouse

ContactContact

ScheduleSchedule

TimeInterval1TimeInterval1

WeeklyScheduleWeeklySchedule

400 Bad Request400 Bad Request

BodyBody

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

Request

Body

CartWithoutFinalPrice

PaymentMethod

Address

ShippingMethod

Coupon

Discount

CartItemWithoutFinalPrice

Measurements

CartTotal

Location

CourierOption

PickupOption

YandexDeliveryOption

ItemQuantity

ItemReceipt

FlexibleCustomerChoice

FlexibleTimeIntervals

PickupSchedule

Agent

MarkQuantity

Supplier

TimeInterval

FlexibleTimeIntervalsGridDescriptor

PaymentsOperator

TransferOperator

Responses

200 OK

Body

MerchantRenderOrderResponseData

RenderedCart

RequiredFields

ShippingOptions

RenderedCartItem

BillingContactFields

ContactFields

CourierOption1

YandexDeliveryShippingParams

ShippingWarehouse

Contact

Schedule

TimeInterval1

WeeklySchedule

400 Bad Request

Body