Изменение статуса заказа

Изменяет статус заказа. Возможные изменения статусов:

  • Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса "status": "PROCESSING" и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "PROCESSING" и этап обработки "substatus": "READY_TO_SHIP".
  • Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса "status": "PROCESSING" и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
  • Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса "status": "PROCESSING" и этапа обработки "substatus": "READY_TO_SHIP" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
⚙️ Лимит: 1 000 000 запросов в час

Request

PUT

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

Path parameters

Name

Type

Description

campaignId*

integer<int64>

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

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

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

orderId*

integer<int64>

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

Body

application/json
{
    "order": {
        "status": "PLACING",
        "substatus": "RESERVATION_EXPIRED",
        "delivery": {
            "dates": {
                "realDeliveryDate": "string"
            }
        }
    }
}

Name

Type

Description

order*

OrderStatusChangeDTO

Заказ.

OrderStatusChangeDTO

Заказ.

Name

Type

Description

status*

OrderStatusType

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

  • CANCELLED — заказ отменен.

  • DELIVERED — заказ получен покупателем.

  • DELIVERY — заказ передан в службу доставки.

  • PICKUP — заказ доставлен в пункт самовывоза.

  • PROCESSING — заказ находится в обработке.

  • UNPAID — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении).

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


Enum: PLACING, RESERVED, UNPAID, PROCESSING, DELIVERY, PICKUP, DELIVERED, CANCELLED, PENDING, PARTIALLY_RETURNED, RETURNED, UNKNOWN

substatus

OrderSubstatusType

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

Возможные значения для заказа в статусе PROCESSING:

  • STARTED — заказ подтвержден, его можно начать обрабатывать.
  • READY_TO_SHIP — заказ собран и готов к отправке.

Возможные значения для заказа в статусе CANCELLED:

  • PROCESSING_EXPIRED — значение более не используется.

  • REPLACING_ORDER — покупатель решил заменить товар другим по собственной инициативе.

  • RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.

  • SHOP_FAILED — магазин не может выполнить заказ.

  • USER_CHANGED_MIND — покупатель отменил заказ по личным причинам.

  • USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.

  • USER_REFUSED_DELIVERY — покупателя не устроили условия доставки.

  • USER_REFUSED_PRODUCT — покупателю не подошел товар.

  • USER_REFUSED_QUALITY — покупателя не устроило качество товара.

  • USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:

    • не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
    • перерыв между первым и третьим звонком не менее 90 минут;
    • соединение не короче 5 секунд.

    Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.

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


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, UNKNOWN

delivery

OrderStatusChangeDeliveryDTO

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

OrderStatusType

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

  • CANCELLED — заказ отменен.

  • DELIVERED — заказ получен покупателем.

  • DELIVERY — заказ передан в службу доставки.

  • PICKUP — заказ доставлен в пункт самовывоза.

  • PROCESSING — заказ находится в обработке.

  • UNPAID — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении).

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

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:

  • PROCESSING_EXPIRED — значение более не используется.

  • REPLACING_ORDER — покупатель решил заменить товар другим по собственной инициативе.

  • RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.

  • SHOP_FAILED — магазин не может выполнить заказ.

  • USER_CHANGED_MIND — покупатель отменил заказ по личным причинам.

  • USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.

  • USER_REFUSED_DELIVERY — покупателя не устроили условия доставки.

  • USER_REFUSED_PRODUCT — покупателю не подошел товар.

  • USER_REFUSED_QUALITY — покупателя не устроило качество товара.

  • USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:

    • не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
    • перерыв между первым и третьим звонком не менее 90 минут;
    • соединение не короче 5 секунд.

    Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.

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

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, UNKNOWN

OrderStatusChangeDeliveryDTO

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

Name

Type

Description

dates

OrderStatusChangeDeliveryDatesDTO

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

OrderStatusChangeDeliveryDatesDTO

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

Name

Type

Description

realDeliveryDate

string<date>

Фактическая дата доставки.

Responses

200 OK

В случае успешного изменения статуса заказа возвращается обновленная информация о заказе

Body

application/json
{
    "order": {
        "id": 0,
        "status": "PLACING",
        "substatus": "RESERVATION_EXPIRED",
        "creationDate": "23-09-2022 09:12:41",
        "currency": "RUR",
        "itemsTotal": 0,
        "total": 0,
        "deliveryTotal": 0,
        "subsidyTotal": 0,
        "totalWithSubsidy": 0,
        "buyerItemsTotal": 0,
        "buyerTotal": 0,
        "buyerItemsTotalBeforeDiscount": 0,
        "buyerTotalBeforeDiscount": 0,
        "paymentType": "PREPAID",
        "paymentMethod": "SHOP_PREPAID",
        "fake": false,
        "items": [
            {
                "id": 0,
                "offerId": "string",
                "feedCategoryId": "string",
                "offerName": "string",
                "price": 0,
                "buyerPrice": 0,
                "buyerPriceBeforeDiscount": 0,
                "priceBeforeDiscount": 0,
                "count": 0,
                "vat": "VAT_18",
                "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"
                    }
                ],
                "details": [
                    {
                        "itemCount": 0,
                        "itemStatus": "REJECTED",
                        "updateDate": "23-09-2022"
                    }
                ],
                "subsidies": [
                    {
                        "type": "NOT_SUBSIDY",
                        "amount": 0
                    }
                ],
                "requiredInstanceTypes": [
                    "CIS"
                ]
            }
        ],
        "subsidies": [
            {
                "type": "NOT_SUBSIDY",
                "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": "VAT_18",
            "deliveryServiceId": 0,
            "liftType": "NOT_NEEDED",
            "liftPrice": 0,
            "outletCode": "string",
            "outletStorageLimitDate": "23-09-2022",
            "dispatchType": "UNKNOWN",
            "tracks": [
                {
                    "trackCode": "string",
                    "deliveryServiceId": 0
                }
            ],
            "shipments": [
                {
                    "id": 0,
                    "status": "NEW",
                    "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"
    }
}

Name

Type

Description

order

OrderDTO

Заказ.

OrderDTO

Заказ.

Name

Type

Description

id

integer<int64>

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

status

OrderStatusType

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

  • CANCELLED — заказ отменен.

  • DELIVERED — заказ получен покупателем.

  • DELIVERY — заказ передан в службу доставки.

  • PICKUP — заказ доставлен в пункт самовывоза.

  • PROCESSING — заказ находится в обработке.

  • UNPAID — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении).

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


Enum: PLACING, RESERVED, UNPAID, PROCESSING, DELIVERY, PICKUP, DELIVERED, CANCELLED, PENDING, PARTIALLY_RETURNED, RETURNED, UNKNOWN

substatus

OrderSubstatusType

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

Возможные значения для заказа в статусе PROCESSING:

  • STARTED — заказ подтвержден, его можно начать обрабатывать.
  • READY_TO_SHIP — заказ собран и готов к отправке.

Возможные значения для заказа в статусе CANCELLED:

  • PROCESSING_EXPIRED — значение более не используется.

  • REPLACING_ORDER — покупатель решил заменить товар другим по собственной инициативе.

  • RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.

  • SHOP_FAILED — магазин не может выполнить заказ.

  • USER_CHANGED_MIND — покупатель отменил заказ по личным причинам.

  • USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.

  • USER_REFUSED_DELIVERY — покупателя не устроили условия доставки.

  • USER_REFUSED_PRODUCT — покупателю не подошел товар.

  • USER_REFUSED_QUALITY — покупателя не устроило качество товара.

  • USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:

    • не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
    • перерыв между первым и третьим звонком не менее 90 минут;
    • соединение не короче 5 секунд.

    Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.

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


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, UNKNOWN

creationDate

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

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

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


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

currency

CurrencyType

Валюта, в которой указаны цены товаров в заказе.

Принимает значение RUR — российский рубль.


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

itemsTotal

number<decimal>

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

Для отделения целой части от дробной используется точка.

total

number<decimal>

Этот параметр устарел. Чтобы узнать соответствующее значение, сложите значения itemsTotal и deliveryTotal.

Общая сумма заказа в валюте заказа с учетом стоимости доставки, но без учета вознаграждения партнеру за скидки по промокодам, купонам, кешбэку и акциям (параметр subsidyTotal).

Для отделения целой части от дробной используется точка.

deliveryTotal

number<decimal>

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

Для отделения целой части от дробной используется точка.

subsidyTotal

number<decimal>

Этот параметр устарел. Чтобы узнать соответствующее значение, сложите значения всех субсидий в subsidies.

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

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

Передается в валюте, указанной в параметре currency.

Для отделения целой части от дробной используется точка.

totalWithSubsidy

number<decimal>

Этот параметр устарел. Чтобы узнать соответствующее значение, сложите значения itemsTotal, deliveryTotal и всех субсидий в subsidies.

Сумма стоимости всех товаров в заказе и вознаграждения за них в валюте магазина (сумма параметров total и subsidyTotal).

buyerItemsTotal

number<decimal>

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

buyerTotal

number<decimal>

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

buyerItemsTotalBeforeDiscount

number<decimal>

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

buyerTotalBeforeDiscount

number<decimal>

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

paymentType

OrderPaymentType

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

  • PREPAID — оплата при оформлении заказа.

  • POSTPAID — оплата при получении заказа.

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


Enum: PREPAID, POSTPAID, UNKNOWN

paymentMethod

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 — банковской картой.

  • CASH_ON_DELIVERY — наличными.

  • B2B_ACCOUNT_POSTPAYMENT — заказ оплачивает организация после доставки.

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


Enum: SHOP_PREPAID, BANK_CARD, YANDEX_MONEY, CASH_ON_DELIVERY, CARD_ON_DELIVERY, YANDEX, APPLE_PAY, EXTERNAL_CERTIFICATE, CREDIT, INSTALLMENT, GOOGLE_PAY, TINKOFF_CREDIT, SBP, TINKOFF_INSTALLMENTS, B2B_ACCOUNT_PREPAYMENT, B2B_ACCOUNT_POSTPAYMENT, UNKNOWN

fake

boolean

Тип заказа:

  • false — настоящий заказ покупателя.

  • trueтестовый заказ Маркета.

items

OrderItemDTO[]

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

subsidies

OrderItemSubsidyDTO[]

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

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

Передается в валюте заказа, для отделения целой части от дробной используется точка.

delivery

OrderDeliveryDTO

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

buyer

OrderBuyerDTO

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

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

notes

string

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

taxSystem

OrderTaxSystemType

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

  • ECHN — единый сельскохозяйственный налог (ЕСХН).

  • ENVD — единый налог на вмененный доход (ЕНВД).

  • OSN — общая система налогообложения (ОСН).

  • PSN — патентная система налогообложения (ПСН).

  • USN — упрощенная система налогообложения (УСН).

  • USN_MINUS_COST — упрощенная система налогообложения, доходы, уменьшенные на величину расходов (УСН «Доходы минус расходы»).

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


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

cancelRequested

boolean

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

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

expiryDate

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

Дата, после которой загруженный прайс-лист считается не актуальным и требует обновления.

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

Параметр возвращается при размещении прайс-листа на сервере Маркета.


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

CurrencyType

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

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

Type

Description

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

OrderPaymentType

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

  • PREPAID — оплата при оформлении заказа.

  • POSTPAID — оплата при получении заказа.

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

Type

Description

OrderPaymentType

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 — заказ оплачивает организация.

Возможные значения, если выбрана оплата при получении заказа ("paymentType": "POSTPAID"):

  • CARD_ON_DELIVERY — банковской картой.

  • CASH_ON_DELIVERY — наличными.

  • B2B_ACCOUNT_POSTPAYMENT — заказ оплачивает организация после доставки.

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

Type

Description

OrderPaymentMethodType

Enum: SHOP_PREPAID, BANK_CARD, YANDEX_MONEY, CASH_ON_DELIVERY, CARD_ON_DELIVERY, YANDEX, APPLE_PAY, EXTERNAL_CERTIFICATE, CREDIT, INSTALLMENT, GOOGLE_PAY, TINKOFF_CREDIT, SBP, TINKOFF_INSTALLMENTS, B2B_ACCOUNT_PREPAYMENT, B2B_ACCOUNT_POSTPAYMENT, UNKNOWN

OrderItemDTO

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

Name

Type

Description

id

integer<int64>

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

Позволяет идентифицировать товар в рамках данного заказа.

offerId

string

Идентификатор вашего товарного предложения для определенного товара. Описание поля в Справке для продавцов
Min length: 1
Max length: 80

feedCategoryId

string

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

Внимание

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

offerName

string

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

price

number<decimal>

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

Для отделения целой части от дробной используется точка.

buyerPrice

number<decimal>

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

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

Для отделения целой части от дробной используется точка.

buyerPriceBeforeDiscount

number<decimal>

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

Для отделения целой части от дробной используется точка.

priceBeforeDiscount

number<decimal>

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

Для отделения целой части от дробной используется точка.

count

integer

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

vat

OrderVatType

Ставка налога на добавленную стоимость (НДС) на товар.
Enum: VAT_18, VAT_10, VAT_18_118, VAT_10_110, VAT_0, NO_VAT, VAT_20, VAT_20_120, UNKNOWN_VALUE

shopSku

string

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

Внимание

Параметр устарел и не рекомендуется к использованию. Вместо него используйте параметр offerId.


Min length: 1
Max length: 80

subsidy

number<decimal>

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

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

Передается в валюте заказа, для отделения целой части от дробной используется точка.

partnerWarehouseId

string

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

Внимание

Параметр устарел, временно поддерживается, но не доступен для ввода и редактирования.

promos

OrderItemPromoDTO[]

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

instances

OrderItemInstanceDTO[]

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

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

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

details

OrderItemDetailDTO[]

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

subsidies

OrderItemSubsidyDTO[]

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

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

Передается в валюте заказа, для отделения целой части от дробной используется точка.

requiredInstanceTypes

OrderItemInstanceType[]

Список необходимых маркировок товара.
Вид маркировки товара.
Enum: CIS, UIN, RNPT, GTD

OrderItemSubsidyDTO

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

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

Передается в валюте заказа, для отделения целой части от дробной используется точка.

Name

Type

Description

type

OrderSubsidyType

Тип субсидии, которые дает Маркет:

  • SBER_SPASIBO — компенсация при оплате заказа бонусами СберСпасибо. Не используется с июля 2021 года.
  • YANDEX_CASHBACK — компенсация при оплате заказа баллами Плюса.
  • SUBSIDY — компенсация скидки:
    • по промокодам;
    • по купонам;
    • по акциям.
  • DELIVERY — компенсация стоимости доставки магазину, который работает по модели DBS.


Enum: NOT_SUBSIDY, SBER_SPASIBO, YANDEX_CASHBACK, SUBSIDY, DELIVERY

amount

number<decimal>

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

OrderDeliveryDTO

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

Name

Type

Description

id

string

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

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

type

OrderDeliveryType

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


Enum: DELIVERY, PICKUP, POST, DIGITAL, UNKNOWN

serviceName

string

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

price

number<decimal>

До 1 июля 2021 в нем возвращалась ваша стоимость доставки заказа. Сейчас Маркет всегда передает в этом поле 0, так как поле устарело и не используется, а стоимость доставки заказа рассчитывает автоматически, по единому тарифу на доставку.

Подробнее о тарифе на доставку

deliveryPartnerType

OrderDeliveryPartnerType

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

courier

OrderCourierDTO

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

dates

OrderDeliveryDatesDTO

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

region

RegionDTO

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

address

OrderDeliveryAddressDTO

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

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

vat

OrderVatType

Ставка налога на добавленную стоимость (НДС) на услугу доставки заказа:

  • NO_VAT — НДС не облагается, используется только для отдельных видов услуг.

  • VAT_0 — НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров.

  • VAT_10_110 — НДС 10/110. Расчетная ставка НДС 10%, применяется только для случая предоплаты.

  • VAT_20_120 — НДС 20/120. Расчетная ставка НДС 20%, применяется только для случая предоплаты.

  • VAT_18_118 — НДС 18/118. Ставка использовалась до 1 января 2019 года.

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


Enum: VAT_18, VAT_10, VAT_18_118, VAT_10_110, VAT_0, NO_VAT, VAT_20, VAT_20_120, UNKNOWN_VALUE

deliveryServiceId

integer<int64>

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

liftType

OrderLiftType

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

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


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

liftPrice

number<decimal>

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

outletCode

string

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

outletStorageLimitDate

string<date-dd-MM-yyyy>

Дата, до которой заказ будет храниться в пункте выдачи. Возвращается, когда заказ переходит в статус PICKUP. Один раз дату можно поменять с помощью метода PUT campaigns/{campaignId}/orders/{orderId}/delivery/storage-limit.


Example: 23-09-2022

dispatchType

OrderDeliveryDispatchType

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

  • BUYER — доставка покупателю.
  • MARKET_PARTNER_OUTLET — доставка в пункт выдачи партнера.
  • MARKET_BRANDED_OUTLET — доставка в пункт выдачи заказов Маркета.
  • SHOP_OUTLET — доставка в пункт выдачи заказов магазина.
  • DROPOFF — доставка в пункт выдачи, который принимает заказы от продавцов и передает их курьерам.


Enum: UNKNOWN, BUYER, MARKET_PARTNER_OUTLET, MARKET_BRANDED_OUTLET, SHOP_OUTLET, DROPOFF

tracks

OrderTrackDTO[]

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

shipments

OrderShipmentDTO[]

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

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

estimated

boolean

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

eacType

OrderDeliveryEacType

Тип кода подтверждения ЭАПП.
Enum: MERCHANT_TO_COURIER, COURIER_TO_MERCHANT, CHECKING_BY_MERCHANT

eacCode

string

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

OrderBuyerDTO

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

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

Name

Type

Description

id

string

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

lastName

string

Фамилия покупателя.

firstName

string

Имя покупателя.

middleName

string

Отчество покупателя.

type

OrderBuyerType

Тип покупателя: физическое лицо или организация. Этот параметр используется FBS- и FBY-магазинами, размещающими товары на витрине business.market.yandex.ru.


Enum: PERSON, BUSINESS

OrderTaxSystemType

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

  • ECHN — единый сельскохозяйственный налог (ЕСХН).

  • ENVD — единый налог на вмененный доход (ЕНВД).

  • OSN — общая система налогообложения (ОСН).

  • PSN — патентная система налогообложения (ПСН).

  • USN — упрощенная система налогообложения (УСН).

  • USN_MINUS_COST — упрощенная система налогообложения, доходы, уменьшенные на величину расходов (УСН «Доходы минус расходы»).

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

Type

Description

OrderTaxSystemType

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

OrderVatType

Ставка налога на добавленную стоимость (НДС) на услугу доставки заказа:

  • NO_VAT — НДС не облагается, используется только для отдельных видов услуг.

  • VAT_0 — НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров.

  • VAT_10_110 — НДС 10/110. Расчетная ставка НДС 10%, применяется только для случая предоплаты.

  • VAT_20_120 — НДС 20/120. Расчетная ставка НДС 20%, применяется только для случая предоплаты.

  • VAT_18_118 — НДС 18/118. Ставка использовалась до 1 января 2019 года.

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

Type

Description

OrderVatType

Enum: VAT_18, VAT_10, VAT_18_118, VAT_10_110, VAT_0, NO_VAT, VAT_20, VAT_20_120, UNKNOWN_VALUE

OrderItemPromoDTO

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

Name

Type

Description

type*

OrderPromoType

Тип скидки.


Enum: DIRECT_DISCOUNT, BLUE_SET, BLUE_FLASH, GENERIC_BUNDLE, MARKET_COUPON, MARKET_PROMOCODE, MARKET_DEAL, MARKET_BLUE, MARKET_PRIME, YANDEX_PLUS, BERU_PLUS, MARKET_COIN, YANDEX_EMPLOYEE, LIMITED_FREE_DELIVERY_PROMO, FREE_DELIVERY_THRESHOLD, MULTICART_DISCOUNT, PRICE_DROP_AS_YOU_SHOP, FREE_DELIVERY_FOR_LDI, FREE_DELIVERY_FOR_LSC, SECRET_SALE, FREE_PICKUP, CHEAPEST_AS_GIFT, CASHBACK, SUPPLIER_MULTICART_DISCOUNT, SPREAD_DISCOUNT_COUNT, SPREAD_DISCOUNT_RECEIPT, ANNOUNCEMENT_PROMO, DISCOUNT_BY_PAYMENT_TYPE, PERCENT_DISCOUNT, DCO_EXTRA_DISCOUNT, EMPTY_PROMO, BLOCKING_PROMO, UNKNOWN

discount

number<decimal>

Размер пользовательской скидки в валюте покупателя.

subsidy

number<decimal>

Вознаграждение партнеру от Маркета за товар, проданный в рамках акции.

Передается в валюте заказа, для отделения целой части от дробной используется точка.

shopPromoId

string

Идентификатор акции поставщика.

marketPromoId

string

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

Параметр передается, только если параметр type=MARKET_DEAL.

OrderItemInstanceDTO

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

Name

Type

Description

cis

string

Код идентификации единицы товара в системе «Честный ЗНАК» без криптохвоста.

cisFull

string

Код идентификации единицы товара в системе «Честный ЗНАК» с криптохвостом.

uin

string

УИН ювелирного изделия (16-значный код) Производитель получает УИН, когда регистрирует изделие в системе контроля за оборотом драгоценных металлов и камней — ГИИС ДМДК.

rnpt

string

Регистрационный номер партии товара.

Представляет собой строку из четырех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ/ХХХ.

Первая часть — код таможни, которая зарегистрировала декларацию на партию товара. Далее — дата, номер декларации и номер маркированного товара в декларации.

gtd

string

Грузовая таможенная декларация.

Представляет собой строку из трех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ.

Первая часть — код таможни, которая зарегистрировала декларацию на ввезенные товары. Далее — дата и номер декларации.

OrderItemDetailDTO

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

Name

Type

Description

itemCount

integer<int64>

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

itemStatus

OrderItemStatusType

Возвращенный или невыкупленный товар.
Enum: REJECTED, RETURNED

updateDate

string<date-dd-MM-yyyy>

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


Example: 23-09-2022

OrderItemInstanceType

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

Type

Description

OrderItemInstanceType

Enum: CIS, UIN, RNPT, GTD

OrderSubsidyType

Тип субсидии, которые дает Маркет:

  • SBER_SPASIBO — компенсация при оплате заказа бонусами СберСпасибо. Не используется с июля 2021 года.
  • YANDEX_CASHBACK — компенсация при оплате заказа баллами Плюса.
  • SUBSIDY — компенсация скидки:
    • по промокодам;
    • по купонам;
    • по акциям.
  • DELIVERY — компенсация стоимости доставки магазину, который работает по модели DBS.

Type

Description

OrderSubsidyType

Enum: NOT_SUBSIDY, SBER_SPASIBO, YANDEX_CASHBACK, SUBSIDY, DELIVERY

OrderDeliveryType

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

  • DELIVERY — курьерская доставка.

  • PICKUP — самовывоз.

  • POST — почта.

  • DIGITAL — для цифровых товаров.

Type

Description

OrderDeliveryType

Enum: DELIVERY, PICKUP, POST, DIGITAL, UNKNOWN

OrderDeliveryPartnerType

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

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

Type

Description

OrderDeliveryPartnerType

Enum: SHOP, YANDEX_MARKET, UNKNOWN

OrderCourierDTO

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

Name

Type

Description

fullName

string

Полное имя курьера.

phone

string

Номер телефона курьера.

phoneExtension

string

Добавочный номер телефона.

vehicleNumber

string

Номер транспортного средства.

vehicleDescription

string

Описание машины. Например, модель и цвет.

OrderDeliveryDatesDTO

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

Name

Type

Description

fromDate

string<date-dd-MM-yyyy>

Ближайшая дата доставки.

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


Example: 23-09-2022

toDate

string<date-dd-MM-yyyy>

Самая поздняя дата доставки.

Если параметр toDate не указан, единственно возможной датой доставки считается дата, указанная в параметре fromDate.

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


Example: 23-09-2022

fromTime

string<time>

Начало интервала времени доставки.

Передается только совместно с параметром type=DELIVERY.

Формат времени: 24-часовой, ЧЧ:ММ. В качестве минут всегда должно быть указано 00 (исключение — 23:59).

Минимальное значение: 00:00.

toTime

string<time>

Конец интервала времени доставки.

Передается только совместно с параметром type=DELIVERY.

Формат времени: 24-часовой, ЧЧ:ММ. В качестве минут всегда должно быть указано 00 (исключение — 23:59).

Максимальное значение: 23:59.

realDeliveryDate

string<date-dd-MM-yyyy>

Дата, когда товар доставлен до пункта выдачи заказа (в случае самовывоза) или до покупателя (если заказ доставляет курьер).
Example: 23-09-2022

RegionDTO

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

Name

Type

Description

id

integer<int64>

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

name*

string

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

type*

RegionType

Тип региона.
Enum: OTHER, CONTINENT, REGION, COUNTRY, COUNTRY_DISTRICT, REPUBLIC, CITY, VILLAGE, CITY_DISTRICT, SUBWAY_STATION, REPUBLIC_AREA

parent

RegionDTO

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

Указываются родительские регионы до уровня страны.

children

RegionDTO[]

Дочерние регионы.
Регион доставки.

OrderDeliveryAddressDTO

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

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

Name

Type

Description

country

string

Страна.

Обязательный параметр.

postcode

string

Почтовый индекс.

Указывается, если выбрана доставка почтой (delivery type=POST).

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

GpsDTO

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

OrderLiftType

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

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

Type

Description

OrderLiftType

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

OrderDeliveryDispatchType

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

  • BUYER — доставка покупателю.
  • MARKET_PARTNER_OUTLET — доставка в пункт выдачи партнера.
  • MARKET_BRANDED_OUTLET — доставка в пункт выдачи заказов Маркета.
  • SHOP_OUTLET — доставка в пункт выдачи заказов магазина.
  • DROPOFF — доставка в пункт выдачи, который принимает заказы от продавцов и передает их курьерам.

Type

Description

OrderDeliveryDispatchType

Enum: UNKNOWN, BUYER, MARKET_PARTNER_OUTLET, MARKET_BRANDED_OUTLET, SHOP_OUTLET, DROPOFF

OrderTrackDTO

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

Name

Type

Description

trackCode

string

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

deliveryServiceId

integer<int64>

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

OrderShipmentDTO

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

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

Name

Type

Description

id

integer<int64>

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

status

OrderParcelStatusType

Статус заказа в партнерской службе доставки.
Enum: NEW, CREATED, READY_TO_SHIP, ERROR, UNKNOWN

shipmentDate

string<date-dd-MM-yyyy>

День, в который нужно отгрузить заказ службе доставки.

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

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


Example: 23-09-2022

shipmentTime

string

Только для модели Экспресс

Время, к которому магазин должен упаковать заказ и перевести его в статус READY_TO_SHIP. После смены статуса за заказом приедет курьер.

Формат времени: 24-часовой, ЧЧ:ММ.

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

tracks

OrderTrackDTO[]

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

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

boxes

OrderParcelBoxDTO[]

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

OrderDeliveryEacType

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

  • MERCHANT_TO_COURIER — продавец передает код курьеру.
  • COURIER_TO_MERCHANT — курьер передает код продавцу.
  • CHECKING_BY_MERCHANT — продавец проверяет код на своей стороне.

Type

Description

OrderDeliveryEacType

Enum: MERCHANT_TO_COURIER, COURIER_TO_MERCHANT, CHECKING_BY_MERCHANT

OrderBuyerType

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

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

Type

Description

OrderBuyerType

Enum: PERSON, BUSINESS

OrderPromoType

Тип скидки:

  • DIRECT_DISCOUNT — прямая скидка, которую устанавливает продавец или Маркет.
  • BLUE_FLASH — флеш-акция.
  • MARKET_COUPON — скидка по промокоду от Маркета.
  • MARKET_PROMOCODE — скидка по промокоду магазина.
  • MARKET_DEAL — скидка в рамках соглашения на оказание услуг по продвижению сервиса между Маркетом и партнером.
  • MARKET_COIN — скидка по купонам.
  • CHEAPEST_AS_GIFT — самый дешевый товар в подарок.
  • DCO_EXTRA_DISCOUNT — дополнительная скидка, необходимая для расчета субсидии от Маркета.

Type

Description

OrderPromoType

Enum: DIRECT_DISCOUNT, BLUE_SET, BLUE_FLASH, GENERIC_BUNDLE, MARKET_COUPON, MARKET_PROMOCODE, MARKET_DEAL, MARKET_BLUE, MARKET_PRIME, YANDEX_PLUS, BERU_PLUS, MARKET_COIN, YANDEX_EMPLOYEE, LIMITED_FREE_DELIVERY_PROMO, FREE_DELIVERY_THRESHOLD, MULTICART_DISCOUNT, PRICE_DROP_AS_YOU_SHOP, FREE_DELIVERY_FOR_LDI, FREE_DELIVERY_FOR_LSC, SECRET_SALE, FREE_PICKUP, CHEAPEST_AS_GIFT, CASHBACK, SUPPLIER_MULTICART_DISCOUNT, SPREAD_DISCOUNT_COUNT, SPREAD_DISCOUNT_RECEIPT, ANNOUNCEMENT_PROMO, DISCOUNT_BY_PAYMENT_TYPE, PERCENT_DISCOUNT, DCO_EXTRA_DISCOUNT, EMPTY_PROMO, BLOCKING_PROMO, UNKNOWN

OrderItemStatusType

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

Type

Description

OrderItemStatusType

Enum: REJECTED, RETURNED

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

GpsDTO

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

Name

Type

Description

latitude*

number<decimal>

Широта.

longitude*

number<decimal>

Долгота.

OrderParcelStatusType

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

Type

Description

OrderParcelStatusType

Enum: NEW, CREATED, READY_TO_SHIP, ERROR, UNKNOWN

OrderParcelBoxDTO

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

Name

Type

Description

id

integer<int64>

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

fulfilmentId

string

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

400 Bad Request

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

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

ApiResponseStatusType

Тип ответа.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

ApiErrorDTO

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

Name

Type

Description

code*

string

Код ошибки.

message

string

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

401 Unauthorized

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

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

403 Forbidden

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

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

404 Not Found

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

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

420 Method Failure

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

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

500 Internal Server Error

Внутренняя ошибка сервера.

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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