/v1/orders/

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

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

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

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": "string",
                        "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"
                        },
                        "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"
                        },
                        "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"
                }
            },
            "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: 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

Дополнительные параметры операции. Список полей отличается в зависимости от типа операции.

При возврате сохраняются motive, branchId и managerId, которые вы указали в запросе /refund:

{
  "params": {
    "motive": "Товар не устроил", // причина возврата
    "branch_id": "42", // идентификатор точки продаж
    "manager_id": "12345" // идентификатор менеджера
  }
}

При отмене сохраняется reason, который вы указали в запросе /cancel:

{
  "params": {
    "cancel_reason": "Покупатель отказался" // причина отмены
  }
}

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

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

Уникальный идентификатор заказа на стороне продавца.

Используется:

  • как ключ идемпотентности;
  • для дальнейшего взаимодействия по заказу и платежу;
  • в сверках.

Max length: 2048

paymentMethod

Type: PaymentMethod

paymentStatus

Type: string

Статус платежа в заказе. Подробнее читайте в разделе Статусы платежей.

Не может быть null.

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

shippingMethod

Type: ShippingMethod

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

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: CARD, SPLIT, SBP, SPLIT_SBP, CASH_ON_DELIVERY, CARD_ON_DELIVERY, UNIQR_REUSABLE, UNIQR_ONETIME

cardLast4

Type: string

Max length: 2048

cardNetwork

Type: string

Платежная система

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

если methodType == COURIER

pickupOption

Type: PickupOption

если methodType == PICKUP

yandexDeliveryOption

Type: YandexDeliveryOption

если methodType == YANDEX_DELIVERY

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

receipt

⦸

Type: ItemReceipt

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

Deprecated

В актуальных интеграциях передавать данные для чека не требуется. Чек формируется на вашей стороне. Подробнее см. в разделе Фискализация.

skuId

Type: string

Уникальный id, который описывает единицу ассортимента. Необходим для применения индивидуального тарифа.

Max length: 2048

subtotal

Type: string<double>

Суммарная цена за позицию без учета скидок

Example: 123.45

title

Type: string

Наименование товара

Max length: 2048

total

Type: string<double>

Итоговая цена позиции с учетом примененных скидок.

Важно

Убедитесь, что цена за единицу товара (total / quantity.count) имеет максимум 2 знака в дробной части. Иначе вернется ошибка ORDER_CART_DATA_ERROR.

Чтобы избежать ошибок, вынесите товары в отдельные позиции с разными productId.

Пример

Правильно:

{
  "productId": "xxx-123",
  "quantity": {
    "count": "2"
  },
  "title": "Мармелад",
  "total": "100.50"
}

Цена за единицу 100.50 / 2 = 50.25 c двумя знаками в дробной части.

Неправильно:

{
  "productId": "xxx-123",
  "quantity": {
    "count": "2"
  },
  "title": "Мармелад",
  "total": "100.25"
}

Цена за единицу 100.25 / 2 = 50.125 c тремя знаками в дробной части.

В таком случае разбейте на две позиции:

[
  {
    "productId": "xxx-123-1",
    "quantity": {
      "count": "1"
    },
    "title": "Мармелад",
    "total": "50.25"
  },
  {
    "productId": "xxx-123-2",
    "quantity": {
      "count": "1"
    },
    "title": "Мармелад со скидкой",
    "total": "50"
  }
]

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

Описание. Например, "Скидка 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

CourierOption

Name

Description

amount*

Type: string<double>

Стоимость доставки

Example: 123.45

category*

Type: string

Enum: EXPRESS, TODAY, STANDARD

courierOptionId*

Type: string

id выбранного варианта доставки в системе продавца

Max length: 2048

title*

Type: string

Название способа доставки. Показывается пользователю в списке вариантов

Max length: 2048

allowedPaymentMethods

Type: string[]

Индивидуальные методы оплаты для метода доставки. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в availablePaymentMethods. Если параметр не указан, то используются все методы оплаты, перечисленные в availablePaymentMethods.

Enum: CARD, SPLIT, CASH_ON_DELIVERY, CARD_ON_DELIVERY, UNIQR_REUSABLE, UNIQR_ONETIME

customerChoice

Type: FlexibleCustomerChoice

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

fromDate

Type: string<date>

Ближайшая дата доставки для type: PLAIN. Начало интервала выбора даты доставки для type: FLEXIBLE

fromTime

Type: string

Начало интервала времени доставки. Только для type: PLAIN

provider

Type: 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

⦸

Type: ItemReceipt

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

Deprecated

В актуальных интеграциях передавать данные для чека не требуется. Чек формируется на вашей стороне. Подробнее см. в разделе Фискализация.

timeIntervals

Type: FlexibleTimeIntervals

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

toDate

Type: string<date>

Самая поздняя дата доставки для type: PLAIN. Конец интервала выбора даты доставки для type: FLEXIBLE

toTime

Type: string

Конец интервала времени доставки. Только для type: PLAIN

type

Type: string

Тип опции. Для FLEXIBLE вариантов доставки пользователю дается возможность выбрать желаемые дату и интервал:

  • дата доставки выбирается покупателем в отрезке [fromDate, toDate]
  • чтобы предоставить пользователю выбор интервала в течении дня, заполните timeIntervals Для PLAIN вариантов такой выбор отсутствует.

Default: PLAIN

Enum: PLAIN, FLEXIBLE

PickupOption

Name

Description

address*

Type: string

Адрес в виде строки

Max length: 2048

location*

Type: Location

pickupPointId*

Type: string

Уникальный id точки самовывоза в системе продавца

Max length: 2048

title*

Type: string

Название точки самовывоза

Max length: 2048

allowedPaymentMethods

Type: string[]

Индивидуальные методы оплаты для выбранного способа самовывоза. Доступные методы оплаты заказа при выбранном способе самовывоза. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в availablePaymentMethods. Если параметр не указан, то используются все методы оплаты, перечисленные в availablePaymentMethods.

Enum: CARD, SPLIT, CASH_ON_DELIVERY, CARD_ON_DELIVERY, UNIQR_REUSABLE, UNIQR_ONETIME

amount

Type: string<double>

Стоимость доставки в точку

Example: 123.45

description

Type: string

Дополнительное описание

Max length: 2048

fromDate

Type: string<date>

YYYY-MM-DD. Ближайшая возможная дата доставки

phones

Type: string[]

Телефоны для связи

Max length: 2048

provider

Type: string

Тип точки вывоза.

Enum: YANDEX_MARKET, BOXBERRY, CDEK, IN_STORE, RUSSIAN_POST, PICKPOINT, DPD

receipt

⦸

Type: ItemReceipt

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

Deprecated

В актуальных интеграциях передавать данные для чека не требуется. Чек формируется на вашей стороне. Подробнее см. в разделе Фискализация.

schedule

Type: PickupSchedule[]

График работы точки

storagePeriod

Type: integer<int32>

Опционально. Срок хранения товара в точке самовывоза в днях

toDate

Type: string<date>

YYYY-MM-DD. Самая поздняя дата доставки

YandexDeliveryOption

Name

Description

amount*

Type: string<double>

Стоимость доставки

Example: 123.45

category*

Type: string

Enum: EXPRESS, TODAY, STANDARD

title*

Type: string

Название способа доставки. Показывается пользователю в списке вариантов

Max length: 2048

yandexDeliveryOptionId*

Type: string

Id предложения Яндекс Доставки

Max length: 2048

allowedPaymentMethods

Type: string[]

Индивидуальные методы оплаты для метода доставки. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в availablePaymentMethods. Если параметр не указан, то используются все методы оплаты, перечисленные в availablePaymentMethods.

Enum: CARD, SPLIT, CASH_ON_DELIVERY, CARD_ON_DELIVERY, UNIQR_REUSABLE, UNIQR_ONETIME

fromDatetime

Type: string<date-time>

receipt

⦸

Type: ItemReceipt

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

Deprecated

В актуальных интеграциях передавать данные для чека не требуется. Чек формируется на вашей стороне. Подробнее см. в разделе Фискализация.

toDatetime

Type: string<date-time>

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

ItemReceipt

Deprecated

В актуальных интеграциях передавать данные для чека не требуется. Чек формируется на вашей стороне. Подробнее см. в разделе Фискализация.

Name

Description

tax*

Type: integer

Описание значений: Ссылка

Enum: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

agent

⦸

Type: Agent

excise

Type: string<double>

Не должно содержать больше двух знаков после запятой. Например: 1.12, 5.1, 10, 11.00 .

Example: 123.45

markQuantity

⦸

Type: MarkQuantity

measure

Type: 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

Type: integer

Описание значений: Ссылка

Enum: 1, 2, 3, 4, 5, 6, 7, null

paymentSubjectType

Type: 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

Type: string<base64>

Код товара (base64 кодированный массив от 1 до 32 байт)

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

Если указан тип GRID, то необходимо задать поле grid. Если указан тип VALUES, то необходимо задать поле values

Enum: GRID, VALUES

grid

Type: 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"}]

values

Type: TimeInterval[]

Задаёт список интервалов напрямую. Подходит для небольшого количества интервалов доставки. Рекомендуемое максимальная количество интервалов - 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

Например, "пн-пт"

Max length: 2048

toTime*

Type: string

HH:mm, "20:00"

Agent

Name

Description

agentType*

Type: integer

Признак агента по предмету расчёта. См. значения

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

Время конца интервала

start*

Type: string

Время начала интервала

FlexibleTimeIntervalsGridDescriptor

Name

Description

duration*

Type: string

Продолжительность каждого интервала

end*

Type: string

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

start*

Type: string

Время начала самого первого интервала

step*

Type: string

Разница во времени между началами двух соседних интервалов

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

No longer supported, please use an alternative and newer version.

Предыдущая
/v1/orders
Следующая
/v1/orders/{order_id}/cancel