Информация о заказах в кабинете

Info

Console

Метод доступен для моделей: FBY, FBS, Экспресс и DBS.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

inventory-and-order-processing — Обработка заказов и учёт товаров
inventory-and-order-processing:read-only — Просмотр информации о заказах
finance-and-accounting — Просмотр финансовой информации и отчётности
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всех данных

Возвращает информацию о заказах в кабинете. Запрос можно использовать для отслеживания заказов и их статусов.

Доступна фильтрация по параметрам:

дата оформления заказа;
дата и время обновления заказа;
дата отгрузки;
статусы заказов (statuses);
этапы обработки или причины отмены (substatuses);
идентификаторы кампаний;
идентификаторы заказов;
внешние идентификаторы заказов;
тип заказа (настоящий или тестовый);
тип покупателя;
модели размещения;
наличие запросов от покупателей на отмену заказа.

Максимальный диапазон дат за один запрос — 30 дней (передается в параметрах fromDate и toDate). Если их не передать, возвращается информация за последние 30 дней.

Результаты возвращаются постранично. Для навигации используйте параметры page_token и limit.

Ограничение для параметра limit

Не передавайте значение больше 50.

⚙️ Лимит: 100 000 запросов в час

Request

POST

https://api.partner.market.yandex.ru/v1/businesses/{businessId}/orders

Path parameters

Name

Description

businessId*

Type: integer<int64>

Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

Количество значений на одной странице.

Min value: 1
Example: 20

page_token

Type: string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуем передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры page и pageSize, они игнорируются.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json

{
    "orderIds": [
        0
    ],
    "externalOrderIds": [
        "string"
    ],
    "programTypes": [
        "FBY"
    ],
    "campaignIds": [
        0
    ],
    "statuses": [
        "PLACING"
    ],
    "substatuses": [
        "RESERVATION_EXPIRED"
    ],
    "dates": {
        "creationDateFrom": "string",
        "creationDateTo": "string",
        "shipmentDateFrom": "string",
        "shipmentDateTo": "string",
        "updateDateFrom": "2022-12-29T18:02:01Z",
        "updateDateTo": "2022-12-29T18:02:01Z"
    },
    "fake": false,
    "waitingForCancellationApprove": false
}

Name	Description
campaignIds	Type: integer[] Идентификаторы кампаний. Min items: `1` Max items: `50` Unique items
dates	Type: OrderDatesFilterDTO Даты заказов.
externalOrderIds	Type: string[] Внешние идентификаторы заказов. Внешний идентификатор заказа, который вы передали в POST v2/campaigns/{campaignId}/orders/{orderId}/external-id. Min length: `1` Min items: `1` Max items: `50` Unique items
fake	Type: boolean Тип заказа: `false` — настоящий заказ покупателя. `true` — тестовый заказ Маркета.
orderIds	Type: integer[] Идентификаторы заказов. Min items: `1` Max items: `50` Unique items
programTypes	Type: SellingProgramType[] Модели работы магазина на Маркете. Модель работы: `FBY` — FBY. `FBS` — FBS. `DBS` — DBS. `EXPRESS` — Экспресс. Enum: `FBY`, `FBS`, `DBS`, `EXPRESS`, `LAAS` Min items: `1` Unique items
statuses	Type: OrderStatusType[] Статусы заказов. Статус заказа: `PLACING` — оформляется, подготовка к резервированию. `RESERVED` — зарезервирован, но недооформлен. `UNPAID` — оформлен, но еще не оплачен (если выбрана оплата при оформлении). `PROCESSING` — находится в обработке. `DELIVERY` — передан в службу доставки. `PICKUP` — доставлен в пункт выдачи. `DELIVERED` — получен покупателем. `CANCELLED` — отменен. `PENDING` — ожидает обработки со стороны продавца. `PARTIALLY_RETURNED` — возвращен частично. `RETURNED` — возвращен полностью. `UNKNOWN` — неизвестный статус. Также могут возвращаться другие значения. Обрабатывать их не нужно. Enum: `PLACING`, `RESERVED`, `UNPAID`, `PROCESSING`, `DELIVERY`, `PICKUP`, `DELIVERED`, `CANCELLED`, `PENDING`, `PARTIALLY_RETURNED`, `RETURNED`, `UNKNOWN` Min items: `1` Unique items
substatuses	Type: OrderSubstatusType[] Этапы обработки или причины отмены заказов. Этап обработки заказа (статус `PROCESSING`) или причина отмены заказа (статус `CANCELLED`). Значения для заказа в статусе `PROCESSING`: `STARTED` — заказ подтвержден, его можно начать обрабатывать. `READY_TO_SHIP` — заказ собран и готов к отправке. Значения для заказа в статусе `CANCELLED`: `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: не менее 3 звонков с 8 до 21 в часовом поясе покупателя; перерыв между первым и третьим звонком не менее 90 минут; соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. `USER_REFUSED_PRODUCT` — покупателю не подошел товар. `SHOP_FAILED` — магазин не может выполнить заказ. `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. `PROCESSING_EXPIRED` — значение более не используется. `PICKUP_EXPIRED` — закончился срок хранения заказа в пункт выдачи. `TOO_MANY_DELIVERY_DATE_CHANGES` — заказ переносили слишком много раз. `TOO_LONG_DELIVERY` — заказ доставляется слишком долго. `INCORRECT_PERSONAL_DATA` — для заказа из-за рубежа указаны неправильные данные получателя, заказ не пройдет проверку на таможне. `TECHNICAL_ERROR` — техническая ошибка на стороне Маркета. Обратитесь в поддержку. Также могут возвращаться другие значения. Обрабатывать их не нужно. Enum: `RESERVATION_EXPIRED`, `USER_NOT_PAID`, `USER_UNREACHABLE`, `USER_CHANGED_MIND`, `USER_REFUSED_DELIVERY`, `USER_REFUSED_PRODUCT`, `SHOP_FAILED`, `USER_REFUSED_QUALITY`, `REPLACING_ORDER`, `PROCESSING_EXPIRED`, `PENDING_EXPIRED`, `SHOP_PENDING_CANCELLED`, `PENDING_CANCELLED`, `USER_FRAUD`, `RESERVATION_FAILED`, `USER_PLACED_OTHER_ORDER`, `USER_BOUGHT_CHEAPER`, `MISSING_ITEM`, `BROKEN_ITEM`, `WRONG_ITEM`, `PICKUP_EXPIRED`, `DELIVERY_PROBLEMS`, `LATE_CONTACT`, `CUSTOM`, `DELIVERY_SERVICE_FAILED`, `WAREHOUSE_FAILED_TO_SHIP`, `DELIVERY_SERVICE_UNDELIVERED`, `PREORDER`, `AWAIT_CONFIRMATION`, `STARTED`, `PACKAGING`, `READY_TO_SHIP`, `SHIPPED`, `ASYNC_PROCESSING`, `WAITING_USER_INPUT`, `WAITING_BANK_DECISION`, `BANK_REJECT_CREDIT_OFFER`, `CUSTOMER_REJECT_CREDIT_OFFER`, `CREDIT_OFFER_FAILED`, `AWAIT_DELIVERY_DATES_CONFIRMATION`, `SERVICE_FAULT`, `DELIVERY_SERVICE_RECEIVED`, `USER_RECEIVED`, `WAITING_FOR_STOCKS`, `AS_PART_OF_MULTI_ORDER`, `READY_FOR_LAST_MILE`, `LAST_MILE_STARTED`, `ANTIFRAUD`, `DELIVERY_USER_NOT_RECEIVED`, `DELIVERY_SERVICE_DELIVERED`, `DELIVERED_USER_NOT_RECEIVED`, `USER_WANTED_ANOTHER_PAYMENT_METHOD`, `USER_RECEIVED_TECHNICAL_ERROR`, `USER_FORGOT_TO_USE_BONUS`, `DELIVERY_SERVICE_NOT_RECEIVED`, `DELIVERY_SERVICE_LOST`, `SHIPPED_TO_WRONG_DELIVERY_SERVICE`, `DELIVERED_USER_RECEIVED`, `WAITING_TINKOFF_DECISION`, `COURIER_SEARCH`, `COURIER_FOUND`, `COURIER_IN_TRANSIT_TO_SENDER`, `COURIER_ARRIVED_TO_SENDER`, `COURIER_RECEIVED`, `COURIER_NOT_FOUND`, `COURIER_NOT_DELIVER_ORDER`, `COURIER_RETURNS_ORDER`, `COURIER_RETURNED_ORDER`, `WAITING_USER_DELIVERY_INPUT`, `PICKUP_SERVICE_RECEIVED`, `PICKUP_USER_RECEIVED`, `CANCELLED_COURIER_NOT_FOUND`, `COURIER_NOT_COME_FOR_ORDER`, `DELIVERY_NOT_MANAGED_REGION`, `INCOMPLETE_CONTACT_INFORMATION`, `INCOMPLETE_MULTI_ORDER`, `INAPPROPRIATE_WEIGHT_SIZE`, `TECHNICAL_ERROR`, `SORTING_CENTER_LOST`, `COURIER_SEARCH_NOT_STARTED`, `LOST`, `AWAIT_PAYMENT`, `AWAIT_LAVKA_RESERVATION`, `USER_WANTS_TO_CHANGE_ADDRESS`, `FULL_NOT_RANSOM`, `PRESCRIPTION_MISMATCH`, `DROPOFF_LOST`, `DROPOFF_CLOSED`, `DELIVERY_TO_STORE_STARTED`, `USER_WANTS_TO_CHANGE_DELIVERY_DATE`, `WRONG_ITEM_DELIVERED`, `DAMAGED_BOX`, `AWAIT_DELIVERY_DATES`, `LAST_MILE_COURIER_SEARCH`, `PICKUP_POINT_CLOSED`, `LEGAL_INFO_CHANGED`, `USER_HAS_NO_TIME_TO_PICKUP_ORDER`, `DELIVERY_CUSTOMS_ARRIVED`, `DELIVERY_CUSTOMS_CLEARED`, `FIRST_MILE_DELIVERY_SERVICE_RECEIVED`, `AWAIT_AUTO_DELIVERY_DATES`, `AWAIT_USER_PERSONAL_DATA`, `NO_PERSONAL_DATA_EXPIRED`, `CUSTOMS_PROBLEMS`, `AWAIT_CASHIER`, `WAITING_POSTPAID_BUDGET_RESERVATION`, `AWAIT_SERVICEABLE_CONFIRMATION`, `POSTPAID_BUDGET_RESERVATION_FAILED`, `AWAIT_CUSTOM_PRICE_CONFIRMATION`, `READY_FOR_PICKUP`, `TOO_MANY_DELIVERY_DATE_CHANGES`, `TOO_LONG_DELIVERY`, `DEFERRED_PAYMENT`, `POSTPAID_FAILED`, `INCORRECT_PERSONAL_DATA`, `UNKNOWN` Min items: `1` Unique items
waitingForCancellationApprove	Type: boolean Только для модели DBS Фильтр для получения заказов, по которым есть запросы на отмену. При значении `true` возвращаются только те заказы, которые находятся в статусе `DELIVERY` или `PICKUP`, и пользователи решили их отменить.

OrderDatesFilterDTO

Фильтр по датам заказов.

Name	Description
creationDateFrom	Type: string<date> Начальная дата оформления заказа (ГГГГ-ММ-ДД).
creationDateTo	Type: string<date> Конечная дата оформления заказа (ГГГГ-ММ-ДД).
shipmentDateFrom	Type: string<date> Начальная дата отгрузки (ГГГГ-ММ-ДД).
shipmentDateTo	Type: string<date> Конечная дата отгрузки (ГГГГ-ММ-ДД).
updateDateFrom	Type: string<date-time> Начальная дата обновления заказа (ISO 8601).
updateDateTo	Type: string<date-time> Конечная дата обновления заказа (ISO 8601).

SellingProgramType

Модель работы:

FBY — FBY.
FBS — FBS.
DBS — DBS.
EXPRESS — Экспресс.

Type	Description
SellingProgramType	Enum: `FBY`, `FBS`, `DBS`, `EXPRESS`, `LAAS`

OrderStatusType

Статус заказа:

PLACING — оформляется, подготовка к резервированию.
RESERVED — зарезервирован, но недооформлен.
UNPAID — оформлен, но еще не оплачен (если выбрана оплата при оформлении).
PROCESSING — находится в обработке.
DELIVERY — передан в службу доставки.
PICKUP — доставлен в пункт выдачи.
DELIVERED — получен покупателем.
CANCELLED — отменен.
PENDING — ожидает обработки со стороны продавца.
PARTIALLY_RETURNED — возвращен частично.
RETURNED — возвращен полностью.
UNKNOWN — неизвестный статус.

Также могут возвращаться другие значения. Обрабатывать их не нужно.

Type	Description
OrderStatusType	Enum: `PLACING`, `RESERVED`, `UNPAID`, `PROCESSING`, `DELIVERY`, `PICKUP`, `DELIVERED`, `CANCELLED`, `PENDING`, `PARTIALLY_RETURNED`, `RETURNED`, `UNKNOWN`

OrderSubstatusType

Этап обработки заказа (статус PROCESSING) или причина отмены заказа (статус CANCELLED).

Значения для заказа в статусе PROCESSING:
- STARTED — заказ подтвержден, его можно начать обрабатывать.
- READY_TO_SHIP — заказ собран и готов к отправке.
Значения для заказа в статусе CANCELLED:
- RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.
- USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.
- USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:
  - не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
  - перерыв между первым и третьим звонком не менее 90 минут;
  - соединение не короче 5 секунд.
  Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.
- USER_CHANGED_MIND — покупатель отменил заказ по личным причинам.
- USER_REFUSED_DELIVERY — покупателя не устроили условия доставки.
- USER_REFUSED_PRODUCT — покупателю не подошел товар.
- SHOP_FAILED — магазин не может выполнить заказ.
- USER_REFUSED_QUALITY — покупателя не устроило качество товара.
- REPLACING_ORDER — покупатель решил заменить товар другим по собственной инициативе.
- PROCESSING_EXPIRED — значение более не используется.
- PICKUP_EXPIRED — закончился срок хранения заказа в пункт выдачи.
- TOO_MANY_DELIVERY_DATE_CHANGES — заказ переносили слишком много раз.
- TOO_LONG_DELIVERY — заказ доставляется слишком долго.
- INCORRECT_PERSONAL_DATA — для заказа из-за рубежа указаны неправильные данные получателя, заказ не пройдет проверку на таможне.
TECHNICAL_ERROR — техническая ошибка на стороне Маркета. Обратитесь в поддержку.

Также могут возвращаться другие значения. Обрабатывать их не нужно.

Type

Description

OrderSubstatusType

Enum: RESERVATION_EXPIRED, USER_NOT_PAID, USER_UNREACHABLE, USER_CHANGED_MIND, USER_REFUSED_DELIVERY, USER_REFUSED_PRODUCT, SHOP_FAILED, USER_REFUSED_QUALITY, REPLACING_ORDER, PROCESSING_EXPIRED, PENDING_EXPIRED, SHOP_PENDING_CANCELLED, PENDING_CANCELLED, USER_FRAUD, RESERVATION_FAILED, USER_PLACED_OTHER_ORDER, USER_BOUGHT_CHEAPER, MISSING_ITEM, BROKEN_ITEM, WRONG_ITEM, PICKUP_EXPIRED, DELIVERY_PROBLEMS, LATE_CONTACT, CUSTOM, DELIVERY_SERVICE_FAILED, WAREHOUSE_FAILED_TO_SHIP, DELIVERY_SERVICE_UNDELIVERED, PREORDER, AWAIT_CONFIRMATION, STARTED, PACKAGING, READY_TO_SHIP, SHIPPED, ASYNC_PROCESSING, WAITING_USER_INPUT, WAITING_BANK_DECISION, BANK_REJECT_CREDIT_OFFER, CUSTOMER_REJECT_CREDIT_OFFER, CREDIT_OFFER_FAILED, AWAIT_DELIVERY_DATES_CONFIRMATION, SERVICE_FAULT, DELIVERY_SERVICE_RECEIVED, USER_RECEIVED, WAITING_FOR_STOCKS, AS_PART_OF_MULTI_ORDER, READY_FOR_LAST_MILE, LAST_MILE_STARTED, ANTIFRAUD, DELIVERY_USER_NOT_RECEIVED, DELIVERY_SERVICE_DELIVERED, DELIVERED_USER_NOT_RECEIVED, USER_WANTED_ANOTHER_PAYMENT_METHOD, USER_RECEIVED_TECHNICAL_ERROR, USER_FORGOT_TO_USE_BONUS, DELIVERY_SERVICE_NOT_RECEIVED, DELIVERY_SERVICE_LOST, SHIPPED_TO_WRONG_DELIVERY_SERVICE, DELIVERED_USER_RECEIVED, WAITING_TINKOFF_DECISION, COURIER_SEARCH, COURIER_FOUND, COURIER_IN_TRANSIT_TO_SENDER, COURIER_ARRIVED_TO_SENDER, COURIER_RECEIVED, COURIER_NOT_FOUND, COURIER_NOT_DELIVER_ORDER, COURIER_RETURNS_ORDER, COURIER_RETURNED_ORDER, WAITING_USER_DELIVERY_INPUT, PICKUP_SERVICE_RECEIVED, PICKUP_USER_RECEIVED, CANCELLED_COURIER_NOT_FOUND, COURIER_NOT_COME_FOR_ORDER, DELIVERY_NOT_MANAGED_REGION, INCOMPLETE_CONTACT_INFORMATION, INCOMPLETE_MULTI_ORDER, INAPPROPRIATE_WEIGHT_SIZE, TECHNICAL_ERROR, SORTING_CENTER_LOST, COURIER_SEARCH_NOT_STARTED, LOST, AWAIT_PAYMENT, AWAIT_LAVKA_RESERVATION, USER_WANTS_TO_CHANGE_ADDRESS, FULL_NOT_RANSOM, PRESCRIPTION_MISMATCH, DROPOFF_LOST, DROPOFF_CLOSED, DELIVERY_TO_STORE_STARTED, USER_WANTS_TO_CHANGE_DELIVERY_DATE, WRONG_ITEM_DELIVERED, DAMAGED_BOX, AWAIT_DELIVERY_DATES, LAST_MILE_COURIER_SEARCH, PICKUP_POINT_CLOSED, LEGAL_INFO_CHANGED, USER_HAS_NO_TIME_TO_PICKUP_ORDER, DELIVERY_CUSTOMS_ARRIVED, DELIVERY_CUSTOMS_CLEARED, FIRST_MILE_DELIVERY_SERVICE_RECEIVED, AWAIT_AUTO_DELIVERY_DATES, AWAIT_USER_PERSONAL_DATA, NO_PERSONAL_DATA_EXPIRED, CUSTOMS_PROBLEMS, AWAIT_CASHIER, WAITING_POSTPAID_BUDGET_RESERVATION, AWAIT_SERVICEABLE_CONFIRMATION, POSTPAID_BUDGET_RESERVATION_FAILED, AWAIT_CUSTOM_PRICE_CONFIRMATION, READY_FOR_PICKUP, TOO_MANY_DELIVERY_DATE_CHANGES, TOO_LONG_DELIVERY, DEFERRED_PAYMENT, POSTPAID_FAILED, INCORRECT_PERSONAL_DATA, UNKNOWN

Responses

200 OK

Список заказов в кабинете.

Body

application/json

{
    "orders": [
        {
            "orderId": 0,
            "campaignId": 0,
            "programType": "FBY",
            "externalOrderId": "string",
            "status": "PLACING",
            "substatus": "RESERVATION_EXPIRED",
            "creationDate": "2020-02-02T14:30:30+03:00",
            "updateDate": "2020-02-02T14:30:30+03:00",
            "paymentType": "PREPAID",
            "paymentMethod": "CASH_ON_DELIVERY",
            "fake": false,
            "items": [
                {
                    "id": 0,
                    "offerId": "string",
                    "offerName": "string",
                    "count": 0,
                    "prices": {
                        "payment": {
                            "value": 0,
                            "currencyId": "RUR"
                        },
                        "subsidy": {
                            "value": 0,
                            "currencyId": "RUR"
                        },
                        "cashback": {
                            "value": 0,
                            "currencyId": "RUR"
                        },
                        "vat": "NO_VAT"
                    },
                    "instances": [
                        {
                            "cis": "string",
                            "cisFull": "string",
                            "uin": "string",
                            "rnpt": "string",
                            "gtd": "string",
                            "countryCode": "RU"
                        }
                    ],
                    "requiredInstanceTypes": [
                        "CIS"
                    ],
                    "tags": [
                        "ULTIMA"
                    ]
                }
            ],
            "prices": {
                "payment": {
                    "value": 0,
                    "currencyId": "RUR"
                },
                "subsidy": {
                    "value": 0,
                    "currencyId": "RUR"
                },
                "cashback": {
                    "value": 0,
                    "currencyId": "RUR"
                },
                "delivery": {
                    "payment": {
                        "value": 0,
                        "currencyId": "RUR"
                    },
                    "subsidy": {
                        "value": 0,
                        "currencyId": "RUR"
                    },
                    "vat": "NO_VAT"
                }
            },
            "delivery": {
                "type": "DELIVERY",
                "serviceName": "string",
                "deliveryServiceId": 0,
                "warehouseId": "string",
                "deliveryPartnerType": "SHOP",
                "dispatchType": "UNKNOWN",
                "dates": {
                    "fromDate": "string",
                    "toDate": "string",
                    "fromTime": "string",
                    "toTime": "string",
                    "realDeliveryDate": "string"
                },
                "shipment": {
                    "id": 0,
                    "shipmentDate": "string",
                    "shipmentTime": "string"
                },
                "courier": {
                    "address": {
                        "country": "string",
                        "postcode": "string",
                        "city": "string",
                        "district": "string",
                        "subway": "string",
                        "street": "string",
                        "house": "string",
                        "block": "string",
                        "entrance": "string",
                        "entryphone": "string",
                        "floor": "string",
                        "apartment": "string",
                        "gps": {
                            "latitude": 0,
                            "longitude": 0
                        }
                    },
                    "region": {
                        "id": 0,
                        "name": "string",
                        "type": "OTHER"
                    }
                },
                "pickup": {
                    "address": {
                        "country": "string",
                        "postcode": "string",
                        "city": "string",
                        "district": "string",
                        "subway": "string",
                        "street": "string",
                        "house": "string",
                        "block": "string",
                        "entrance": "string",
                        "entryphone": "string",
                        "floor": "string",
                        "apartment": "string",
                        "gps": {
                            "latitude": 0,
                            "longitude": 0
                        }
                    },
                    "region": {
                        "id": 0,
                        "name": "string",
                        "type": "OTHER"
                    },
                    "logisticPointId": 0,
                    "outletCode": "string",
                    "outletStorageLimitDate": "string"
                },
                "transfer": {
                    "courier": {
                        "fullName": "string",
                        "phone": "string",
                        "phoneExtension": "string",
                        "vehicleNumber": "string",
                        "vehicleDescription": "string"
                    },
                    "eac": {
                        "eacType": "MERCHANT_TO_COURIER",
                        "eacCode": "string"
                    }
                },
                "boxesLayout": [
                    {
                        "items": [
                            {
                                "id": 0,
                                "fullCount": 0,
                                "partialCount": {
                                    "current": 0,
                                    "total": 0
                                },
                                "instances": [
                                    {
                                        "cis": "string",
                                        "uin": "string",
                                        "rnpt": "string",
                                        "gtd": "string",
                                        "countryCode": "RU"
                                    }
                                ]
                            }
                        ],
                        "boxId": 0,
                        "barcode": "string"
                    }
                ],
                "tracks": [
                    {
                        "trackCode": "string",
                        "deliveryServiceId": 0
                    }
                ],
                "estimated": false
            },
            "services": {
                "liftType": "NOT_NEEDED"
            },
            "buyerType": "PERSON",
            "notes": "string",
            "cancelRequested": false
        }
    ],
    "paging": {
        "nextPageToken": "string"
    }
}

Name

Description

orders*

Type: BusinessOrderDTO[]

Список заказов в кабинете.
Информация о заказе.

Max items: 50

paging

Type: ForwardScrollingPagerDTO

Информация о страницах результатов.

BusinessOrderDTO

Информация о заказе.

Name	Description
campaignId*	Type: integer<int64> Идентификатор кампании.
creationDate*	Type: string<date-time> Дата создания невыкупа или возврата. Формат даты: ISO 8601 со смещением относительно UTC. Example: `2020-02-02T14:30:30+03:00`
delivery*	Type: BusinessOrderDeliveryDTO Информация о доставке заказа.
fake*	Type: boolean Тип заказа: `false` — настоящий заказ покупателя. `true` — тестовый заказ Маркета.
items*	Type: BusinessOrderItemDTO[] Список товаров в заказе. Информация о товаре.
orderId*	Type: integer<int64> Идентификатор заказа.
paymentMethod*	Type: OrderPaymentMethodType Способ оплаты заказа: Значения, если выбрана оплата при оформлении заказа (`"paymentType": "PREPAID"`): `YANDEX` — банковской картой. `APPLE_PAY` — Apple Pay (не используется). `GOOGLE_PAY` — Google Pay (не используется). `CREDIT` — в кредит. `TINKOFF_CREDIT` — в кредит в Тинькофф Банке. `TINKOFF_INSTALLMENTS` — рассрочка в Тинькофф Банке. `EXTERNAL_CERTIFICATE` — подарочным сертификатом (например, из приложения «Сбербанк Онлайн»). `SBP` — через систему быстрых платежей. `B2B_ACCOUNT_PREPAYMENT` — заказ оплачивает организация. Значения, если выбрана оплата при получении заказа (`"paymentType": "POSTPAID"`): `CARD_ON_DELIVERY` — банковской картой. `BOUND_CARD_ON_DELIVERY` — привязанной картой при получении. `BNPL_BANK_ON_DELIVERY` — супер Сплитом. `BNPL_ON_DELIVERY` — Сплитом. `CASH_ON_DELIVERY` — наличными. `B2B_ACCOUNT_POSTPAYMENT` — заказ оплачивает организация после доставки. `UNKNOWN` — неизвестный тип. Значение по умолчанию: `CASH_ON_DELIVERY`. Enum: `CASH_ON_DELIVERY`, `CARD_ON_DELIVERY`, `BOUND_CARD_ON_DELIVERY`, `BNPL_BANK_ON_DELIVERY`, `BNPL_ON_DELIVERY`, `YANDEX`, `APPLE_PAY`, `EXTERNAL_CERTIFICATE`, `CREDIT`, `GOOGLE_PAY`, `TINKOFF_CREDIT`, `SBP`, `TINKOFF_INSTALLMENTS`, `B2B_ACCOUNT_PREPAYMENT`, `B2B_ACCOUNT_POSTPAYMENT`, `UNKNOWN`
paymentType*	Type: OrderPaymentType Тип оплаты заказа: `PREPAID` — оплата при оформлении заказа. `POSTPAID` — оплата при получении заказа. `UNKNOWN` — неизвестный тип. Если параметр отсутствует, заказ будет оплачен при получении. Enum: `PREPAID`, `POSTPAID`, `UNKNOWN`
status*	Type: OrderStatusType Статус заказа: `PLACING` — оформляется, подготовка к резервированию. `RESERVED` — зарезервирован, но недооформлен. `UNPAID` — оформлен, но еще не оплачен (если выбрана оплата при оформлении). `PROCESSING` — находится в обработке. `DELIVERY` — передан в службу доставки. `PICKUP` — доставлен в пункт выдачи. `DELIVERED` — получен покупателем. `CANCELLED` — отменен. `PENDING` — ожидает обработки со стороны продавца. `PARTIALLY_RETURNED` — возвращен частично. `RETURNED` — возвращен полностью. `UNKNOWN` — неизвестный статус. Также могут возвращаться другие значения. Обрабатывать их не нужно. Enum: `PLACING`, `RESERVED`, `UNPAID`, `PROCESSING`, `DELIVERY`, `PICKUP`, `DELIVERED`, `CANCELLED`, `PENDING`, `PARTIALLY_RETURNED`, `RETURNED`, `UNKNOWN`
substatus*	Type: OrderSubstatusType Этап обработки заказа (статус `PROCESSING`) или причина отмены заказа (статус `CANCELLED`). Значения для заказа в статусе `PROCESSING`: `STARTED` — заказ подтвержден, его можно начать обрабатывать. `READY_TO_SHIP` — заказ собран и готов к отправке. Значения для заказа в статусе `CANCELLED`: `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: не менее 3 звонков с 8 до 21 в часовом поясе покупателя; перерыв между первым и третьим звонком не менее 90 минут; соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. `USER_REFUSED_PRODUCT` — покупателю не подошел товар. `SHOP_FAILED` — магазин не может выполнить заказ. `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. `PROCESSING_EXPIRED` — значение более не используется. `PICKUP_EXPIRED` — закончился срок хранения заказа в пункт выдачи. `TOO_MANY_DELIVERY_DATE_CHANGES` — заказ переносили слишком много раз. `TOO_LONG_DELIVERY` — заказ доставляется слишком долго. `INCORRECT_PERSONAL_DATA` — для заказа из-за рубежа указаны неправильные данные получателя, заказ не пройдет проверку на таможне. `TECHNICAL_ERROR` — техническая ошибка на стороне Маркета. Обратитесь в поддержку. Также могут возвращаться другие значения. Обрабатывать их не нужно. Enum: `RESERVATION_EXPIRED`, `USER_NOT_PAID`, `USER_UNREACHABLE`, `USER_CHANGED_MIND`, `USER_REFUSED_DELIVERY`, `USER_REFUSED_PRODUCT`, `SHOP_FAILED`, `USER_REFUSED_QUALITY`, `REPLACING_ORDER`, `PROCESSING_EXPIRED`, `PENDING_EXPIRED`, `SHOP_PENDING_CANCELLED`, `PENDING_CANCELLED`, `USER_FRAUD`, `RESERVATION_FAILED`, `USER_PLACED_OTHER_ORDER`, `USER_BOUGHT_CHEAPER`, `MISSING_ITEM`, `BROKEN_ITEM`, `WRONG_ITEM`, `PICKUP_EXPIRED`, `DELIVERY_PROBLEMS`, `LATE_CONTACT`, `CUSTOM`, `DELIVERY_SERVICE_FAILED`, `WAREHOUSE_FAILED_TO_SHIP`, `DELIVERY_SERVICE_UNDELIVERED`, `PREORDER`, `AWAIT_CONFIRMATION`, `STARTED`, `PACKAGING`, `READY_TO_SHIP`, `SHIPPED`, `ASYNC_PROCESSING`, `WAITING_USER_INPUT`, `WAITING_BANK_DECISION`, `BANK_REJECT_CREDIT_OFFER`, `CUSTOMER_REJECT_CREDIT_OFFER`, `CREDIT_OFFER_FAILED`, `AWAIT_DELIVERY_DATES_CONFIRMATION`, `SERVICE_FAULT`, `DELIVERY_SERVICE_RECEIVED`, `USER_RECEIVED`, `WAITING_FOR_STOCKS`, `AS_PART_OF_MULTI_ORDER`, `READY_FOR_LAST_MILE`, `LAST_MILE_STARTED`, `ANTIFRAUD`, `DELIVERY_USER_NOT_RECEIVED`, `DELIVERY_SERVICE_DELIVERED`, `DELIVERED_USER_NOT_RECEIVED`, `USER_WANTED_ANOTHER_PAYMENT_METHOD`, `USER_RECEIVED_TECHNICAL_ERROR`, `USER_FORGOT_TO_USE_BONUS`, `DELIVERY_SERVICE_NOT_RECEIVED`, `DELIVERY_SERVICE_LOST`, `SHIPPED_TO_WRONG_DELIVERY_SERVICE`, `DELIVERED_USER_RECEIVED`, `WAITING_TINKOFF_DECISION`, `COURIER_SEARCH`, `COURIER_FOUND`, `COURIER_IN_TRANSIT_TO_SENDER`, `COURIER_ARRIVED_TO_SENDER`, `COURIER_RECEIVED`, `COURIER_NOT_FOUND`, `COURIER_NOT_DELIVER_ORDER`, `COURIER_RETURNS_ORDER`, `COURIER_RETURNED_ORDER`, `WAITING_USER_DELIVERY_INPUT`, `PICKUP_SERVICE_RECEIVED`, `PICKUP_USER_RECEIVED`, `CANCELLED_COURIER_NOT_FOUND`, `COURIER_NOT_COME_FOR_ORDER`, `DELIVERY_NOT_MANAGED_REGION`, `INCOMPLETE_CONTACT_INFORMATION`, `INCOMPLETE_MULTI_ORDER`, `INAPPROPRIATE_WEIGHT_SIZE`, `TECHNICAL_ERROR`, `SORTING_CENTER_LOST`, `COURIER_SEARCH_NOT_STARTED`, `LOST`, `AWAIT_PAYMENT`, `AWAIT_LAVKA_RESERVATION`, `USER_WANTS_TO_CHANGE_ADDRESS`, `FULL_NOT_RANSOM`, `PRESCRIPTION_MISMATCH`, `DROPOFF_LOST`, `DROPOFF_CLOSED`, `DELIVERY_TO_STORE_STARTED`, `USER_WANTS_TO_CHANGE_DELIVERY_DATE`, `WRONG_ITEM_DELIVERED`, `DAMAGED_BOX`, `AWAIT_DELIVERY_DATES`, `LAST_MILE_COURIER_SEARCH`, `PICKUP_POINT_CLOSED`, `LEGAL_INFO_CHANGED`, `USER_HAS_NO_TIME_TO_PICKUP_ORDER`, `DELIVERY_CUSTOMS_ARRIVED`, `DELIVERY_CUSTOMS_CLEARED`, `FIRST_MILE_DELIVERY_SERVICE_RECEIVED`, `AWAIT_AUTO_DELIVERY_DATES`, `AWAIT_USER_PERSONAL_DATA`, `NO_PERSONAL_DATA_EXPIRED`, `CUSTOMS_PROBLEMS`, `AWAIT_CASHIER`, `WAITING_POSTPAID_BUDGET_RESERVATION`, `AWAIT_SERVICEABLE_CONFIRMATION`, `POSTPAID_BUDGET_RESERVATION_FAILED`, `AWAIT_CUSTOM_PRICE_CONFIRMATION`, `READY_FOR_PICKUP`, `TOO_MANY_DELIVERY_DATE_CHANGES`, `TOO_LONG_DELIVERY`, `DEFERRED_PAYMENT`, `POSTPAID_FAILED`, `INCORRECT_PERSONAL_DATA`, `UNKNOWN`
buyerType	Type: OrderBuyerType Тип покупателя: `PERSON` — физическое лицо. `BUSINESS` — организация. Enum: `PERSON`, `BUSINESS`
cancelRequested	Type: boolean Только для модели DBS Запрошена ли отмена.
externalOrderId	Type: string Внешний идентификатор заказа, который вы передали в POST v2/campaigns/{campaignId}/orders/{orderId}/external-id. Min length: `1`
notes	Type: string Комментарий к заказу.
prices	Type: OrderPriceDTO Информация о стоимости заказа, доставки и вознаграждениях.
programType	Type: SellingProgramType Модель работы: `FBY` — FBY. `FBS` — FBS. `DBS` — DBS. `EXPRESS` — Экспресс. Enum: `FBY`, `FBS`, `DBS`, `EXPRESS`, `LAAS`
services	Type: BusinessOrderServicesDTO Услуги, добавленные в заказ.
updateDate	Type: string<date-time> Дата и время последнего обновления заказа. Формат даты: ISO 8601 со смещением относительно UTC. Example: `2020-02-02T14:30:30+03:00`

ForwardScrollingPagerDTO

Идентификатор следующей страницы.

Name

Description

nextPageToken

Type: string

Идентификатор следующей страницы результатов.

BusinessOrderDeliveryDTO

Информация о доставке заказа.

Name	Description
dates*	Type: BusinessOrderDeliveryDatesDTO Диапазон дат доставки.
deliveryPartnerType*	Type: OrderDeliveryPartnerType Тип сотрудничества со службой доставки в рамках указанного заказа. Enum: `SHOP`, `YANDEX_MARKET`, `UNKNOWN`
deliveryServiceId*	Type: integer<int64> Идентификатор службы доставки.
serviceName*	Type: string Название службы доставки.
type*	Type: OrderDeliveryType Способ доставки заказа. Enum: `DELIVERY`, `PICKUP`, `POST`, `DIGITAL`, `UNKNOWN`
boxesLayout	Type: BusinessOrderBoxLayoutDTO[] Раскладка товаров по коробкам. Информация о коробке (для заказов в кабинете). Min items: `1`
courier	Type: BusinessOrderCourierDeliveryDTO Информация о курьерской доставке.
dispatchType	Type: OrderDeliveryDispatchType Способ доставки: `BUYER` — курьерская доставка покупателю. `MARKET_BRANDED_OUTLET` — доставка в пункт выдачи заказов Маркета. `SHOP_OUTLET` — доставка в пункт выдачи заказов магазина. `UNKNOWN` — неизвестный тип. Enum: `UNKNOWN`, `BUYER`, `MARKET_BRANDED_OUTLET`, `SHOP_OUTLET`
estimated	Type: boolean Приблизительная ли дата доставки.
pickup	Type: BusinessOrderPickupDeliveryDTO Информация о доставке в пункт выдачи.
shipment	Type: BusinessOrderShipmentDTO Информация об отгрузке.
tracks	Type: OrderTrackDTO[] Информация для отслеживания посылки. Информация о трек-номере посылки (DBS). Min items: `1`
transfer	Type: BusinessOrderTransferDTO Информация о курьере и код подтверждения.
warehouseId	Type: string Идентификатор склада в системе магазина, на который сформирован заказ.

BusinessOrderItemDTO

Информация о товаре.

Name	Description
count*	Type: integer Количество единиц товара.
id*	Type: integer<int64> Идентификатор товара в заказе. Позволяет идентифицировать товар в рамках заказа.
offerId*	Type: string Идентификатор товарного предложения. Min length: `1` Max length: `255` Pattern: `^(?=.\S.)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$`
offerName*	Type: string Название товара.
instances	Type: OrderItemInstanceDTO[] Информация о маркировке единиц товара. Возвращаются данные для маркировки, переданные в запросе PUT v2/campaigns/{campaignId}/orders/{orderId}/identifiers. Если магазин еще не передавал коды для этого заказа, `instances` отсутствует. Переданные для данной позиции коды маркировки или УИНы. Коды «Честного знака» возвращаются в двух вариантах — с криптохвостом и без. Min items: `1`
prices	Type: ItemPriceDTO Информация о выплатах и вознаграждениях.
requiredInstanceTypes	Type: OrderItemInstanceType[] Список необходимых маркировок товара. Вид маркировки товара: `CIS` — КИЗ, идентификатор единицы товара в системе «Честный ЗНАК» или «ASL BELGISI» (для продавцов Market Yandex Go). Обязателен для заполнения. `CIS_OPTIONAL` — КИЗ, идентификатор единицы товара в системе «Честный ЗНАК». Необязателен для заполнения, но в ближайшее время потребуется его передача. `UIN` — УИН, уникальный идентификационный номер. `RNPT` — РНПТ, регистрационный номер партии товара. `GTD` — номер ГТД, грузовой таможенной декларации. Enum: `CIS`, `CIS_OPTIONAL`, `UIN`, `RNPT`, `GTD` Min items: `1` Unique items
tags	Type: OrderItemTagType[] Признаки товара. Признак товара: `ULTIMA` — премиум-товар. `SAFE_TAG` — товар с защитной меткой. `TURBO` — товар, который быстро раскупают. Enum: `ULTIMA`, `SAFE_TAG`, `TURBO` Min items: `1` Unique items

OrderPaymentMethodType

Способ оплаты заказа:

Значения, если выбрана оплата при оформлении заказа ("paymentType": "PREPAID"):
- YANDEX — банковской картой.
- APPLE_PAY — Apple Pay (не используется).
- GOOGLE_PAY — Google Pay (не используется).
- CREDIT — в кредит.
- TINKOFF_CREDIT — в кредит в Тинькофф Банке.
- TINKOFF_INSTALLMENTS — рассрочка в Тинькофф Банке.
- EXTERNAL_CERTIFICATE — подарочным сертификатом (например, из приложения «Сбербанк Онлайн»).
- SBP — через систему быстрых платежей.
- B2B_ACCOUNT_PREPAYMENT — заказ оплачивает организация.
Значения, если выбрана оплата при получении заказа ("paymentType": "POSTPAID"):
- CARD_ON_DELIVERY — банковской картой.
- BOUND_CARD_ON_DELIVERY — привязанной картой при получении.
- BNPL_BANK_ON_DELIVERY — супер Сплитом.
- BNPL_ON_DELIVERY — Сплитом.
- CASH_ON_DELIVERY — наличными.
- B2B_ACCOUNT_POSTPAYMENT — заказ оплачивает организация после доставки.
UNKNOWN — неизвестный тип.

Значение по умолчанию: CASH_ON_DELIVERY.

Type	Description
OrderPaymentMethodType	Enum: `CASH_ON_DELIVERY`, `CARD_ON_DELIVERY`, `BOUND_CARD_ON_DELIVERY`, `BNPL_BANK_ON_DELIVERY`, `BNPL_ON_DELIVERY`, `YANDEX`, `APPLE_PAY`, `EXTERNAL_CERTIFICATE`, `CREDIT`, `GOOGLE_PAY`, `TINKOFF_CREDIT`, `SBP`, `TINKOFF_INSTALLMENTS`, `B2B_ACCOUNT_PREPAYMENT`, `B2B_ACCOUNT_POSTPAYMENT`, `UNKNOWN`

OrderPaymentType

Тип оплаты заказа:

PREPAID — оплата при оформлении заказа.
POSTPAID — оплата при получении заказа.
UNKNOWN — неизвестный тип.

Если параметр отсутствует, заказ будет оплачен при получении.

Type	Description
OrderPaymentType	Enum: `PREPAID`, `POSTPAID`, `UNKNOWN`

OrderBuyerType

Тип покупателя:

PERSON — физическое лицо.
BUSINESS — организация.

Type	Description
OrderBuyerType	Enum: `PERSON`, `BUSINESS`

OrderPriceDTO

Информация о стоимости заказа.

Как рассчитывается стоимость заказа, доставки и вознаграждение продавцу

Стоимость товаров в заказе складывается из параметров payment и cashback.
Общая сумма вознаграждений продавцу возвращается в параметре subsidy.
Значение payment, cashback и subsidy может отличаться от стоимости в каталоге, потому что информация об акциях магазина не возвращается.
Стоимость доставки складывается из параметров payment и subsidy в delivery.
Все суммы указаны в валюте магазина.

Name	Description
cashback	Type: CurrencyValueDTO Сумма, которая оплачена баллами Плюса. Возвращается баллами.
delivery	Type: DeliveryPriceDTO Информация о стоимости доставки, включая подъем на этаж.
payment	Type: CurrencyValueDTO Сумма платежа покупателя.
subsidy	Type: CurrencyValueDTO Общая сумма вознаграждений продавцу.

BusinessOrderServicesDTO

Услуги, добавленные в заказ.

Name

Description

liftType

Type: OrderLiftType

Тип подъема заказа на этаж:

NOT_NEEDED — не требуется.
MANUAL — ручной.
ELEVATOR — лифт.
CARGO_ELEVATOR — грузовой лифт.
FREE — любой из перечисленных выше, если включена опция бесплатного подъема.
UNKNOWN — неизвестный тип.

Enum: NOT_NEEDED, MANUAL, ELEVATOR, CARGO_ELEVATOR, FREE, UNKNOWN

BusinessOrderDeliveryDatesDTO

Диапазон дат доставки.

Name	Description
fromDate*	Type: string<date> Ближайшая дата доставки. Формат даты: `ГГГГ-ММ-ДД`.
fromTime	Type: string<time> Начало интервала времени доставки. Передается только вместе с параметром `type=DELIVERY`. Формат времени: 24-часовой, `ЧЧ:ММ`. Вместо `ММ` всегда указывайте `00` (исключение — `23:59`). Минимальное значение: `00:00`.
realDeliveryDate	Type: string<date> Дата, когда товар доставлен до пункта выдачи заказа (в случае самовывоза) или до покупателя (если заказ доставляет курьер). Формат даты: `ГГГГ-ММ-ДД`.
toDate	Type: string<date> Самая поздняя дата доставки. Если `toDate` не указан, считается дата в параметре `fromDate`. Формат даты: `ГГГГ-ММ-ДД`.
toTime	Type: string<time> Конец интервала времени доставки. Передается только вместе с параметром `type=DELIVERY`. Формат времени: 24-часовой, `ЧЧ:ММ`. Вместо `ММ` всегда указывайте `00` (исключение — `23:59`). Максимальное значение: `23:59`.

OrderDeliveryPartnerType

Тип сотрудничества со службой доставки в рамках конкретного заказа:

SHOP — магазин работает со службой доставки напрямую или доставляет заказы самостоятельно.
YANDEX_MARKET — магазин работает со службой доставки через Маркет.
UNKNOWN — неизвестный тип.

Type	Description
OrderDeliveryPartnerType	Enum: `SHOP`, `YANDEX_MARKET`, `UNKNOWN`

OrderDeliveryType

Способ доставки заказа:

DELIVERY — курьерская доставка.
PICKUP — самовывоз.
POST — почта.
DIGITAL — для цифровых товаров.
UNKNOWN — неизвестный тип.

Type	Description
OrderDeliveryType	Enum: `DELIVERY`, `PICKUP`, `POST`, `DIGITAL`, `UNKNOWN`

BusinessOrderBoxLayoutDTO

Информация о коробке (для заказов в кабинете).

Name	Description
barcode*	Type: string Идентификатор грузового места в системе магазина.
boxId*	Type: integer<int64> Идентификатор коробки.
items*	Type: BusinessOrderBoxLayoutItemDTO[] Список товаров в коробке. Если в коробке едет часть большого товара, в списке может быть только один пункт. Информация о товаре в коробке. Min items: `1`

BusinessOrderCourierDeliveryDTO

Информация о курьерской доставке.

Name

Description

address

Type: BusinessOrderDeliveryAddressDTO

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

Указывается, если параметр type принимает значение DELIVERY, POST или PICKUP (только для модели DBS). Если type=PICKUP, возвращается адрес пункта выдачи.

region

Type: RegionDTO

Регион доставки.

OrderDeliveryDispatchType

Способ доставки:

BUYER — курьерская доставка покупателю.
MARKET_BRANDED_OUTLET — доставка в пункт выдачи заказов Маркета.
SHOP_OUTLET — доставка в пункт выдачи заказов магазина.
UNKNOWN — неизвестный тип.

Type	Description
OrderDeliveryDispatchType	Enum: `UNKNOWN`, `BUYER`, `MARKET_BRANDED_OUTLET`, `SHOP_OUTLET`

BusinessOrderPickupDeliveryDTO

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

Name	Description
address	Type: BusinessOrderDeliveryAddressDTO Адрес доставки. Указывается, если параметр `type` принимает значение `DELIVERY`, `POST` или `PICKUP` (только для модели DBS). Если `type=PICKUP`, возвращается адрес пункта выдачи.
logisticPointId	Type: integer<int64> Идентификатор пункта выдачи. Его можно узнать с помощью метода POST v1/businesses/{businessId}/logistics-points. Min value: `1`
outletCode	Type: string Идентификатор пункта самовывоза, присвоенный магазином.
outletStorageLimitDate	Type: string<date> Дата, до которой заказ будет храниться в пункте выдачи. Возвращается, когда заказ переходит в статус `PICKUP`. Один раз дату можно поменять с помощью метода PUT v2/campaigns/{campaignId}/orders/{orderId}/delivery/storage-limit. Формат даты: `ГГГГ-ММ-ДД`.
region	Type: RegionDTO Регион доставки.

BusinessOrderShipmentDTO

Информация об отгрузке заказа.

Name	Description
shipmentDate*	Type: string<date> Дата отгрузки. Формат даты: `ГГГГ-ММ-ДД`.
id	Type: integer<int64> Идентификатор отгрузки.
shipmentTime	Type: string<time> Время отгрузки.

OrderTrackDTO

Информация о трек-номере посылки (DBS).

Name

Description

deliveryServiceId*

Type: integer<int64>

Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса GET delivery/services.

trackCode

Type: string

Трек‑номер посылки.

BusinessOrderTransferDTO

Информация о курьере и код подтверждения.

Name

Description

courier

Type: OrderCourierDTO

Информация о курьере.

eac

Type: BusinessOrderEacDTO

Информация о коде подтверждения.

OrderItemInstanceDTO

Переданные для данной позиции коды маркировки или УИНы. Коды «Честного знака» возвращаются в двух вариантах — с криптохвостом и без.

Name	Description
cis	Type: string Код идентификации единицы товара в системе «Честный ЗНАК» без криптохвоста или «ASL BELGISI» (для продавцов Market Yandex Go).
cisFull	Type: string Код идентификации единицы товара в системе «Честный ЗНАК» с криптохвостом.
countryCode	Type: string Страна производства в формате ISO 3166-1 alpha-2. Как получить Example: `RU` Min length: `2` Max length: `2` Pattern: `^[A-Z]{2}$`
gtd	Type: string Грузовая таможенная декларация. Представляет собой строку из трех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на ввезенные товары. Далее — дата и номер декларации.
rnpt	Type: string Регистрационный номер партии товара. Представляет собой строку из четырех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ/ХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на партию товара. Далее — дата, номер декларации и номер маркированного товара в декларации.
uin	Type: string УИН ювелирного изделия (16-значный код) Производитель получает УИН, когда регистрирует изделие в системе контроля за оборотом драгоценных металлов и камней — ГИИС ДМДК.

ItemPriceDTO

Информация о выплатах и вознаграждениях.

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

Стоимость всех единиц товара складывается из параметров payment и cashback.
Общая сумма вознаграждений продавцу возвращается в параметре subsidy.
Значение payment, cashback и subsidy может отличаться от стоимости в каталоге, потому что информация об акциях магазина не возвращается.
Если в заказе несколько единиц товаров, в параметрах возвращается суммарное значение.
Все суммы указаны в валюте магазина.

Name	Description
cashback	Type: CurrencyValueDTO Сумма, которая оплачена баллами Плюса.
payment	Type: CurrencyValueDTO Общая стоимость всех единиц товара.
subsidy	Type: CurrencyValueDTO Общая сумма вознаграждений продавцу.
vat	Type: OrderVatType НДС на товар или доставку: `NO_VAT` — НДС не облагается, используется только для отдельных видов услуг. `VAT_0` — НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров. `VAT_10` — НДС 10%. Например, используется при реализации отдельных продовольственных и медицинских товаров. `VAT_10_110` — НДС 10/110. НДС 10%, применяется только при предоплате. `VAT_20` — НДС 20%. Основной НДС с 2019 года. `VAT_20_120` — НДС 20/120. НДС 20%, применяется только при предоплате. `VAT_18` — НДС 18%. Основной НДС до 2019 года. `VAT_18_118` — НДС 18/118. НДС использовался до 1 января 2019 года при предоплате. `VAT_12` — НДС 12%. Используется только в Узбекистане. `VAT_05` — НДС 5%. НДС для упрощенной системы налогообложения (УСН). `VAT_07` — НДС 7%. НДС для упрощенной системы налогообложения (УСН). `UNKNOWN_VALUE` — неизвестный тип. Используется только вместе с параметром `payment-method=YANDEX`. Enum: `NO_VAT`, `VAT_0`, `VAT_10`, `VAT_10_110`, `VAT_20`, `VAT_20_120`, `VAT_18`, `VAT_18_118`, `VAT_12`, `VAT_05`, `VAT_07`, `UNKNOWN_VALUE`

OrderItemInstanceType

Вид маркировки товара:

CIS — КИЗ, идентификатор единицы товара в системе «Честный ЗНАК» или «ASL BELGISI» (для продавцов Market Yandex Go). Обязателен для заполнения.
CIS_OPTIONAL — КИЗ, идентификатор единицы товара в системе «Честный ЗНАК». Необязателен для заполнения, но в ближайшее время потребуется его передача.
UIN — УИН, уникальный идентификационный номер.
RNPT — РНПТ, регистрационный номер партии товара.
GTD — номер ГТД, грузовой таможенной декларации.

Type	Description
OrderItemInstanceType	Enum: `CIS`, `CIS_OPTIONAL`, `UIN`, `RNPT`, `GTD`

OrderItemTagType

Признак товара:

ULTIMA — премиум-товар.
SAFE_TAG — товар с защитной меткой.
TURBO — товар, который быстро раскупают.

Type	Description
OrderItemTagType	Enum: `ULTIMA`, `SAFE_TAG`, `TURBO`

CurrencyValueDTO

Валюта и ее значение.

Name

Description

currencyId*

Type: CurrencyType

Валюта.

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

value*

Type: number

Значение.

DeliveryPriceDTO

Информация о стоимости доставки, включая подъем на этаж.

Как рассчитывается стоимость доставки

Стоимость доставки складывается из параметров payment и subsidy.
Все суммы указаны в валюте магазина.

Name	Description
payment	Type: CurrencyValueDTO Платеж покупателя за доставку.
subsidy	Type: CurrencyValueDTO Вознаграждение Маркета за доставку.
vat	Type: OrderVatType НДС на товар или доставку: `NO_VAT` — НДС не облагается, используется только для отдельных видов услуг. `VAT_0` — НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров. `VAT_10` — НДС 10%. Например, используется при реализации отдельных продовольственных и медицинских товаров. `VAT_10_110` — НДС 10/110. НДС 10%, применяется только при предоплате. `VAT_20` — НДС 20%. Основной НДС с 2019 года. `VAT_20_120` — НДС 20/120. НДС 20%, применяется только при предоплате. `VAT_18` — НДС 18%. Основной НДС до 2019 года. `VAT_18_118` — НДС 18/118. НДС использовался до 1 января 2019 года при предоплате. `VAT_12` — НДС 12%. Используется только в Узбекистане. `VAT_05` — НДС 5%. НДС для упрощенной системы налогообложения (УСН). `VAT_07` — НДС 7%. НДС для упрощенной системы налогообложения (УСН). `UNKNOWN_VALUE` — неизвестный тип. Используется только вместе с параметром `payment-method=YANDEX`. Enum: `NO_VAT`, `VAT_0`, `VAT_10`, `VAT_10_110`, `VAT_20`, `VAT_20_120`, `VAT_18`, `VAT_18_118`, `VAT_12`, `VAT_05`, `VAT_07`, `UNKNOWN_VALUE`

OrderLiftType

Тип подъема заказа на этаж:

NOT_NEEDED — не требуется.
MANUAL — ручной.
ELEVATOR — лифт.
CARGO_ELEVATOR — грузовой лифт.
FREE — любой из перечисленных выше, если включена опция бесплатного подъема.
UNKNOWN — неизвестный тип.

Type	Description
OrderLiftType	Enum: `NOT_NEEDED`, `MANUAL`, `ELEVATOR`, `CARGO_ELEVATOR`, `FREE`, `UNKNOWN`

BusinessOrderBoxLayoutItemDTO

Информация о товаре в коробке.

Name	Description
id*	Type: integer<int64> Идентификатор товара в заказе. Параметр `id` в `items`.
fullCount	Type: integer<int32> Количество единиц товара в коробке. Min value: `1`
instances	Type: BriefOrderItemInstanceDTO[] Переданные коды маркировки. Идентификатор единицы товара. Заполните только одно поле в зависимости от того, в какой системе маркирован товар. Подробно о работе с маркируемыми товарами читайте в Справке Маркета для продавцов. Min items: `1`
partialCount	Type: BusinessOrderBoxLayoutPartialCountDTO Информация о части товара в коробке.

BusinessOrderDeliveryAddressDTO

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

Name	Description
apartment	Type: string Номер квартиры или офиса.
block	Type: string Корпус.
city	Type: string Город или населенный пункт.
country	Type: string Страна.
district	Type: string Район.
entrance	Type: string Номер подъезда.
entryphone	Type: string Код домофона.
floor	Type: string Этаж.
gps	Type: GpsDTO GPS-координаты.
house	Type: string Номер дома.
postcode	Type: string Почтовый индекс.
street	Type: string Улица.
subway	Type: string Станция метро.

RegionDTO

Регион доставки.

Name	Description
id*	Type: integer<int64> Идентификатор региона.
name*	Type: string Название региона.
type*	Type: RegionType Тип региона. Возможные значения: `CITY_DISTRICT` — район города. `CITY` — крупный город. `CONTINENT` — континент. `COUNTRY_DISTRICT` — область. `COUNTRY` — страна. `REGION` — регион. `REPUBLIC_AREA` — район субъекта федерации. `REPUBLIC` — субъект федерации. `SUBWAY_STATION` — станция метро. `VILLAGE` — город. `OTHER` — неизвестный регион. Enum: `OTHER`, `CONTINENT`, `REGION`, `COUNTRY`, `COUNTRY_DISTRICT`, `REPUBLIC`, `CITY`, `VILLAGE`, `CITY_DISTRICT`, `SUBWAY_STATION`, `REPUBLIC_AREA`
parent	Type: RegionDTO Регион доставки.

OrderCourierDTO

Информация о курьере.

Name	Description
fullName	Type: string Полное имя.
phone	Type: string Номер телефона.
phoneExtension	Type: string Добавочный номер телефона.
vehicleDescription	Type: string Описание транспортного средства. Например, модель и цвет.
vehicleNumber	Type: string Номер транспортного средства.

BusinessOrderEacDTO

Информация о коде подтверждения.

Name

Description

eacType*

Type: OrderDeliveryEacType

Тип кода подтверждения ЭАПП.

Enum: MERCHANT_TO_COURIER, COURIER_TO_MERCHANT, CHECKING_BY_MERCHANT

eacCode

Type: string

Код подтверждения ЭАПП (для типа MERCHANT_TO_COURIER).

OrderVatType

НДС на товар или доставку:

NO_VAT — НДС не облагается, используется только для отдельных видов услуг.
VAT_0 — НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров.
VAT_10 — НДС 10%. Например, используется при реализации отдельных продовольственных и медицинских товаров.
VAT_10_110 — НДС 10/110. НДС 10%, применяется только при предоплате.
VAT_20 — НДС 20%. Основной НДС с 2019 года.
VAT_20_120 — НДС 20/120. НДС 20%, применяется только при предоплате.
VAT_18 — НДС 18%. Основной НДС до 2019 года.
VAT_18_118 — НДС 18/118. НДС использовался до 1 января 2019 года при предоплате.
VAT_12 — НДС 12%. Используется только в Узбекистане.
VAT_05 — НДС 5%. НДС для упрощенной системы налогообложения (УСН).
VAT_07 — НДС 7%. НДС для упрощенной системы налогообложения (УСН).
UNKNOWN_VALUE — неизвестный тип.

Используется только вместе с параметром payment-method=YANDEX.

Type	Description
OrderVatType	Enum: `NO_VAT`, `VAT_0`, `VAT_10`, `VAT_10_110`, `VAT_20`, `VAT_20_120`, `VAT_18`, `VAT_18_118`, `VAT_12`, `VAT_05`, `VAT_07`, `UNKNOWN_VALUE`

CurrencyType

Коды валют:

RUR — российский рубль.
UAH — украинская гривна.
BYR — белорусский рубль.
KZT — казахстанский тенге.
UZS — узбекский сум.

Type

Description

CurrencyType

BriefOrderItemInstanceDTO

Идентификатор единицы товара.

Заполните только одно поле в зависимости от того, в какой системе маркирован товар.

Подробно о работе с маркируемыми товарами читайте в Справке Маркета для продавцов.

Name	Description
cis	Type: string [Код идентификации](*cis-regular-value) единицы товара в системе «Честный ЗНАК» или «ASL BELGISI» (для продавцов Market Yandex Go). Не экранируйте косую черту в коде символа-разделителя `\u001d` ✅ `01030410947874432155Qbag!\u001d93Zjqw` ❌ `01030410947874432155Qbag!\\u001d93Zjqw` Косые черты и кавычки в других местах экранируйте по правилам JSON: `\\` и `\"`
countryCode	Type: string Страна производства в формате ISO 3166-1 alpha-2. Как получить Example: `RU` Min length: `2` Max length: `2` Pattern: `^[A-Z]{2}$`
gtd	Type: string Грузовая таможенная декларация. Представляет собой строку из трех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на ввезенные товары. Далее — дата и номер декларации.
rnpt	Type: string Регистрационный номер партии товара. Представляет собой строку из четырех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ/ХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на партию товара. Далее — дата, номер декларации и номер маркированного товара в декларации.
uin	Type: string Уникальный идентификационный номер ювелирного изделия. Представляет собой число из 16 цифр.

BusinessOrderBoxLayoutPartialCountDTO

Информация о части товара в коробке.

Name

Description

current*

Type: integer<int32>

Номер части, начиная с 1.

Min value: 1

total*

Type: integer<int32>

На сколько всего частей разделен товар.

Min value: 2

GpsDTO

GPS-координаты широты и долготы.

Name

Description

latitude*

Type: number

Широта.

longitude*

Type: number

Долгота.

RegionType

Тип региона.

Возможные значения:

CITY_DISTRICT — район города.
CITY — крупный город.
CONTINENT — континент.
COUNTRY_DISTRICT — область.
COUNTRY — страна.
REGION — регион.
REPUBLIC_AREA — район субъекта федерации.
REPUBLIC — субъект федерации.
SUBWAY_STATION — станция метро.
VILLAGE — город.
OTHER — неизвестный регион.

Type	Description
RegionType	Enum: `OTHER`, `CONTINENT`, `REGION`, `COUNTRY`, `COUNTRY_DISTRICT`, `REPUBLIC`, `CITY`, `VILLAGE`, `CITY_DISTRICT`, `SUBWAY_STATION`, `REPUBLIC_AREA`

OrderDeliveryEacType

Тип кода подтверждения ЭАПП:

MERCHANT_TO_COURIER (временно не возвращается) — продавец передает код курьеру для получения невыкупа.
COURIER_TO_MERCHANT — курьер передает код продавцу для получения заказа.
CHECKING_BY_MERCHANT — продавец проверяет код на своей стороне.

Type	Description
OrderDeliveryEacType	Enum: `MERCHANT_TO_COURIER`, `COURIER_TO_MERCHANT`, `CHECKING_BY_MERCHANT`

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

Общий формат ошибки.

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

Описание ошибки.

ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

404 Not Found

Запрашиваемый ресурс не найден. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

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

Список заказов в магазине

Подготовка заказа