- Request
- Responses
- 200 OK
- Body
- OrderPaymentType
- OrderPaymentMethodType
- ShopSku
- CurrencyType
- CurrencyValueDTO
- OrderVatType
- ItemPriceDTO
- CountryCode
- OrderItemInstanceDTO
- OrderItemInstanceType
- OrderItemTagType
- BusinessOrderItemDTO
- DeliveryPriceDTO
- OrderPriceDTO
- OrderDeliveryType
- OrderDeliveryPartnerType
- OrderDeliveryDispatchType
- BusinessOrderDeliveryDatesDTO
- BusinessOrderShipmentDTO
- GpsDTO
- BusinessOrderDeliveryAddressDTO
- RegionType
- RegionDTO
- BusinessOrderCourierDeliveryDTO
- LogisticPointId
- BusinessOrderPickupDeliveryDTO
- OrderCourierDTO
- OrderDeliveryEacType
- BusinessOrderEacDTO
- BusinessOrderTransferDTO
- BusinessOrderBoxLayoutPartialCountDTO
- Cis
- BriefOrderItemInstanceDTO
- BusinessOrderBoxLayoutItemDTO
- BusinessOrderBoxLayoutDTO
- OrderTrackDTO
- BusinessOrderDeliveryDTO
- OrderLiftType
- BusinessOrderServicesDTO
- OrderBuyerType
- BusinessOrderDTO
- ForwardScrollingPagerDTO
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 420 Method Failure
- 500 Internal Server Error
Информация о заказах в кабинете
Метод доступен для моделей: FBY, FBS, Экспресс и DBS.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- inventory-and-order-processing — Обработка заказов и учёт товаров
- inventory-and-order-processing:read-only — Просмотр информации о заказах
- finance-and-accounting — Просмотр финансовой информации и отчётности
- all-methods — Полное управление кабинетом
- all-methods:read-only — Просмотр всех данных
Возвращает информацию о заказах в кабинете. Запрос можно использовать для отслеживания заказов и их статусов.
Вы также можете настроить API-уведомления
Маркет отправит вам запрос, когда появится новый заказ или изменится его статус. А полную информацию можно получить с помощью этого метода.
Доступна фильтрация по параметрам:
-
дата оформления заказа;
-
дата и время обновления заказа;
-
дата отгрузки;
-
статусы заказов (
statuses); -
этапы обработки или причины отмены (
substatuses); -
идентификаторы кампаний;
-
идентификаторы заказов;
-
внешние идентификаторы заказов;
-
тип заказа (настоящий или тестовый);
-
модели размещения;
-
наличие запросов от покупателей на отмену заказа.
Максимальный диапазон дат за один запрос — 30 дней (передается в параметрах fromDate и toDate). Если их не передать, возвращается информация за последние 30 дней.
Результаты возвращаются постранично. Для навигации используйте параметры page_token и limit.
Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET v2/campaigns/{campaignId}/orders/{orderId}/buyer.
Ограничение для параметра limit
Не передавайте значение больше 50.
| ⚙️ Лимит: 10 000 запросов в час |
|---|
Request
POST
https://api.partner.market.yandex.ru/v1/businesses/{businessId}/orders
Path parameters
|
Name |
Description |
|
businessId |
Type: integer Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns. ℹ️ Что такое кабинет и магазин на Маркете Min value: |
Query parameters
|
Name |
Description |
|
limit |
Type: integer Количество значений на одной странице. Min value: |
|
page_token |
Type: string Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуем передавать значение выходного параметра Если задан Example: |
Body
application/json
{
"orderIds": [
0
],
"externalOrderIds": [
"example"
],
"programTypes": [
"FBY"
],
"campaignIds": [
1
],
"statuses": [
"PLACING"
],
"substatuses": [
"RESERVATION_EXPIRED"
],
"dates": {
"creationDateFrom": "2025-01-01",
"creationDateTo": "2025-01-01",
"shipmentDateFrom": "2025-01-01",
"shipmentDateTo": "2025-01-01",
"updateDateFrom": "2025-01-01T00:00:00Z",
"updateDateTo": "2025-01-01T00:00:00Z"
},
"fake": true,
"waitingForCancellationApprove": true
}
|
Name |
Description |
|
campaignIds |
Type: CampaignId[] | null Идентификаторы кампаний магазинов. Min items: Max items: Unique items: Example
|
|
dates |
Type: OrderDatesFilterDTO Даты заказов. Фильтр по датам заказов. Example
|
|
externalOrderIds |
Type: ExternalOrderId[] | null Внешние идентификаторы заказов. Min items: Max items: Unique items: Example
|
|
fake |
Type: boolean Тип заказа:
|
|
orderIds |
Type: integer[] | null Идентификаторы заказов. Min items: Max items: Unique items: Example
|
|
programTypes |
Type: SellingProgramType[] | null Модели работы магазина на Маркете. Min items: Unique items: Example
|
|
statuses |
Type: OrderStatusType[] | null Статусы заказов. Min items: Unique items: Example
|
|
substatuses |
Type: OrderSubstatusType[] | null Этапы обработки или причины отмены заказов. Min items: Unique items: Example
|
|
waitingForCancellationApprove |
Type: boolean Только для модели DBS Фильтр для получения заказов, по которым есть запросы на отмену. При значении |
ExternalOrderId
Внешний идентификатор заказа, который вы передали в POST v2/campaigns/{campaignId}/orders/{orderId}/external-id.
Type: string
Min length: 1
Example: example
SellingProgramType
Модель работы:
FBY— FBY.FBS— FBS.DBS— DBS.EXPRESS— Экспресс.
Type: string
Enum: FBY, FBS, DBS, EXPRESS, LAAS
CampaignId
Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.
Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:
- блок Идентификатор кампании;
- вкладка Лог запросов → выпадающий список в блоке Показывать логи.
⚠️ Не путайте его с:
- идентификатором магазина, который отображается в личном кабинете продавца;
- рекламными кампаниями.
Type: integer
Min value: 1
OrderStatusType
Статус заказа:
-
PLACING— оформляется, подготовка к резервированию. -
RESERVED— зарезервирован, но недооформлен. -
UNPAID— оформлен, но еще не оплачен (если выбрана оплата при оформлении). -
PROCESSING— находится в обработке. -
DELIVERY— передан в службу доставки. -
PICKUP— доставлен в пункт выдачи. -
DELIVERED— получен покупателем. -
CANCELLED— отменен. -
PENDING— ожидает обработки со стороны продавца. -
PARTIALLY_RETURNED— возвращен частично. -
RETURNED— возвращен полностью. -
UNKNOWN— неизвестный статус.
Также могут возвращаться другие значения. Обрабатывать их не нужно.
Type: string
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: string
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, CUSTOMS_FAILED_MARKET, CUSTOMS_FAILED_USER_COMMERCIAL_ITEMS, CUSTOMS_FAILED_USER_DUTY_NOT_PAID, CUSTOMS_FAILED_USER_INVALID_PERSONAL_DATA, CUSTOMS_FAILED_USER_ADDITIONAL_DATA_NOT_PROVIDED, UNKNOWN
OrderDatesFilterDTO
Фильтр по датам заказов.
|
Name |
Description |
|
creationDateFrom |
Type: string<date> Начальная дата оформления заказа (ГГГГ-ММ-ДД). Example: |
|
creationDateTo |
Type: string<date> Конечная дата оформления заказа (ГГГГ-ММ-ДД). Example: |
|
shipmentDateFrom |
Type: string<date> Начальная дата отгрузки (ГГГГ-ММ-ДД). Example: |
|
shipmentDateTo |
Type: string<date> Конечная дата отгрузки (ГГГГ-ММ-ДД). Example: |
|
updateDateFrom |
Type: string<date-time> Начальная дата обновления заказа (ISO 8601). Example: |
|
updateDateTo |
Type: string<date-time> Конечная дата обновления заказа (ISO 8601). Example: |
Example
{
"creationDateFrom": "2025-01-01",
"creationDateTo": "2025-01-01",
"shipmentDateFrom": "2025-01-01",
"shipmentDateTo": "2025-01-01",
"updateDateFrom": "2025-01-01T00:00:00Z",
"updateDateTo": "2025-01-01T00:00:00Z"
}
OrderSourcePlatformType
Площадка-источник заказа:
-
MARKET— заказ, оформленный на Маркете. -
OZON— LaaS-заказ, оформленный на Ozon. -
WILDBERRIES— LaaS-заказ, оформленный на Wildberries. -
OTHER— LaaS-заказ, созданный продавцом.
Type: string
Enum: MARKET, OZON, WILDBERRIES, OTHER
Responses
200 OK
Список заказов в кабинете.
Body
application/json
{
"orders": [
{
"orderId": 0,
"campaignId": 1,
"programType": "FBY",
"externalOrderId": "example",
"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": true,
"items": [
{
"id": 0,
"offerId": "example",
"offerName": "example",
"count": 0,
"prices": {},
"instances": [
null
],
"requiredInstanceTypes": [
null
],
"tags": [
null
]
}
],
"prices": {
"payment": {
"value": 0.5,
"currencyId": "RUR"
},
"subsidy": null,
"cashback": null,
"delivery": {
"payment": null,
"subsidy": null,
"vat": "NO_VAT"
}
},
"delivery": {
"type": "DELIVERY",
"serviceName": "example",
"deliveryServiceId": 0,
"warehouseId": "example",
"deliveryPartnerType": "SHOP",
"dispatchType": "UNKNOWN",
"dates": {
"fromDate": "2025-01-01",
"toDate": "2025-01-01",
"fromTime": "12:00:00",
"toTime": "12:00:00",
"realDeliveryDate": "2025-01-01"
},
"shipment": {
"id": 0,
"shipmentDate": "2025-01-01",
"shipmentTime": "12:00:00"
},
"courier": {
"address": {},
"region": {}
},
"pickup": {
"address": null,
"region": null,
"logisticPointId": 1,
"outletCode": "example",
"outletStorageLimitDate": "2025-01-01"
},
"transfer": {
"courier": {},
"eac": {}
},
"boxesLayout": [
{}
],
"tracks": [
{}
],
"estimated": true
},
"services": {
"liftType": "NOT_NEEDED"
},
"buyerType": "PERSON",
"notes": "example",
"cancelRequested": true
}
],
"paging": {
"nextPageToken": "example"
}
}
|
Name |
Description |
|
orders |
Type: BusinessOrderDTO[] Список заказов в кабинете. Max items: Example
|
|
paging |
Type: ForwardScrollingPagerDTO Информация о страницах результатов. Идентификатор следующей страницы. Example
|
OrderPaymentType
Тип оплаты заказа:
-
PREPAID— оплата при оформлении заказа. -
POSTPAID— оплата при получении заказа. -
UNKNOWN— неизвестный тип.
Если параметр отсутствует, заказ будет оплачен при получении.
Type: string
Enum: PREPAID, POSTPAID, UNKNOWN
OrderPaymentMethodType
Способ оплаты заказа:
-
Значения, если выбрана оплата при оформлении заказа (
"paymentType": "PREPAID"):-
YANDEX— банковской картой. -
APPLE_PAY— Apple Pay (не используется). -
GOOGLE_PAY— Google Pay (не используется). -
CREDIT— в кредит. -
TINKOFF_CREDIT— в кредит в Тинькофф Банке. -
TINKOFF_INSTALLMENTS— рассрочка в Тинькофф Банке. -
EXTERNAL_CERTIFICATE— подарочным сертификатом (например, из приложения «Сбербанк Онлайн»). -
SBP— через систему быстрых платежей. -
B2B_ACCOUNT_PREPAYMENT— заказ оплачивает организация. -
MICROCREDIT- Сплит на основе МКК (Микрокредитной компании). -
BNPL_TBYB- Оплата после доставки на основе Сплита.
-
-
Значения, если выбрана оплата при получении заказа (
"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: string
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, MICROCREDIT, BNPL_TBYB, UNKNOWN
ShopSku
Ваш SKU — идентификатор товара в вашей системе.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.
Важно
Пробельные символы в начале и конце значения автоматически удаляются. Например, " SKU123 " и "SKU123" будут обработаны как одинаковые значения.
Что такое SKU и как его назначать
Type: string
Min length: 1
Max length: 255
Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$
Example: example
CurrencyType
Коды валют:
RUR— российский рубль.UAH— украинская гривна.BYR— белорусский рубль.KZT— казахстанский тенге.UZS— узбекский сум.
Type: string
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
CurrencyValueDTO
Валюта и ее значение.
|
Name |
Description |
|
currencyId |
Type: CurrencyType Валюта. Коды валют:
Enum: |
|
value |
Type: number Значение. |
Example
{
"value": 0.5,
"currencyId": "RUR"
}
OrderVatType
НДС на товар или доставку:
-
NO_VAT— НДС не облагается, используется только для отдельных видов услуг. -
VAT_0— НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров. -
VAT_10— НДС 10%. Например, используется при реализации отдельных продовольственных и медицинских товаров. -
VAT_10_110— НДС 10/110. НДС 10%, применяется только при предоплате. -
VAT_20— НДС 20%. Основной НДС с 2019 года до 1 января 2026 года. -
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%. НДС для упрощенной системы налогообложения (УСН). -
VAT_22— НДС 22%. Основной НДС с 1 января 2026 года. -
UNKNOWN_VALUE— неизвестный тип.
Type: string
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, VAT_22, UNKNOWN_VALUE
ItemPriceDTO
Информация о выплатах и вознаграждениях.
Как рассчитывается стоимость всех единиц товара и вознаграждение продавцу
- Стоимость всех единиц товара складывается из параметров
paymentиcashback. - Общая сумма вознаграждений продавцу возвращается в параметре
subsidy. - Значение
payment,cashbackиsubsidyможет отличаться от стоимости в каталоге, потому что информация об акциях магазина не возвращается. - Если в заказе несколько единиц товаров, в параметрах возвращается суммарное значение.
- Все суммы указаны в валюте магазина.
|
Name |
Description |
|
cashback |
Type: CurrencyValueDTO Сумма, которая оплачена баллами Плюса. Валюта и ее значение. Example
|
|
payment |
Type: CurrencyValueDTO Общая стоимость всех единиц товара. Валюта и ее значение. Example
|
|
subsidy |
Type: CurrencyValueDTO Общая сумма вознаграждений продавцу. Валюта и ее значение. Example
|
|
vat |
Type: OrderVatType НДС на товар. НДС на товар или доставку:
Enum: |
Example
{
"payment": {
"value": 0.5,
"currencyId": "RUR"
},
"subsidy": null,
"cashback": null,
"vat": "NO_VAT"
}
CountryCode
Страна производства в формате ISO 3166-1 alpha-2. Как получить
Type: string
Min length: 2
Max length: 2
Pattern: ^[A-Z]{2}$
Example: RU
OrderItemInstanceDTO
Переданные для данной позиции коды маркировки или УИНы. Коды «Честного знака» возвращаются в двух вариантах — с криптохвостом и без.
|
Name |
Description |
|
cis |
Type: string Код идентификации единицы товара в системе «Честный ЗНАК» без криптохвоста или «ASL BELGISI» (для продавцов Market Yandex Go). Example: |
|
cisFull |
Type: string Код идентификации единицы товара в системе «Честный ЗНАК» с криптохвостом. Example: |
|
countryCode |
Type: CountryCode Страна производства в формате ISO 3166-1 alpha-2. Как получить Min length: Max length: Pattern: Example: |
|
gtd |
Type: string Грузовая таможенная декларация. Представляет собой строку из трех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на ввезенные товары. Далее — дата и номер декларации. Example: |
|
rnpt |
Type: string Регистрационный номер партии товара. Представляет собой строку из четырех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ/ХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на партию товара. Далее — дата, номер декларации и номер маркированного товара в декларации. Example: |
|
uin |
Type: string УИН ювелирного изделия (16-значный код) Производитель получает УИН, когда регистрирует изделие в системе контроля за оборотом драгоценных металлов и камней — ГИИС ДМДК. Example: |
Example
{
"cis": "example",
"cisFull": "example",
"uin": "example",
"rnpt": "example",
"gtd": "example",
"countryCode": "RU"
}
OrderItemInstanceType
Вид маркировки товара:
-
CIS— КИЗ, идентификатор единицы товара в системе «Честный ЗНАК» или «ASL BELGISI» (для продавцов Market Yandex Go). Обязателен для заполнения. -
CIS_OPTIONAL— КИЗ, идентификатор единицы товара в системе «Честный ЗНАК». Необязателен для заполнения, но в ближайшее время потребуется его передача. -
UIN— УИН, уникальный идентификационный номер. -
RNPT— РНПТ, регистрационный номер партии товара. -
GTD— номер ГТД, грузовой таможенной декларации.
Type: string
Enum: CIS, CIS_OPTIONAL, UIN, RNPT, GTD
OrderItemTagType
Признак товара:
ULTIMA— премиум-товар.SAFE_TAG— товар с защитной меткой.TURBO— товар, который быстро раскупают (Устаревший тип).
Type: string
Enum: ULTIMA, SAFE_TAG, TURBO
BusinessOrderItemDTO
Информация о товаре.
|
Name |
Description |
|
count |
Type: integer Количество единиц товара. |
|
id |
Type: integer Идентификатор товара в заказе. Позволяет идентифицировать товар в рамках заказа. |
|
offerId |
Type: ShopSku Идентификатор товарного предложения. Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU:
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Важно Пробельные символы в начале и конце значения автоматически удаляются. Например, Что такое SKU и как его назначать Min length: Max length: Pattern: Example: |
|
offerName |
Type: string Название товара. Example: |
|
instances |
Type: OrderItemInstanceDTO[] | null Информация о маркировке единиц товара. Возвращаются данные для маркировки, переданные в запросе:
Для FBY возвращаются коды маркировки, переданные во время поставки. Если магазин еще не передавал коды для этого заказа, Min items: Example
|
|
prices |
Type: ItemPriceDTO Информация о выплатах и вознаграждениях. Информация о выплатах и вознаграждениях. Как рассчитывается стоимость всех единиц товара и вознаграждение продавцу
Example
|
|
requiredInstanceTypes |
Type: OrderItemInstanceType[] | null Список необходимых маркировок товара. Min items: Unique items: Example
|
|
tags |
Type: OrderItemTagType[] | null Признаки товара. Min items: Unique items: Example
|
Example
{
"id": 0,
"offerId": "example",
"offerName": "example",
"count": 0,
"prices": {
"payment": {
"value": 0.5,
"currencyId": "RUR"
},
"subsidy": null,
"cashback": null,
"vat": "NO_VAT"
},
"instances": [
{
"cis": "example",
"cisFull": "example",
"uin": "example",
"rnpt": "example",
"gtd": "example",
"countryCode": "RU"
}
],
"requiredInstanceTypes": [
"CIS"
],
"tags": [
"ULTIMA"
]
}
DeliveryPriceDTO
Информация о стоимости доставки, включая подъем на этаж.
Как рассчитывается стоимость доставки
- Стоимость доставки складывается из параметров
paymentиsubsidy. - Все суммы указаны в валюте магазина.
|
Name |
Description |
|
payment |
Type: CurrencyValueDTO Платеж покупателя за доставку. Валюта и ее значение. Example
|
|
subsidy |
Type: CurrencyValueDTO Вознаграждение Маркета за доставку. Валюта и ее значение. Example
|
|
vat |
Type: OrderVatType НДС на доставку. НДС на товар или доставку:
Enum: |
Example
{
"payment": {
"value": 0.5,
"currencyId": "RUR"
},
"subsidy": null,
"vat": "NO_VAT"
}
OrderPriceDTO
Информация о стоимости заказа.
Как рассчитывается стоимость заказа, доставки и вознаграждение продавцу
- Стоимость товаров в заказе складывается из параметров
paymentиcashback. - Общая сумма вознаграждений продавцу возвращается в параметре
subsidy. - Значение
payment,cashbackиsubsidyможет отличаться от стоимости в каталоге, потому что информация об акциях магазина не возвращается. - Стоимость доставки складывается из параметров
paymentиsubsidyвdelivery. - Все суммы указаны в валюте магазина.
|
Name |
Description |
|
cashback |
Type: CurrencyValueDTO Сумма, которая оплачена баллами Плюса. Возвращается баллами. Валюта и ее значение. Example
|
|
delivery |
Type: DeliveryPriceDTO Информация о стоимости доставки, включая подъем на этаж. Информация о стоимости доставки, включая подъем на этаж. Как рассчитывается стоимость доставки
Example
|
|
payment |
Type: CurrencyValueDTO Сумма платежа покупателя. Валюта и ее значение. Example
|
|
subsidy |
Type: CurrencyValueDTO Общая сумма вознаграждений продавцу. Валюта и ее значение. Example
|
Example
{
"payment": {
"value": 0.5,
"currencyId": "RUR"
},
"subsidy": null,
"cashback": null,
"delivery": {
"payment": null,
"subsidy": null,
"vat": "NO_VAT"
}
}
OrderDeliveryType
Способ доставки заказа:
-
DELIVERY— курьерская доставка. -
PICKUP— самовывоз. -
POST— почта. -
DIGITAL— для цифровых товаров. -
UNKNOWN— неизвестный тип.
Type: string
Enum: DELIVERY, PICKUP, POST, DIGITAL, UNKNOWN
OrderDeliveryPartnerType
Тип сотрудничества со службой доставки в рамках конкретного заказа:
-
SHOP— магазин работает со службой доставки напрямую или доставляет заказы самостоятельно. -
YANDEX_MARKET— магазин работает со службой доставки через Маркет. -
UNKNOWN— неизвестный тип.
Type: string
Enum: SHOP, YANDEX_MARKET, UNKNOWN
OrderDeliveryDispatchType
Способ доставки:
-
BUYER— курьерская доставка покупателю. -
MARKET_BRANDED_OUTLET— доставка в пункт выдачи заказов Маркета. -
SHOP_OUTLET— доставка в пункт выдачи заказов магазина. -
UNKNOWN— неизвестный тип.
Type: string
Enum: UNKNOWN, BUYER, MARKET_BRANDED_OUTLET, SHOP_OUTLET
BusinessOrderDeliveryDatesDTO
Диапазон дат доставки.
|
Name |
Description |
|
fromDate |
Type: string<date> Ближайшая дата доставки. Формат даты: Example: |
|
fromTime |
Type: string<time> Начало интервала времени доставки. Передается только вместе с параметром Формат времени: 24-часовой, Минимальное значение: Example: |
|
realDeliveryDate |
Type: string<date> Дата, когда товар доставлен до пункта выдачи заказа (в случае самовывоза) или до покупателя (если заказ доставляет курьер). Формат даты: Example: |
|
toDate |
Type: string<date> Самая поздняя дата доставки. Если Формат даты: Example: |
|
toTime |
Type: string<time> Конец интервала времени доставки. Передается только вместе с параметром Формат времени: 24-часовой, Максимальное значение: Example: |
Example
{
"fromDate": "2025-01-01",
"toDate": "2025-01-01",
"fromTime": "12:00:00",
"toTime": "12:00:00",
"realDeliveryDate": "2025-01-01"
}
BusinessOrderShipmentDTO
Информация об отгрузке заказа.
|
Name |
Description |
|
shipmentDate |
Type: string<date> Дата отгрузки. Формат даты: Example: |
|
id |
Type: integer | null Идентификатор отгрузки. |
|
shipmentTime |
Type: string<time> | null Время отгрузки. Example: |
Example
{
"id": 0,
"shipmentDate": "2025-01-01",
"shipmentTime": "12:00:00"
}
GpsDTO
GPS-координаты широты и долготы.
|
Name |
Description |
|
latitude |
Type: number Широта. |
|
longitude |
Type: number Долгота. |
Example
{
"latitude": 0.5,
"longitude": 0.5
}
BusinessOrderDeliveryAddressDTO
Адрес доставки.
Указывается, если параметр type принимает значение DELIVERY, POST или PICKUP (только для модели DBS). Если type=PICKUP, возвращается адрес пункта выдачи.
|
Name |
Description |
|
apartment |
Type: string Номер квартиры или офиса. Example: |
|
block |
Type: string Корпус. Example: |
|
city |
Type: string Город или населенный пункт. Example: |
|
country |
Type: string Страна. Example: |
|
district |
Type: string Район. Example: |
|
entrance |
Type: string Номер подъезда. Example: |
|
entryphone |
Type: string Код домофона. Example: |
|
floor |
Type: string Этаж. Example: |
|
gps |
Type: GpsDTO GPS-координаты. GPS-координаты широты и долготы. Example
|
|
house |
Type: string Номер дома. Example: |
|
postcode |
Type: string Почтовый индекс. Example: |
|
street |
Type: string Улица. Example: |
|
subway |
Type: string Станция метро. Example: |
Example
{
"country": "example",
"postcode": "example",
"city": "example",
"district": "example",
"subway": "example",
"street": "example",
"house": "example",
"block": "example",
"entrance": "example",
"entryphone": "example",
"floor": "example",
"apartment": "example",
"gps": {
"latitude": 0.5,
"longitude": 0.5
}
}
RegionType
Тип региона.
Возможные значения:
-
CITY_DISTRICT— район города. -
CITY— крупный город. -
CONTINENT— континент. -
COUNTRY_DISTRICT— область. -
COUNTRY— страна. -
REGION— регион. -
REPUBLIC_AREA— район субъекта федерации. -
REPUBLIC— субъект федерации. -
SUBWAY_STATION— станция метро. -
VILLAGE— город. -
OTHER— неизвестный регион.
Type: string
Enum: OTHER, CONTINENT, REGION, COUNTRY, COUNTRY_DISTRICT, REPUBLIC, CITY, VILLAGE, CITY_DISTRICT, SUBWAY_STATION, REPUBLIC_AREA
RegionDTO
Регион доставки.
|
Name |
Description |
|
id |
Type: integer Идентификатор региона. |
|
name |
Type: string Название региона. Example: |
|
type |
Type: RegionType Тип региона. Тип региона. Возможные значения:
Enum: |
|
parent |
Type: RegionDTO Информация о родительском регионе. Указываются родительские регионы до уровня страны. Регион доставки. Example
|
Example
{
"id": 0,
"name": "example",
"type": "OTHER",
"parent": {
"id": 0,
"name": "example",
"type": null,
"parent": null
}
}
BusinessOrderCourierDeliveryDTO
Информация о курьерской доставке.
|
Name |
Description |
|
address |
Type: BusinessOrderDeliveryAddressDTO Адрес доставки. Указывается, если параметр Example
|
|
region |
Type: RegionDTO Регион доставки. Example
|
Example
{
"address": {
"country": "example",
"postcode": "example",
"city": "example",
"district": "example",
"subway": "example",
"street": "example",
"house": "example",
"block": "example",
"entrance": "example",
"entryphone": "example",
"floor": "example",
"apartment": "example",
"gps": {
"latitude": 0.5,
"longitude": 0.5
}
},
"region": {
"id": 0,
"name": "example",
"type": "OTHER",
"parent": null
}
}
LogisticPointId
Идентификатор пункта выдачи.
Его можно узнать с помощью метода POST v1/businesses/{businessId}/logistics-points.
Type: integer
Min value: 1
BusinessOrderPickupDeliveryDTO
Информация о доставке в пункт выдачи.
|
Name |
Description |
|
address |
Type: BusinessOrderDeliveryAddressDTO Адрес доставки. Указывается, если параметр Example
|
|
logisticPointId |
Type: LogisticPointId Идентификатор пункта выдачи. Его можно узнать с помощью метода POST v1/businesses/{businessId}/logistics-points. Min value: Example: |
|
outletCode |
Type: string Идентификатор пункта самовывоза, присвоенный магазином. Example: |
|
outletStorageLimitDate |
Type: string<date> Дата, до которой заказ будет храниться в пункте выдачи. Возвращается, когда заказ переходит в статус Один раз дату можно поменять с помощью метода PUT v2/campaigns/{campaignId}/orders/{orderId}/delivery/storage-limit. Формат даты: Example: |
|
region |
Type: RegionDTO Регион доставки. Example
|
Example
{
"address": {
"country": "example",
"postcode": "example",
"city": "example",
"district": "example",
"subway": "example",
"street": "example",
"house": "example",
"block": "example",
"entrance": "example",
"entryphone": "example",
"floor": "example",
"apartment": "example",
"gps": {
"latitude": 0.5,
"longitude": 0.5
}
},
"region": {
"id": 0,
"name": "example",
"type": "OTHER",
"parent": null
},
"logisticPointId": 1,
"outletCode": "example",
"outletStorageLimitDate": "2025-01-01"
}
OrderCourierDTO
Информация о курьере.
|
Name |
Description |
|
fullName |
Type: string Полное имя. Example: |
|
phone |
Type: string Номер телефона. Example: |
|
phoneExtension |
Type: string Добавочный номер телефона. Example: |
|
vehicleDescription |
Type: string Описание транспортного средства. Например, модель и цвет. Example: |
|
vehicleNumber |
Type: string Номер транспортного средства. Example: |
Example
{
"fullName": "example",
"phone": "example",
"phoneExtension": "example",
"vehicleNumber": "example",
"vehicleDescription": "example"
}
OrderDeliveryEacType
Тип кода подтверждения ЭАПП:
-
MERCHANT_TO_COURIER(временно не возвращается) — продавец передает код курьеру для получения невыкупа. -
COURIER_TO_MERCHANT— курьер передает код продавцу для получения заказа. -
CHECKING_BY_MERCHANT— продавец проверяет код на своей стороне.
Type: string
Enum: MERCHANT_TO_COURIER, COURIER_TO_MERCHANT, CHECKING_BY_MERCHANT
BusinessOrderEacDTO
Информация о коде подтверждения.
|
Name |
Description |
|
eacType |
Type: OrderDeliveryEacType Тип кода подтверждения ЭАПП. Тип кода подтверждения ЭАПП:
Enum: |
|
eacCode |
Type: string Код подтверждения ЭАПП (для типа Example: |
Example
{
"eacType": "MERCHANT_TO_COURIER",
"eacCode": "example"
}
BusinessOrderTransferDTO
Информация о курьере и код подтверждения.
|
Name |
Description |
|
courier |
Type: OrderCourierDTO Информация о курьере. Example
|
|
eac |
Type: BusinessOrderEacDTO Информация о коде подтверждения. Example
|
Example
{
"courier": {
"fullName": "example",
"phone": "example",
"phoneExtension": "example",
"vehicleNumber": "example",
"vehicleDescription": "example"
},
"eac": {
"eacType": "MERCHANT_TO_COURIER",
"eacCode": "example"
}
}
BusinessOrderBoxLayoutPartialCountDTO
Информация о части товара в коробке.
|
Name |
Description |
|
current |
Type: integer Номер части, начиная с 1. Min value: |
|
total |
Type: integer На сколько всего частей разделен товар. Min value: |
Example
{
"current": 1,
"total": 2
}
Cis
Код идентификации единицы товара в системе «Честный ЗНАК» или «ASL BELGISI» (для продавцов Market Yandex Go).
Не экранируйте косую черту в коде символа-разделителя \u001d
✅ 01030410947874432155Qbag!\u001d93Zjqw
❌ 01030410947874432155Qbag!\\u001d93Zjqw
Косые черты и кавычки в других местах экранируйте по правилам JSON: \\ и \"
Type: string
Example: example
BriefOrderItemInstanceDTO
Идентификатор единицы товара.
Заполните только одно поле в зависимости от того, в какой системе маркирован товар.
Подробно о работе с маркируемыми товарами читайте в Справке Маркета для продавцов.
|
Name |
Description |
|
cis |
Type: Cis Код идентификации единицы товара в системе «Честный ЗНАК» или «ASL BELGISI» (для продавцов Market Yandex Go). Не экранируйте косую черту в коде символа-разделителя ✅ ❌ Косые черты и кавычки в других местах экранируйте по правилам JSON: Example: |
|
countryCode |
Type: CountryCode Страна производства в формате ISO 3166-1 alpha-2. Как получить Min length: Max length: Pattern: Example: |
|
gtd |
Type: string Грузовая таможенная декларация. Представляет собой строку из трех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на ввезенные товары. Далее — дата и номер декларации. Example: |
|
rnpt |
Type: string Регистрационный номер партии товара. Представляет собой строку из четырех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ/ХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на партию товара. Далее — дата, номер декларации и номер маркированного товара в декларации. Example: |
|
uin |
Type: string Уникальный идентификационный номер ювелирного изделия. Представляет собой число из 16 цифр. Example: |
Example
{
"cis": "example",
"uin": "example",
"rnpt": "example",
"gtd": "example",
"countryCode": "RU"
}
BusinessOrderBoxLayoutItemDTO
Информация о товаре в коробке.
|
Name |
Description |
|
id |
Type: integer Идентификатор товара в заказе. Параметр |
|
fullCount |
Type: integer Количество единиц товара в коробке. Min value: |
|
instances |
Type: BriefOrderItemInstanceDTO[] | null Переданные коды маркировки. Min items: Example
|
|
partialCount |
Type: BusinessOrderBoxLayoutPartialCountDTO Информация о части товара в коробке. Информация о части товара в коробке. Example
|
Example
{
"id": 0,
"fullCount": 1,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "example",
"uin": "example",
"rnpt": "example",
"gtd": "example",
"countryCode": "RU"
}
]
}
BusinessOrderBoxLayoutDTO
Информация о коробке (для заказов в кабинете).
|
Name |
Description |
|
barcode |
Type: string Идентификатор грузового места в системе магазина. Example: |
|
boxId |
Type: integer Идентификатор коробки. |
|
items |
Type: BusinessOrderBoxLayoutItemDTO[] Список товаров в коробке. Если в коробке едет часть большого товара, в списке может быть только один пункт. Min items: Example
|
Example
{
"items": [
{
"id": 0,
"fullCount": 1,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "example",
"uin": "example",
"rnpt": "example",
"gtd": "example",
"countryCode": "RU"
}
]
}
],
"boxId": 0,
"barcode": "example"
}
OrderTrackDTO
Информация о трек-номере посылки (DBS).
|
Name |
Description |
|
deliveryServiceId |
Type: integer Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса GET delivery/services. |
|
trackCode |
Type: string Трек‑номер посылки. Example: |
Example
{
"trackCode": "example",
"deliveryServiceId": 0
}
BusinessOrderDeliveryDTO
Информация о доставке заказа.
|
Name |
Description |
|
dates |
Type: BusinessOrderDeliveryDatesDTO Диапазон дат доставки. Example
|
|
deliveryPartnerType |
Type: OrderDeliveryPartnerType Тип сотрудничества со службой доставки в рамках указанного заказа. Тип сотрудничества со службой доставки в рамках конкретного заказа:
Enum: |
|
deliveryServiceId |
Type: integer Идентификатор службы доставки. |
|
serviceName |
Type: string Название службы доставки. Example: |
|
type |
Type: OrderDeliveryType Способ доставки заказа. Способ доставки заказа:
Enum: |
|
boxesLayout |
Type: BusinessOrderBoxLayoutDTO[] | null Раскладка товаров по коробкам. Min items: Example
|
|
courier |
Type: BusinessOrderCourierDeliveryDTO Информация о курьерской доставке. Example
|
|
dispatchType |
Type: OrderDeliveryDispatchType Способ доставки:
Enum: |
|
estimated |
Type: boolean Приблизительная ли дата доставки. |
|
pickup |
Type: BusinessOrderPickupDeliveryDTO Информация о доставке в пункт выдачи. Example
|
|
shipment |
Type: BusinessOrderShipmentDTO Информация об отгрузке. Информация об отгрузке заказа. Example
|
|
tracks |
Type: OrderTrackDTO[] | null Информация для отслеживания посылки. Min items: Example
|
|
transfer |
Type: BusinessOrderTransferDTO Информация о курьере и код подтверждения. Example
|
|
warehouseId |
Type: string Идентификатор склада в системе магазина, на который сформирован заказ. Example: |
Example
{
"type": "DELIVERY",
"serviceName": "example",
"deliveryServiceId": 0,
"warehouseId": "example",
"deliveryPartnerType": "SHOP",
"dispatchType": "UNKNOWN",
"dates": {
"fromDate": "2025-01-01",
"toDate": "2025-01-01",
"fromTime": "12:00:00",
"toTime": "12:00:00",
"realDeliveryDate": "2025-01-01"
},
"shipment": {
"id": 0,
"shipmentDate": "2025-01-01",
"shipmentTime": "12:00:00"
},
"courier": {
"address": {
"country": "example",
"postcode": "example",
"city": "example",
"district": "example",
"subway": "example",
"street": "example",
"house": "example",
"block": "example",
"entrance": "example",
"entryphone": "example",
"floor": "example",
"apartment": "example",
"gps": {
"latitude": 0.5,
"longitude": 0.5
}
},
"region": {
"id": 0,
"name": "example",
"type": "OTHER",
"parent": null
}
},
"pickup": {
"address": null,
"region": null,
"logisticPointId": 1,
"outletCode": "example",
"outletStorageLimitDate": "2025-01-01"
},
"transfer": {
"courier": {
"fullName": "example",
"phone": "example",
"phoneExtension": "example",
"vehicleNumber": "example",
"vehicleDescription": "example"
},
"eac": {
"eacType": "MERCHANT_TO_COURIER",
"eacCode": "example"
}
},
"boxesLayout": [
{
"items": [
{
"id": 0,
"fullCount": 1,
"partialCount": {},
"instances": [
null
]
}
],
"boxId": 0,
"barcode": "example"
}
],
"tracks": [
{
"trackCode": "example",
"deliveryServiceId": 0
}
],
"estimated": true
}
OrderLiftType
Тип подъема заказа на этаж:
-
NOT_NEEDED— не требуется. -
MANUAL— ручной. -
ELEVATOR— лифт. -
CARGO_ELEVATOR— грузовой лифт. -
FREE— любой из перечисленных выше, если включена опция бесплатного подъема. -
UNKNOWN— неизвестный тип.
Type: string
Enum: NOT_NEEDED, MANUAL, ELEVATOR, CARGO_ELEVATOR, FREE, UNKNOWN
BusinessOrderServicesDTO
Услуги, добавленные в заказ.
|
Name |
Description |
|
liftType |
Type: OrderLiftType Тип подъема заказа на этаж:
Enum: |
Example
{
"liftType": "NOT_NEEDED"
}
OrderBuyerType
Тип покупателя:
-
PERSON— физическое лицо. -
BUSINESS— организация.
Type: string
Enum: PERSON, BUSINESS
BusinessOrderDTO
Информация о заказе.
|
Name |
Description |
|
campaignId |
Type: CampaignId Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия. Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:
⚠️ Не путайте его с:
Min value: Example: |
|
creationDate |
Type: string<date-time> Дата и время оформления заказа. Формат даты: ISO 8601 со смещением относительно UTC. Example: |
|
delivery |
Type: BusinessOrderDeliveryDTO Информация о доставке заказа. Example
|
|
fake |
Type: boolean Тип заказа:
|
|
items |
Type: BusinessOrderItemDTO[] Список товаров в заказе. Example
|
|
orderId |
Type: integer Идентификатор заказа. |
|
paymentMethod |
Type: OrderPaymentMethodType Способ оплаты заказа:
Значение по умолчанию: Enum: |
|
paymentType |
Type: OrderPaymentType Тип оплаты заказа:
Если параметр отсутствует, заказ будет оплачен при получении. Enum: |
|
status |
Type: OrderStatusType Статус заказа:
Также могут возвращаться другие значения. Обрабатывать их не нужно. Enum: |
|
substatus |
Type: OrderSubstatusType Этап обработки заказа (статус
Также могут возвращаться другие значения. Обрабатывать их не нужно. Enum: |
|
buyerType |
Type: OrderBuyerType Тип покупателя: физическое лицо или организация. Только для FBS- и FBY-магазинов, которые размещают товары на витрине business.market.yandex.ru. Тип покупателя:
Enum: |
|
cancelRequested |
Type: boolean Только для модели DBS Запрошена ли отмена. |
|
externalOrderId |
Type: ExternalOrderId Внешний идентификатор заказа, который вы передали в POST v2/campaigns/{campaignId}/orders/{orderId}/external-id. Min length: Example: |
|
notes |
Type: string Комментарий к заказу. Example: |
|
prices |
Type: OrderPriceDTO Информация о стоимости заказа, доставки и вознаграждениях. Информация о стоимости заказа. Как рассчитывается стоимость заказа, доставки и вознаграждение продавцу
Example
|
|
programType |
Type: SellingProgramType Тип программы кампании магазина. Модель работы:
Enum: |
|
services |
Type: BusinessOrderServicesDTO Услуги, добавленные в заказ. Example
|
|
updateDate |
Type: string<date-time> Дата и время последнего обновления заказа. Формат даты: ISO 8601 со смещением относительно UTC. Example: |
Example
{
"orderId": 0,
"campaignId": 1,
"programType": "FBY",
"externalOrderId": "example",
"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": true,
"items": [
{
"id": 0,
"offerId": "example",
"offerName": "example",
"count": 0,
"prices": {
"payment": {
"value": 0.5,
"currencyId": "RUR"
},
"subsidy": null,
"cashback": null,
"vat": "NO_VAT"
},
"instances": [
{
"cis": "example",
"cisFull": "example",
"uin": "example",
"rnpt": "example",
"gtd": "example",
"countryCode": "RU"
}
],
"requiredInstanceTypes": [
"CIS"
],
"tags": [
"ULTIMA"
]
}
],
"prices": {
"payment": null,
"subsidy": null,
"cashback": null,
"delivery": {
"payment": null,
"subsidy": null,
"vat": null
}
},
"delivery": {
"type": "DELIVERY",
"serviceName": "example",
"deliveryServiceId": 0,
"warehouseId": "example",
"deliveryPartnerType": "SHOP",
"dispatchType": "UNKNOWN",
"dates": {
"fromDate": "2025-01-01",
"toDate": "2025-01-01",
"fromTime": "12:00:00",
"toTime": "12:00:00",
"realDeliveryDate": "2025-01-01"
},
"shipment": {
"id": 0,
"shipmentDate": "2025-01-01",
"shipmentTime": "12:00:00"
},
"courier": {
"address": {
"country": "example",
"postcode": "example",
"city": "example",
"district": "example",
"subway": "example",
"street": "example",
"house": "example",
"block": "example",
"entrance": "example",
"entryphone": "example",
"floor": "example",
"apartment": "example",
"gps": {
"latitude": 0.5,
"longitude": 0.5
}
},
"region": {
"id": 0,
"name": "example",
"type": "OTHER",
"parent": null
}
},
"pickup": {
"address": null,
"region": null,
"logisticPointId": 1,
"outletCode": "example",
"outletStorageLimitDate": "2025-01-01"
},
"transfer": {
"courier": {
"fullName": "example",
"phone": "example",
"phoneExtension": "example",
"vehicleNumber": "example",
"vehicleDescription": "example"
},
"eac": {
"eacType": "MERCHANT_TO_COURIER",
"eacCode": "example"
}
},
"boxesLayout": [
{
"items": [
{}
],
"boxId": 0,
"barcode": "example"
}
],
"tracks": [
{
"trackCode": "example",
"deliveryServiceId": 0
}
],
"estimated": true
},
"services": {
"liftType": "NOT_NEEDED"
},
"buyerType": "PERSON",
"notes": "example",
"cancelRequested": true
}
ForwardScrollingPagerDTO
Идентификатор следующей страницы.
|
Name |
Description |
|
nextPageToken |
Type: string Идентификатор следующей страницы результатов. Example: |
Example
{
"nextPageToken": "example"
}
400 Bad Request
Запрос содержит неправильные данные. Подробнее об ошибках при работе с заказами
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
ApiResponseStatusType
Тип ответа. Возможные значения:
OK— ошибок нет.ERROR— при обработке запроса произошла ошибка.
Type: string
Enum: OK, ERROR
ApiResponse
Стандартная обертка для ответов сервера.
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
Example
{
"status": "OK"
}
ApiErrorDTO
Общий формат ошибки.
|
Name |
Description |
|
code |
Type: string Код ошибки. Example: |
|
message |
Type: string Описание ошибки. Example: |
Example
{
"code": "example",
"message": "example"
}
ApiErrorResponse
Стандартная обертка для ошибок сервера.
Type: object
All of 2 types
-
Type: ApiResponse
Стандартная обертка для ответов сервера.
Example
{ "status": "OK" } -
Type: object
errors
Type: ApiErrorDTO[] | null
Список ошибок.
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
Example
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
401 Unauthorized
В запросе не указаны данные для авторизации. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
404 Not Found
Запрашиваемый ресурс не найден. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
420 Method Failure
Превышено ограничение на доступ к ресурсу. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
500 Internal Server Error
Внутренняя ошибка Маркета. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
No longer supported, please use an alternative and newer version.
Защитная метка помогает исключить подмену товара при возврате. Вернуть товар без защитной метки, которая была при покупке, не получится.
Значение cis должно соответствовать регулярному выражению ^(?=.{1,256}$)\u001D?(\(?01\)?\d{14}\(?21\)?([!-~]{6,8}|[!-~]{13}|[!-~]{20})(\u001D\(?240\)?.{1,30})?\u001D\(?9[1,3]\)?.+)$.
Без криптохвоста — ^(?=[!-~]{1,256}$)(\(?01\)?\d{14}\(?21\)?(.{6,8}|.{13}|.{20}))$.