Информация о нескольких заказах

Info

Console

Метод доступен для всех моделей.

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

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

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

Вы также можете настроить API-уведомления

Маркет отправит вам запрос, когда появится новый заказ или изменится его статус. А полную информацию можно получить с помощью этого метода или GET campaigns/{campaignId}/orders/{orderId}.

Как работать с уведомлениями

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

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

Информация о заказах, доставленных или отмененных больше 30 дней назад, не возвращается. Ее можно получить с помощью запроса информации об отдельном заказе GET campaigns/{campaignId}/orders/{orderId} (если у вас есть идентификатор заказа) или запроса отчета по заказам POST campaigns/{campaignId}/stats/orders.

Максимальный диапазон дат за один запрос к ресурсу — 30 дней.

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

Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer.

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

Request

GET

https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders

Path parameters

Name

Description

campaignId*

Type: integer<int64>

Идентификатор магазина в кабинете.

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

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

Min value: 1

Query parameters

Name	Description
buyerType	Type: OrderBuyerType Фильтрация заказов по типу покупателя.
dispatchType	Type: OrderDeliveryDispatchType Способ отгрузки
fake	Type: boolean Фильтрация заказов по типам: `false` — настоящий заказ покупателя. `true` — тестовый заказ Маркета. Default: `false`
fromDate	Type: string<date> Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты.
hasCis	Type: boolean Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации в системе «Честный ЗНАК» или «ASL BELGISI» (для продавцов Market Yandex Go): `true` — да. `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям. Default: `false`
limit	Type: integer<int32> Количество значений на одной странице. Example: `20`
onlyEstimatedDelivery	Type: boolean Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: `true` — возвращаются только заказы с неподтвержденной датой доставки. `false` — фильтрация не применяется. Default: `false`
onlyWaitingForCancellationApprove	Type: boolean Только для модели DBS Фильтрация заказов по наличию запросов покупателей на отмену. При значение `true` возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept. Default: `false`
orderIds	Type: integer<int64>[] Фильтрация заказов по идентификаторам. ⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. Min items: `1` Max items: `50`
page	Type: integer<int32> Если в методе есть `page_token` Используйте его вместо параметра `page`. Подробнее о типах пагинации и их использовании Номер страницы результатов. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token` или `limit`. Default: `1` Max value: `10000`
pageSize	Type: integer<int32> Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token` или `limit`.
page_token	Type: string Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `page_number` и `page_size`, они игнорируются. Example: `eyBuZXh0SWQ6IDIzNDIgfQ==`
status	Type: OrderStatusType[] Статус заказа: `CANCELLED` — заказ отменен. `DELIVERED` — заказ получен покупателем. `DELIVERY` — заказ передан в службу доставки. `PICKUP` — заказ доставлен в пункт самовывоза. `PROCESSING` — заказ находится в обработке. `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется.
substatus	Type: OrderSubstatusType[] Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: `STARTED` — заказ подтвержден, его можно начать обрабатывать. `READY_TO_SHIP` — заказ собран и готов к отправке. `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `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` — закончился срок хранения заказа в ПВЗ. `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. Также могут возвращаться другие значения. Обрабатывать их не требуется.
supplierShipmentDateFrom	Type: string<date> Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации.
supplierShipmentDateTo	Type: string<date> Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации. Если промежуток времени между `supplierShipmentDateTo` и `supplierShipmentDateFrom` меньше суток, то `supplierShipmentDateTo` равен `supplierShipmentDateFrom` + сутки.
toDate	Type: string<date> Конечная дата для фильтрации заказов по дате оформления. Показываются заказы, созданные до 00:00 указанного дня. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата. Если промежуток времени между `toDate` и `fromDate` меньше суток, то `toDate` равен `fromDate` + сутки.
updatedAtFrom	Type: string<date-time> Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации.
updatedAtTo	Type: string<date-time> Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации.

OrderBuyerType

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

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

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

OrderDeliveryDispatchType

Способ отгрузки:

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

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

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 — заказ доставляется слишком долго.
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_SERIVCE_UNDELIVERED, DELIVERY_SERVICE_UNDELIVERED, PREORDER, AWAIT_CONFIRMATION, STARTED, PACKAGING, READY_TO_SHIP, SHIPPED, ASYNC_PROCESSING, USER_REFUSED_TO_PROVIDE_PERSONAL_DATA, 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, RECEIVED_ON_DISTRIBUTION_CENTER, 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, UNKNOWN

Responses

200 OK

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

Body

application/json

{
    "pager": {
        "total": 0,
        "from": 0,
        "to": 0,
        "currentPage": 0,
        "pagesCount": 0,
        "pageSize": 0
    },
    "orders": [
        {
            "id": 0,
            "status": "PLACING",
            "substatus": "RESERVATION_EXPIRED",
            "creationDate": "23-09-2022 09:12:41",
            "updatedAt": "23-09-2022 09:12:41",
            "currency": "RUR",
            "itemsTotal": 0,
            "deliveryTotal": 0,
            "buyerItemsTotal": 0,
            "buyerTotal": 0,
            "buyerItemsTotalBeforeDiscount": 0,
            "buyerTotalBeforeDiscount": 0,
            "paymentType": "PREPAID",
            "paymentMethod": "CASH_ON_DELIVERY",
            "fake": false,
            "items": [
                {
                    "id": 0,
                    "offerId": "string",
                    "offerName": "string",
                    "price": 0,
                    "buyerPrice": 0,
                    "buyerPriceBeforeDiscount": 0,
                    "priceBeforeDiscount": 0,
                    "count": 0,
                    "vat": "NO_VAT",
                    "shopSku": "string",
                    "subsidy": 0,
                    "partnerWarehouseId": "string",
                    "promos": [
                        {
                            "type": "DIRECT_DISCOUNT",
                            "discount": 0,
                            "subsidy": 0,
                            "shopPromoId": "string",
                            "marketPromoId": "string"
                        }
                    ],
                    "instances": [
                        {
                            "cis": "string",
                            "cisFull": "string",
                            "uin": "string",
                            "rnpt": "string",
                            "gtd": "string",
                            "countryCode": "RU"
                        }
                    ],
                    "details": [
                        {
                            "itemCount": 0,
                            "itemStatus": "REJECTED",
                            "updateDate": "23-09-2022"
                        }
                    ],
                    "subsidies": [
                        {
                            "type": "YANDEX_CASHBACK",
                            "amount": 0
                        }
                    ],
                    "requiredInstanceTypes": [
                        "CIS"
                    ],
                    "tags": [
                        "ULTIMA"
                    ]
                }
            ],
            "subsidies": [
                {
                    "type": "YANDEX_CASHBACK",
                    "amount": 0
                }
            ],
            "delivery": {
                "id": "string",
                "type": "DELIVERY",
                "serviceName": "string",
                "price": 0,
                "deliveryPartnerType": "SHOP",
                "courier": {
                    "fullName": "string",
                    "phone": "string",
                    "phoneExtension": "string",
                    "vehicleNumber": "string",
                    "vehicleDescription": "string"
                },
                "dates": {
                    "fromDate": "23-09-2022",
                    "toDate": "23-09-2022",
                    "fromTime": "string",
                    "toTime": "string",
                    "realDeliveryDate": "23-09-2022"
                },
                "region": {
                    "id": 0,
                    "name": "string",
                    "type": "OTHER",
                    "parent": {
                        "id": 0,
                        "name": "string",
                        "type": "OTHER",
                        "children": [
                            null
                        ]
                    },
                    "children": [
                        null
                    ]
                },
                "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",
                    "phone": "string",
                    "recipient": "string",
                    "gps": {
                        "latitude": 0,
                        "longitude": 0
                    }
                },
                "vat": "NO_VAT",
                "deliveryServiceId": 0,
                "liftType": "NOT_NEEDED",
                "liftPrice": 0,
                "outletCode": "string",
                "outletStorageLimitDate": "23-09-2022",
                "dispatchType": "UNKNOWN",
                "tracks": [
                    {
                        "trackCode": "string",
                        "deliveryServiceId": 0
                    }
                ],
                "shipments": [
                    {
                        "id": 0,
                        "shipmentDate": "23-09-2022",
                        "shipmentTime": "string",
                        "tracks": [
                            {
                                "trackCode": "string",
                                "deliveryServiceId": 0
                            }
                        ],
                        "boxes": [
                            {
                                "id": 0,
                                "fulfilmentId": "string"
                            }
                        ]
                    }
                ],
                "estimated": false,
                "eacType": "MERCHANT_TO_COURIER",
                "eacCode": "string"
            },
            "buyer": {
                "id": "string",
                "lastName": "string",
                "firstName": "string",
                "middleName": "string",
                "type": "PERSON"
            },
            "notes": "string",
            "taxSystem": "OSN",
            "cancelRequested": false,
            "expiryDate": "23-09-2022 09:12:41"
        }
    ],
    "paging": {
        "nextPageToken": "string"
    }
}

Name	Description
orders*	Type: OrderDTO[] Модель заказа. Заказ. Max items: `50`
pager	Type: FlippingPagerDTO Модель для пагинации.
paging	Type: ForwardScrollingPagerDTO Информация о страницах с результатами.

OrderDTO

Заказ.

Name

Description

buyer*

Type: OrderBuyerDTO

Информация о покупателе.

Параметры id, lastName, firstName и middleName возвращаются, только если вы работаете по модели DBS.
Информация о покупателе с базовыми полями.

buyerItemsTotalBeforeDiscount*

Type: number<decimal>

Стоимость всех товаров в заказе в валюте покупателя без учета стоимости доставки и до применения скидок по:

акциям;
купонам;
промокодам.

creationDate*

Type: string<date-dd-MM-yyyy-HH-mm-ss>

Дата и время оформления заказа.

Формат даты и времени: ДД-ММ-ГГГГ ЧЧ:ММ:СС. Часовой пояс — UTC+03:00 (Москва).

Example: 23-09-2022 09:12:41

currency*

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

delivery*

Type: OrderDeliveryDTO

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

deliveryTotal*

Type: number<decimal>

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

fake*

Type: boolean

Тип заказа:

false — настоящий заказ покупателя.
true — тестовый заказ Маркета.

id*

Type: integer<int64>

Идентификатор заказа.

items*

Type: OrderItemDTO[]

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

itemsTotal*

Type: number<decimal>

Платеж покупателя.

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 — заказ доставляется слишком долго.
TECHNICAL_ERROR — техническая ошибка на стороне Маркета. Обратитесь в поддержку.

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

taxSystem*

Type: OrderTaxSystemType

Система налогообложения (СНО) магазина на момент оформления заказа:

ECHN — единый сельскохозяйственный налог (ЕСХН).
ENVD — единый налог на вмененный доход (ЕНВД).
OSN — общая система налогообложения (ОСН).
PSN — патентная система налогообложения (ПСН).
USN — упрощенная система налогообложения (УСН).
USN_MINUS_COST — упрощенная система налогообложения, доходы, уменьшенные на величину расходов (УСН «Доходы минус расходы»).
NPD — налог на профессиональный доход (НПД).
UNKNOWN_VALUE — неизвестное значение. Используется только совместно с параметром payment-method=YANDEX.

Enum: OSN, USN, USN_MINUS_COST, ENVD, ECHN, PSN, NPD, UNKNOWN_VALUE

buyerItemsTotal

⦸

Type: number<decimal>

Этот параметр устарел

Не используйте его.

Стоимость всех товаров в заказе в валюте покупателя после применения скидок и без учета стоимости доставки.

buyerTotal

⦸

Type: number<decimal>

Этот параметр устарел

Не используйте его.

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

buyerTotalBeforeDiscount

⦸

Type: number<decimal>

Этот параметр устарел

Не используйте его.

Стоимость всех товаров в заказе в валюте покупателя до применения скидок и с учетом стоимости доставки (buyerItemsTotalBeforeDiscount + стоимость доставки).

cancelRequested

Type: boolean

Только для модели DBS

Запрошена ли отмена.

expiryDate

Type: string<date-dd-MM-yyyy-HH-mm-ss>

Дата, после которой заказ будет отменен, если не сменит статус.

Формат даты: ДД-ММ-ГГГГ.

Example: 23-09-2022 09:12:41

notes

Type: string

Комментарий к заказу.

subsidies

Type: OrderSubsidyDTO[]

Список субсидий по типам.
Общее вознаграждение партнеру за DBS-доставку и все скидки на товар:

по промокодам, купонам и акциям;
по баллам Плюса;
по доставке (DBS).

Min items: 1

updatedAt

Type: string<date-dd-MM-yyyy-HH-mm-ss>

Дата и время последнего обновления заказа.

Формат даты и времени: ДД-ММ-ГГГГ ЧЧ:ММ:СС. Часовой пояс — UTC+03:00 (Москва).

Example: 23-09-2022 09:12:41

FlippingPagerDTO

Модель для пагинации.

Name	Description
currentPage	Type: integer<int32> Текущая страница.
from	Type: integer<int32> Начальный номер найденного элемента на странице.
pageSize	Type: integer<int32> Размер страницы.
pagesCount	Type: integer<int32> Общее количество страниц.
to	Type: integer<int32> Конечный номер найденного элемента на странице.
total	Type: integer<int32> Сколько всего найдено элементов.

ForwardScrollingPagerDTO

Ссылка на следующую страницу.

Name

Description

nextPageToken

Type: string

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

OrderBuyerDTO

Информация о покупателе.

Параметры id, lastName, firstName и middleName возвращаются, только если вы работаете по модели DBS.

Name	Description
type*	Type: OrderBuyerType Тип покупателя: физическое лицо или организация. Этот параметр используется FBS- и FBY-магазинами, размещающими товары на витрине business.market.yandex.ru. Enum: `PERSON`, `BUSINESS`
firstName	Type: string Имя покупателя.
id	Type: string Идентификатор покупателя.
lastName	Type: string Фамилия покупателя.
middleName	Type: string Отчество покупателя.

CurrencyType

Коды валют. Возможные значения:

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

Type

Description

CurrencyType

OrderDeliveryDTO

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

Name

Description

dates*

Type: OrderDeliveryDatesDTO

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

deliveryPartnerType*

Type: OrderDeliveryPartnerType

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

Enum: SHOP, YANDEX_MARKET, UNKNOWN

deliveryServiceId*

Type: integer<int64>

Идентификатор службы доставки.

serviceName*

Type: string

Наименование службы доставки.

type*

Type: OrderDeliveryType

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

Enum: DELIVERY, PICKUP, POST, DIGITAL, UNKNOWN

address

Type: OrderDeliveryAddressDTO

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

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

courier

Type: OrderCourierDTO

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

dispatchType

Type: OrderDeliveryDispatchType

Способ отгрузки:

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

Enum: UNKNOWN, BUYER, MARKET_BRANDED_OUTLET, SHOP_OUTLET

eacCode

Type: string

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

eacType

Type: OrderDeliveryEacType

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

Enum: MERCHANT_TO_COURIER, COURIER_TO_MERCHANT, CHECKING_BY_MERCHANT

estimated

Type: boolean

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

⦸

Type: string

Этот параметр устарел

Не используйте его.

Идентификатор доставки, присвоенный магазином.

Указывается, только если магазин передал данный идентификатор в ответе на запрос методом POST cart.

liftPrice

Type: number<decimal>

Стоимость подъема на этаж.

liftType

Type: OrderLiftType

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

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

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

outletCode

Type: string

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

outletStorageLimitDate

Type: string<date-dd-MM-yyyy>

Формат даты: ДД-ММ-ГГГГ.

Example: 23-09-2022

price

⦸

Type: number<decimal>

Этот параметр устарел

Стоимость доставки смотрите в параметре deliveryTotal.

Стоимость доставки в валюте заказа.

region

Type: RegionDTO

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

shipments

Type: OrderShipmentDTO[]

Информация о посылках.
Список посылок.

В параметре может указываться несколько посылок.

Min items: 1

tracks

Type: OrderTrackDTO[]

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

Min items: 1

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

OrderItemDTO

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

Name

Description

buyerPrice*

Type: number<decimal>

Цена на товар в валюте покупателя. В цене уже учтены скидки по:

акциям;
купонам;
промокодам.

buyerPriceBeforeDiscount*

Type: number<decimal>

Стоимость товара в валюте покупателя до применения скидок по:

акциям;
купонам;
промокодам.

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

Название товара.

price*

Type: number<decimal>

Цена на товар в валюте заказа без учета вознаграждения партнеру за скидки по промокодам, купонам и акциям (параметр subsidies).

vat*

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

details

⦸

Type: OrderItemDetailDTO[]

Этот параметр устарел

Для получения информации о невыкупах и возвратах используйте GET campaigns/{campaignId}/returns.

Информация о невыкупленных или возвращенных товарах в заказе.
Детали по товару в заказе.

Min items: 1

instances

Type: OrderItemInstanceDTO[]

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

Возвращаются данные для маркировки, переданные в запросе PUT campaigns/{campaignId}/orders/{orderId}/identifiers.

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

Min items: 1

partnerWarehouseId

⦸

Type: string

Этот параметр устарел

Не используйте его.

Идентификатор склада в системе партнера, на который сформирован заказ.

priceBeforeDiscount

⦸

Type: number<decimal>

Этот параметр устарел

Не используйте его.

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

promos

Type: OrderItemPromoDTO[]

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

Min items: 1

requiredInstanceTypes

Type: OrderItemInstanceType[]

Список необходимых маркировок товара.
Вид маркировки товара:

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

Enum: CIS, CIS_OPTIONAL, UIN, RNPT, GTD

Min items: 1

shopSku

⦸

Type: string

Этот параметр устарел

Вместо него используйте offerId.

Ваш SKU — идентификатор товара в вашей системе.

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

subsidies

Type: OrderItemSubsidyDTO[]

Список субсидий по типам.
Общее вознаграждение партнеру за все скидки на товар:

по промокодам, купонам и акциям;
по баллам Плюса.

Min items: 1

subsidy

⦸

Type: number<decimal>

Этот параметр устарел

Вместо него используйте subsidies.

Общее вознаграждение партнеру за DBS-доставку и все скидки на товар:

по промокодам;
по купонам;
по баллам Плюса;
по акциям.

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`

OrderTaxSystemType

Система налогообложения (СНО) магазина на момент оформления заказа:

ECHN — единый сельскохозяйственный налог (ЕСХН).
ENVD — единый налог на вмененный доход (ЕНВД).
OSN — общая система налогообложения (ОСН).
PSN — патентная система налогообложения (ПСН).
USN — упрощенная система налогообложения (УСН).
USN_MINUS_COST — упрощенная система налогообложения, доходы, уменьшенные на величину расходов (УСН «Доходы минус расходы»).
NPD — налог на профессиональный доход (НПД).
UNKNOWN_VALUE — неизвестное значение. Используется только совместно с параметром payment-method=YANDEX.

Type	Description
OrderTaxSystemType	Enum: `OSN`, `USN`, `USN_MINUS_COST`, `ENVD`, `ECHN`, `PSN`, `NPD`, `UNKNOWN_VALUE`

OrderSubsidyDTO

Общее вознаграждение партнеру за DBS-доставку и все скидки на товар:

по промокодам, купонам и акциям;
по баллам Плюса;
по доставке (DBS).

Name

Description

amount*

Type: number<decimal>

Сумма субсидии.

type*

Type: OrderSubsidyType

Тип субсидии:

YANDEX_CASHBACK — скидка по подписке Яндекс Плюс.
SUBSIDY — скидка Маркета (по акциям, промокодам, купонам и т. д.)
DELIVERY — скидка за доставку (DBS).

Enum: YANDEX_CASHBACK, SUBSIDY, DELIVERY

OrderDeliveryDatesDTO

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

Name	Description
fromDate*	Type: string<date-dd-MM-yyyy> Формат даты: `ДД-ММ-ГГГГ`. Example: `23-09-2022`
fromTime	Type: string<time> Начало интервала времени доставки. Передается только совместно с параметром `type=DELIVERY`. Формат времени: 24-часовой, `ЧЧ:ММ`. В качестве минут всегда должно быть указано `00` (исключение — `23:59`). Минимальное значение: `00:00`.
realDeliveryDate	Type: string<date-dd-MM-yyyy> Формат даты: `ДД-ММ-ГГГГ`. Example: `23-09-2022`
toDate	Type: string<date-dd-MM-yyyy> Формат даты: `ДД-ММ-ГГГГ`. Example: `23-09-2022`
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`

OrderDeliveryAddressDTO

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

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 Дом или владение.
phone	Type: string Телефон получателя заказа.
postcode	Type: string Почтовый индекс. Указывается, если выбрана доставка почтой (`delivery type=POST`).
recipient	Type: string Фамилия, имя и отчество получателя заказа.
street	Type: string Улица.
subway	Type: string Станция метро.

OrderCourierDTO

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

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

OrderDeliveryEacType

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

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

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

OrderLiftType

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

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

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

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`
children	Type: RegionDTO[] Дочерние регионы. Регион доставки. Min items: `1`
parent	Type: RegionDTO Информация о родительском регионе. Указываются родительские регионы до уровня страны.

OrderShipmentDTO

Список посылок.

В параметре может указываться несколько посылок.

Name	Description
boxes	Type: OrderParcelBoxDTO[] Список грузовых мест. Информация о грузоместе. Min items: `1`
id	Type: integer<int64> Идентификатор посылки, присвоенный Маркетом.
shipmentDate	Type: string<date-dd-MM-yyyy> Формат даты: `ДД-ММ-ГГГГ`. Example: `23-09-2022`
shipmentTime	Type: string Только для модели Экспресс Время, к которому магазин должен упаковать заказ и перевести его в статус `READY_TO_SHIP`. После смены статуса за заказом приедет курьер. Поле может появиться не сразу. Запрашивайте информацию о заказе в течении 5–10 минут, пока оно не вернется. Формат времени: 24-часовой, `ЧЧ:ММ`. Если заказ сделан организацией, параметр не возвращается до согласования даты доставки.
tracks	Type: OrderTrackDTO[] Только для модели DBS Информация для отслеживания перемещений посылки. Информация о трек-номере посылки (DBS). Min items: `1`

OrderTrackDTO

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

Name

Description

deliveryServiceId*

Type: integer<int64>

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

trackCode

Type: string

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

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`

OrderItemDetailDTO

Детали по товару в заказе.

Name	Description
itemCount*	Type: integer<int64> Количество единиц товара.
itemStatus*	Type: OrderItemStatusType Невыкупленный или возвращенный товар: `REJECTED` — невыкупленный. `RETURNED` — возвращенный. Enum: `REJECTED`, `RETURNED`
updateDate*	Type: string<date-dd-MM-yyyy> Формат даты: `ДД-ММ-ГГГГ`. Example: `23-09-2022`

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-значный код) Производитель получает УИН, когда регистрирует изделие в системе контроля за оборотом драгоценных металлов и камней — ГИИС ДМДК.

OrderItemPromoDTO

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

Name	Description
subsidy*	Type: number<decimal> Вознаграждение партнеру от Маркета за товар, проданный в рамках акции.
type*	Type: OrderPromoType Тип скидки. Enum: `DIRECT_DISCOUNT`, `BLUE_SET`, `BLUE_FLASH`, `GENERIC_BUNDLE`, `MARKET_COUPON`, `MARKET_PROMOCODE`, `MARKET_BLUE`, `MARKET_COIN`, `PRICE_DROP_AS_YOU_SHOP`, `SECRET_SALE`, `CHEAPEST_AS_GIFT`, `CASHBACK`, `SPREAD_DISCOUNT_COUNT`, `SPREAD_DISCOUNT_RECEIPT`, `DISCOUNT_BY_PAYMENT_TYPE`, `PERCENT_DISCOUNT`, `DCO_EXTRA_DISCOUNT`, `UNKNOWN`
discount	Type: number<decimal> Размер пользовательской скидки в валюте покупателя.
marketPromoId	Type: string Идентификатор акции в рамках соглашения на оказание услуг по продвижению сервиса между Маркетом и партнером.
shopPromoId	Type: string Идентификатор акции поставщика.

OrderItemInstanceType

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

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

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

OrderItemSubsidyDTO

Общее вознаграждение партнеру за все скидки на товар:

по промокодам, купонам и акциям;
по баллам Плюса.

Name

Description

amount*

Type: number<decimal>

Сумма субсидии.

type*

Type: OrderItemSubsidyType

Тип субсидии:

YANDEX_CASHBACK — скидка по подписке Яндекс Плюс.
SUBSIDY — скидка Маркета (по акциям, промокодам, купонам и т. д.).

Enum: YANDEX_CASHBACK, SUBSIDY

OrderItemTagType

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

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

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

OrderSubsidyType

Тип субсидии:

YANDEX_CASHBACK — скидка по подписке Яндекс Плюс.
SUBSIDY — скидка Маркета (по акциям, промокодам, купонам и т. д.)
DELIVERY — скидка за доставку (DBS).

Type	Description
OrderSubsidyType	Enum: `YANDEX_CASHBACK`, `SUBSIDY`, `DELIVERY`

GpsDTO

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

Name

Description

latitude*

Type: number<decimal>

Широта.

longitude*

Type: number<decimal>

Долгота.

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`

OrderParcelBoxDTO

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

Name

Description

fulfilmentId*

Type: string

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

id*

Type: integer<int64>

Идентификатор грузоместа.

OrderItemStatusType

Невыкупленный или возвращенный товар:

REJECTED — невыкупленный.
RETURNED — возвращенный.

Type	Description
OrderItemStatusType	Enum: `REJECTED`, `RETURNED`

OrderPromoType

Тип скидки:

DIRECT_DISCOUNT — прямая скидка, которую устанавливает продавец или Маркет.
BLUE_SET — комплекты.
BLUE_FLASH — флеш-акция.
MARKET_COUPON — скидка по промокоду Маркета.
MARKET_PROMOCODE — скидка по промокоду магазина.
MARKET_BLUE — скидка на Маркете.
CHEAPEST_AS_GIFT — самый дешевый товар в подарок.
CASHBACK — кешбэк.
SPREAD_DISCOUNT_COUNT — скидка за количество одинаковых товаров.
SPREAD_DISCOUNT_RECEIPT — скидка от суммы чека.
DISCOUNT_BY_PAYMENT_TYPE — прямая скидка при оплате картой Плюса.
PERCENT_DISCOUNT — прямая скидка в процентах.
DCO_EXTRA_DISCOUNT — дополнительная скидка, необходимая для расчета субсидии от Маркета.
UNKNOWN — неизвестный тип.

Устаревшие типы:

GENERIC_BUNDLE.
MARKET_COIN.
PRICE_DROP_AS_YOU_SHOP.
SECRET_SALE.

Type	Description
OrderPromoType	Enum: `DIRECT_DISCOUNT`, `BLUE_SET`, `BLUE_FLASH`, `GENERIC_BUNDLE`, `MARKET_COUPON`, `MARKET_PROMOCODE`, `MARKET_BLUE`, `MARKET_COIN`, `PRICE_DROP_AS_YOU_SHOP`, `SECRET_SALE`, `CHEAPEST_AS_GIFT`, `CASHBACK`, `SPREAD_DISCOUNT_COUNT`, `SPREAD_DISCOUNT_RECEIPT`, `DISCOUNT_BY_PAYMENT_TYPE`, `PERCENT_DISCOUNT`, `DCO_EXTRA_DISCOUNT`, `UNKNOWN`

OrderItemSubsidyType

Тип субсидии:

YANDEX_CASHBACK — скидка по подписке Яндекс Плюс.
SUBSIDY — скидка Маркета (по акциям, промокодам, купонам и т. д.).

Type	Description
OrderItemSubsidyType	Enum: `YANDEX_CASHBACK`, `SUBSIDY`

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

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

Об одном заказе

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