Руководство разработчика
Методы API

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

Описание

Изменяет статус заказа.
PUT /campaigns/{campaignId}/orders/{orderId}/status
Примечание. Метод доступен начиная с версии 2.2 партнерского API Яндекс.Маркета.

URL ресурса:

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

Входные данные

Параметры в URL:

Параметр

Тип

Значение

Обязательные

campaignId

Int64

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

orderId

Int64

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

Структура тела PUT-запроса:

<order
[no-highlight[

Значение

Заказ.

]no-highlight]
status
[no-highlight[

Значение

Новый статус заказа.

Должен соответствовать схеме изменения статуса заказа (см. таблицу ниже).

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

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

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

  • DELIVERY — заказ передан в доставку;

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

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

  • RESERVED — заказ в резерве (ожидается подтверждение от пользователя);

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

Для формата XML является атрибутом параметра order.

]no-highlight]
="{enum}" substatus
[no-highlight[

Значение

Причина отмены заказа.

Должен соответствовать схеме изменения статуса заказа (см. таблицу ниже).

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

  • PROCESSING_EXPIRED — магазин не обработал заказ вовремя;

  • REPLACING_ORDER — покупатель изменяет состав заказа;

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

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

  • USER_CHANGED_MIND — покупатель отменил заказ по собственным причинам;

  • USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID);

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

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

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

  • USER_UNREACHABLE — не удалось связаться с покупателем.

Для формата XML является атрибутом параметра order.

]no-highlight]
="{enum}"/>
{
  "order
[no-highlight[

Значение

Заказ.

]no-highlight]
": { "status
[no-highlight[

Значение

Новый статус заказа.

Должен соответствовать схеме изменения статуса заказа (см. таблицу ниже).

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

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

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

  • DELIVERY — заказ передан в доставку;

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

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

  • RESERVED — заказ в резерве (ожидается подтверждение от пользователя);

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

Для формата XML является атрибутом параметра order.

]no-highlight]
": "{enum}", "substatus
[no-highlight[

Значение

Причина отмены заказа.

Должен соответствовать схеме изменения статуса заказа (см. таблицу ниже).

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

  • PROCESSING_EXPIRED — магазин не обработал заказ вовремя;

  • REPLACING_ORDER — покупатель изменяет состав заказа;

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

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

  • USER_CHANGED_MIND — покупатель отменил заказ по собственным причинам;

  • USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID);

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

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

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

  • USER_UNREACHABLE — не удалось связаться с покупателем.

Для формата XML является атрибутом параметра order.

]no-highlight]
": "{enum}" } }

Описание параметров:

Параметр для формата XML

Параметр для формата JSON

Тип

Значение

order order

Заказ.

Параметры, вложенные в order

status status Enum

Новый статус заказа.

Должен соответствовать схеме изменения статуса заказа (см. таблицу ниже).

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

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

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

  • DELIVERY — заказ передан в доставку;

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

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

  • RESERVED — заказ в резерве (ожидается подтверждение от пользователя);

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

Для формата XML является атрибутом параметра order.

substatus substatus Enum

Причина отмены заказа.

Должен соответствовать схеме изменения статуса заказа (см. таблицу ниже).

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

  • PROCESSING_EXPIRED — магазин не обработал заказ вовремя;

  • REPLACING_ORDER — покупатель изменяет состав заказа;

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

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

  • USER_CHANGED_MIND — покупатель отменил заказ по собственным причинам;

  • USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID);

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

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

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

  • USER_UNREACHABLE — не удалось связаться с покупателем.

Для формата XML является атрибутом параметра order.

Схема изменения статуса заказа:

Событие

Исходный статус

Новый статус

Заказ готов к передаче в службу доставки.

PROCESSING

DELIVERY

Внимание! Заказ должен быть переведен в статус DELIVERY в течение 7 дней. Если заказ не переведен в статус DELIVERY вовремя, он автоматически отменяется, а магазину выставляется ошибка.

Заказ отменен на этапе обработки, причина указывается в параметре substatus.

PROCESSING

CANCELLED

Возможные значения параметра substatus:

  • REPLACING_ORDER — покупатель изменяет состав заказа;

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

  • USER_CHANGED_MIND — покупатель отменил заказ по собственным причинам;

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

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

  • USER_UNREACHABLE — не удалось связаться с покупателем.

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

DELIVERY

PICKUP

Заказ вручен покупателю.

DELIVERY или PICKUP

DELIVERED

Заказ отменен на этапе доставки, причина указывается в параметре substatus.

DELIVERY или PICKUP

CANCELLED

Возможные значения параметра substatus:

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

  • USER_CHANGED_MIND — покупатель отменил заказ по собственным причинам;

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

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

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

  • USER_UNREACHABLE — не удалось связаться с покупателем.

Внимание! Статус заказа не будет изменен, если магазин передает статус, нарушающий последовательность перехода заказа из статуса в статус. В этом случае Яндекс.Маркет возвращает ответ с указанием соответствующей ошибки.

Выходные данные

Возможны три варианта ответа от Маркета:

1. Ответ 200 ОК с информацией о заказе.

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

2. Ответ 500 Internal Server Error или 503 Service Unavailable.

Данный ответ означает, что на стороне Маркета произошел сбой и статус заказа не изменен. Магазин должен повторить запрос через некоторое время и дождаться получения ответа 200 OK. Помните, что если статус заказа не будет изменен, то заказ автоматически отменится, а покупателю вернутся деньги (если заказ был предоплачен).

3. Ответ с кодом 400, 403 или 404.

Данный ответ означает, что в запросе магазина содержатся ошибки и статус заказа не изменен. Магазин должен исправить ошибку и снова выполнить запрос, пока не будет получен ответ 200 OK. Подробные описания ошибок с кодами 4xx описаны ниже.

Внимание! Магазин должен обязательно получить от Яндекс.Маркета ответ 200 OK. Только в этом случае статус заказа будет успешно изменен. Если ответ 200 OK так и не получен — обратитесь в службу поддержки.

Структура выходных данных для ответа 200 OK приведена ниже. Порядок следования параметров не гарантируется.

<response
[no-highlight[

Значение

Ответ.

Параметр выводится только для формата XML.

]no-highlight]
> <order
[no-highlight[

Значение

Описание заказа.

]no-highlight]
creation-date
[no-highlight[

Значение

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

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

Для формата XML является атрибутом параметра order.

]no-highlight]
="{date}" currency
[no-highlight[

Значение

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

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

  • BYN — белорусский рубль;

  • KZT — казахстанский тенге;

  • RUR — российский рубль;

  • UAH — украинская гривна.

Для формата XML является атрибутом параметра order.

]no-highlight]
="{enum}" fake
[no-highlight[

Значение

Тип заказа.

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

  • false — настоящий заказ покупателя или контрольный заказ Маркета;

    Примечание. Информация, что заказ является контрольным, содержится в параметре notes. Такие заказы не тарифицируются Маркетом.
  • true — отладочный заказ или контрольный заказ Маркета.

Для формата XML является атрибутом параметра order.

]no-highlight]
="{boolean}" fee-ue
[no-highlight[

Значение

Сумма комиссий на все товары заказа, оформленного в рамках программы «Заказ на Маркете», в у. е.

Для формата XML является атрибутом параметра order.

]no-highlight]
="{double}" id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра order.

]no-highlight]
="{int64}" is-booked
[no-highlight[

Значение

Признак, что заказ оформлен в рамках программы «Забронировать на Маркете».

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

  • true — заказ оформлен в рамках программы «Забронировать на Маркете».

Параметр выводится только со значением true.

Для формата XML является атрибутом параметра cart.

]no-highlight]
="{boolean}" items-total
[no-highlight[

Значение

Общая сумма заказа в валюте заказа без учета доставки.

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

Для формата XML является атрибутом параметра order.

]no-highlight]
="{double}" payment-type
[no-highlight[

Значение

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

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

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

  • PREPAID — предоплата.

Для формата XML является атрибутом параметра order.

]no-highlight]
="{enum}" payment-method
[no-highlight[

Значение

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

Возможные значения для типа оплаты POSTPAID:

  • CARD_ON_DELIVERY — оплата банковской картой при получении заказа;

  • CASH_ON_DELIVERY — наличный расчет при получении заказа.

Возможное значение для типа оплаты PREPAID:

  • YANDEX — оплата при оформлении (только для России).

Примечание. Как подключить прием предоплаты по заказам с Маркета, описано в Помощи для магазинов.

Для формата XML является атрибутом параметра order.

]no-highlight]
="{enum}" status
[no-highlight[

Значение

Статус заказа.

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

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

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

  • DELIVERY — заказ передан в доставку;

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

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

  • RESERVED — заказ в резерве (ожидается подтверждение от пользователя);

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

Для формата XML является атрибутом параметра order.

]no-highlight]
="{enum}" substatus
[no-highlight[

Значение

Причина отмены заказа.

Выводится, если параметр status имеет значение CANCELLED.

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

  • PROCESSING_EXPIRED — магазин не обработал заказ вовремя;

  • REPLACING_ORDER — покупатель изменяет состав заказа;

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

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

  • USER_CHANGED_MIND — покупатель отменил заказ по собственным причинам;

  • USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID);

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

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

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

  • USER_UNREACHABLE — не удалось связаться с покупателем.

Для формата XML является атрибутом параметра order.

]no-highlight]
="{enum}" tax-system
[no-highlight[

Значение

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

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

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

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

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

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

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

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

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

Для формата XML является атрибутом параметра order.

]no-highlight]
="{enum}" total
[no-highlight[

Значение

Общая сумма заказа в валюте заказа с учетом доставки.

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

Для формата XML является атрибутом параметра order.

]no-highlight]
="{double}"> <buyer
[no-highlight[

Значение

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

]no-highlight]
id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра buyer.

]no-highlight]
="{string}" last-name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра buyer.

]no-highlight]
="{string}" first-name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра buyer.

]no-highlight]
="{string}" middle-name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра buyer.

]no-highlight]
="{string}" email
[no-highlight[

Значение

Адрес электронной почты покупателя.

Допускается любой адрес электронной почты, соответствующий стандарту RFC 2822.

Для формата XML является атрибутом параметра buyer.

]no-highlight]
="{string}" phone
[no-highlight[

Значение

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

Формат номера: +<код_страны><код_региона><номер_телефона>.

Для формата XML является атрибутом параметра buyer.

]no-highlight]
="{string}"/> <delivery
[no-highlight[

Значение

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

]no-highlight]
delivery-partner-type
[no-highlight[

Значение

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

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

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

  • YANDEX_MARKET — магазин работает со службой доставки через Яндекс.Маркет.

Для формата XML является атрибутом значения delivery.

]no-highlight]
="{enum}" id
[no-highlight[

Значение

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

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

Для формата XML является атрибутом параметра delivery.

]no-highlight]
="{string}" outlet-code
[no-highlight[

Значение

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

Идентификатор указывается:

Параметр указывается, если значением параметра type является PICKUP.

Для формата XML является атрибутом параметра delivery.

]no-highlight]
="{string}" price
[no-highlight[

Значение

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

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

Для формата XML является атрибутом параметра delivery.

]no-highlight]
="{double}" service-name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра delivery.

]no-highlight]
="{string}" type
[no-highlight[

Значение

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

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

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

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

  • POST — почта.

Для формата XML является атрибутом параметра delivery.

]no-highlight]
="{enum}" vat
[no-highlight[

Значение

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

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

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

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

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

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

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

Для формата XML является атрибутом параметра delivery.

]no-highlight]
="{enum}" outlet-id
[no-highlight[

Значение

Внимание! Параметр устарел и не рекомендуется к использованию. Идентификатор пункта самовывоза указан в параметре outlet-code / outletCode.
]no-highlight]
="{int64}"> <address
[no-highlight[

Значение

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

Указывается, если значением параметра type является DELIVERY или POST.

]no-highlight]
postcode
[no-highlight[

Значение

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

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

Для формата XML является атрибутом параметра address.

]no-highlight]
="{string}" country
[no-highlight[

Значение

Страна.

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

Для формата XML является атрибутом параметра address.

]no-highlight]
="{string}" city
[no-highlight[

Значение

Город или населенный пункт.

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

Для формата XML является атрибутом параметра address.

]no-highlight]
="{string}" subway
[no-highlight[

Значение

Станция метро.

Для формата XML является атрибутом параметра address.

]no-highlight]
="{string}" street
[no-highlight[

Значение

Улица.

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

Для формата XML является атрибутом параметра address.

]no-highlight]
="{string}" house
[no-highlight[

Значение

Дом или владение.

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

Для формата XML является атрибутом параметра address.

]no-highlight]
="{string}" block
[no-highlight[

Значение

Корпус или строение.

Для формата XML является атрибутом параметра address.

]no-highlight]
="{string}" entrance
[no-highlight[

Значение

Подъезд.

Для формата XML является атрибутом параметра address.

]no-highlight]
="{string}" entryphone
[no-highlight[

Значение

Домофон.

Для формата XML является атрибутом параметра address.

]no-highlight]
="{string}" floor
[no-highlight[

Значение

Этаж.

Для формата XML является атрибутом параметра address.

]no-highlight]
="{string}" apartment
[no-highlight[

Значение

Квартира или офис.

Для формата XML является атрибутом параметра address.

]no-highlight]
="{string}" phone
[no-highlight[

Значение

Телефон получателя заказа.

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

Для формата XML является атрибутом параметра address.

]no-highlight]
="{string}" recipient
[no-highlight[

Значение

Фамилия, имя и отчество получателя заказа.

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

Для формата XML является атрибутом параметра address.

]no-highlight]
="{string}"/> <dates
[no-highlight[

Значение

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

]no-highlight]
from-date
[no-highlight[

Значение

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

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

Для формата XML является атрибутом параметра dates.

]no-highlight]
="{date}" to-date
[no-highlight[

Значение

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

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

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

Для формата XML является атрибутом параметра dates.

]no-highlight]
="{date}"/> <region
[no-highlight[

Значение

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

]no-highlight]
id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра region.

]no-highlight]
="{int64}" name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра region.

]no-highlight]
="{string}" type
[no-highlight[

Значение

Тип региона.

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

  • AREA — область.

  • CITY — крупный город.

  • CONTINENT — континент.

  • COUNTRY — страна.

  • DISCTRICT — район города.

  • MONORAIL_STATION — станция монорельса.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • REGION — регион.

  • REPUBLIC — субъект федерации.

  • REPUBLIC_AREA — район субъекта федерации.

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • SETTLEMENT — поселение.

  • SUBURB — пригород.

  • SUBWAY_STATION — станция метро.

  • TOWN — город.

  • UNKNOWN — неизвестный регион.

Для формата XML является атрибутом параметра region.

]no-highlight]
="{enum}"> <parent
[no-highlight[

Значение

Родительский регион.

Указываются родительские регионы до уровня страны (значением параметра type является COUNTRY).

]no-highlight]
id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра parent.

]no-highlight]
="{int64}" name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра parent.

]no-highlight]
="{string}" type
[no-highlight[

Значение

Тип родительского региона.

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

  • AREA — область.

  • CITY — крупный город.

  • CONTINENT — континент.

  • COUNTRY — страна.

  • DISCTRICT — район города.

  • MONORAIL_STATION — станция монорельса.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • REGION — регион.

  • REPUBLIC — субъект федерации.

  • REPUBLIC_AREA — район субъекта федерации.

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • SETTLEMENT — поселение.

  • SUBURB — пригород.

  • SUBWAY_STATION — станция метро.

  • TOWN — город.

  • UNKNOWN — неизвестный регион.

Для формата XML является атрибутом параметра parent.

]no-highlight]
="{enum}"> ... </parent> </region> <shipments
[no-highlight[

Значение

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

  • Если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET), в параметре может указываться только одна посылка.

  • Если магазин работает со службой доставки напрямую (delivery-partner-type=SHOP) и является зарубежным, в параметре может указываться несколько посылок.

]no-highlight]
> <shipment
[no-highlight[

Значение

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

Параметр указывается только для формата XML.

]no-highlight]
depth
[no-highlight[

Значение

Глубина упакованного заказа в сантиметрах.

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

Для формата XML является атрибутом параметра shipment.

]no-highlight]
="{int64}" height
[no-highlight[

Значение

Высота упакованного заказа в сантиметрах.

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

Для формата XML является атрибутом параметра shipment.

]no-highlight]
="{int64}" status
[no-highlight[

Значение

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

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

  • CREATED — заказ создан в партнерской службе доставки и по нему получен номер посылки.

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

  • NEW — заявка на создание заказ в службе доставки.

  • READY_TO_SHIP — заказ готов к доставке и по нему получен ярлык.

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

Для формата XML является атрибутом параметра shipment.

]no-highlight]
="{enum}" weight
[no-highlight[

Значение

Вес упакованного заказа, отгруженного в партнерскую службу доставки, в граммах.

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

Для формата XML является атрибутом параметра shipment.

]no-highlight]
="{int64}" width
[no-highlight[

Значение

Ширина упакованного заказа, отгруженного в партнерскую службу доставки, в сантиметрах.

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

Для формата XML является атрибутом параметра shipment.

]no-highlight]
="{int64}"> <documents
[no-highlight[

Значение

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

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

]no-highlight]
> <document
[no-highlight[

Значение

Документ по заказу.

Параметр указывается только для формата XML.

]no-highlight]
type
[no-highlight[

Значение

Тип документа по заказу.

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

  • LABEL — ярлык заказа в формате PDF.

Для формата XML является атрибутом параметра document.

]no-highlight]
="{enum}" url
[no-highlight[

Значение

URL-адрес сопроводительного документа.

Для формата XML является атрибутом параметра document.

]no-highlight]
="{string}"/> ... </documents> <items
[no-highlight[

Значение

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

]no-highlight]
> <item
[no-highlight[

Значение

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

Параметр указывается только для формата XML.

]no-highlight]
count
[no-highlight[

Значение

Количество товара в посылке.

Для формата XML является атрибутом параметра item.

]no-highlight]
="{int32}" id="{int64}"/> ... </items> <tracks
[no-highlight[

Значение

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

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

  • один номер, если посылку доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET);

  • пять номеров, если магазин работает со службой доставки напрямую (delivery-partner-type=SHOP) и является зарубежным.

]no-highlight]
> <track
[no-highlight[

Значение

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

Параметр указывается только для формата XML.

]no-highlight]
delivery-service-id
[no-highlight[

Значение

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

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

Для формата XML является атрибутом параметра track.

]no-highlight]
="{int64}" track-code
[no-highlight[

Значение

Номер посылки.

  • Если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET), в параметре передается номер, который передал Яндекс.Маркет.

  • Если магазин работает со службой доставки напрямую (delivery-partner-type=SHOP) и является зарубежным, в параметре передается номер, который передал магазин.

Для формата XML является атрибутом параметра track.

]no-highlight]
="{string}"/> ... </tracks> </shipment> ... </shipments> <tracks
[no-highlight[

Значение

Внимание! Параметр устарел и не рекомендуется к использованию. Информация для отслеживания перемещений заказа указывается в параметре tracks, вложенном в shipment.
]no-highlight]
> <track delivery-service-id="{int64}" track-code="{string}"/> </tracks> </delivery> <items
[no-highlight[

Значение

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

]no-highlight]
> <item count="{int32}" feed-category-id
[no-highlight[

Значение

Идентификатор категории товара из прайс-листа.

Для формата XML является атрибутом параметра item.

]no-highlight]
="{string}" feed-id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра item.

]no-highlight]
="{int64}" fee-ue
[no-highlight[

Значение

Комиссия на товар в рамках программы «Заказ на Маркете», в у. е.

Для формата XML атрибутом параметра item.

]no-highlight]
="{double}" id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра item.

]no-highlight]
="{int64}" offer-id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра item.

]no-highlight]
="{string}" offer-name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра item.

]no-highlight]
="{string}" price
[no-highlight[

Значение

Цена товара в валюте заказа.

Внимание! Для товарных предложений, участвующих в программе «Акции Маркета», в параметре price указывается более низкая цена, которую должен заплатить покупатель. Компенсация магазину от Яндекс.Маркета до цены товара из прайс-листа передается в параметре subsidy.

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

Для формата XML является атрибутом параметра item.

]no-highlight]
="{double}" vat
[no-highlight[

Значение

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

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

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

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

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

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

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

Для формата XML является атрибутом параметра item.

]no-highlight]
="{enum}"> <promos
[no-highlight[

Значение

Акции в рамках программы «Акции Маркета», в которых участвует товарное предложение магазина.

]no-highlight]
> <promo
[no-highlight[

Значение

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

]no-highlight]
market-promo-id
[no-highlight[

Значение

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

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

Для формата XML является атрибутом параметра promo.

]no-highlight]
="{string}" subsidy
[no-highlight[

Значение

Компенсация магазину от Яндекс.Маркета за единицу товара, участвующего в программе «Акции Маркета».

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

Для формата XML является атрибутом параметра promo.

]no-highlight]
="{float}" type
[no-highlight[

Значение

Тип акции.

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

  • MARKET_COUPON — скидка по промокоду от Яндекс.Маркета.

  • MARKET_DEAL — скидка в рамках соглашения на оказание услуг по продвижению сервиса между Яндекс.Маркетом и магазином.

Для формата XML является атрибутом параметра promo.

]no-highlight]
="{enum}"/> ... </promos> </item> ... </items> <notes
[no-highlight[

Значение

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

]no-highlight]
>{string}</notes> </order> </response>
{
  "order
[no-highlight[

Значение

Описание заказа.

]no-highlight]
": { "creationDate
[no-highlight[

Значение

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

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

Для формата XML является атрибутом параметра order.

]no-highlight]
": "{date}", "currency
[no-highlight[

Значение

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

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

  • BYN — белорусский рубль;

  • KZT — казахстанский тенге;

  • RUR — российский рубль;

  • UAH — украинская гривна.

Для формата XML является атрибутом параметра order.

]no-highlight]
": "{enum}", "fake
[no-highlight[

Значение

Тип заказа.

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

  • false — настоящий заказ покупателя или контрольный заказ Маркета;

    Примечание. Информация, что заказ является контрольным, содержится в параметре notes. Такие заказы не тарифицируются Маркетом.
  • true — отладочный заказ или контрольный заказ Маркета.

Для формата XML является атрибутом параметра order.

]no-highlight]
": {boolean}, "feeUE
[no-highlight[

Значение

Сумма комиссий на все товары заказа, оформленного в рамках программы «Заказ на Маркете», в у. е.

Для формата XML является атрибутом параметра order.

]no-highlight]
": {double}, "id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра order.

]no-highlight]
": {int64}, "isBooked
[no-highlight[

Значение

Признак, что заказ оформлен в рамках программы «Забронировать на Маркете».

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

  • true — заказ оформлен в рамках программы «Забронировать на Маркете».

Параметр выводится только со значением true.

Для формата XML является атрибутом параметра cart.

]no-highlight]
": {boolean}, "itemsTotal
[no-highlight[

Значение

Общая сумма заказа в валюте заказа без учета доставки.

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

Для формата XML является атрибутом параметра order.

]no-highlight]
": {double}, "paymentType
[no-highlight[

Значение

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

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

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

  • PREPAID — предоплата.

Для формата XML является атрибутом параметра order.

]no-highlight]
": "{enum}", "paymentMethod
[no-highlight[

Значение

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

Возможные значения для типа оплаты POSTPAID:

  • CARD_ON_DELIVERY — оплата банковской картой при получении заказа;

  • CASH_ON_DELIVERY — наличный расчет при получении заказа.

Возможное значение для типа оплаты PREPAID:

  • YANDEX — оплата при оформлении (только для России).

Примечание. Как подключить прием предоплаты по заказам с Маркета, описано в Помощи для магазинов.

Для формата XML является атрибутом параметра order.

]no-highlight]
": "{enum}", "status
[no-highlight[

Значение

Статус заказа.

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

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

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

  • DELIVERY — заказ передан в доставку;

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

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

  • RESERVED — заказ в резерве (ожидается подтверждение от пользователя);

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

Для формата XML является атрибутом параметра order.

]no-highlight]
": "{enum}", "substatus
[no-highlight[

Значение

Причина отмены заказа.

Выводится, если параметр status имеет значение CANCELLED.

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

  • PROCESSING_EXPIRED — магазин не обработал заказ вовремя;

  • REPLACING_ORDER — покупатель изменяет состав заказа;

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

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

  • USER_CHANGED_MIND — покупатель отменил заказ по собственным причинам;

  • USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID);

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

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

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

  • USER_UNREACHABLE — не удалось связаться с покупателем.

Для формата XML является атрибутом параметра order.

]no-highlight]
": "{enum}", "taxSystem
[no-highlight[

Значение

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

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

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

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

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

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

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

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

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

Для формата XML является атрибутом параметра order.

]no-highlight]
": "{enum}", "total
[no-highlight[

Значение

Общая сумма заказа в валюте заказа с учетом доставки.

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

Для формата XML является атрибутом параметра order.

]no-highlight]
": {double}, "buyer
[no-highlight[

Значение

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

]no-highlight]
": { "id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра buyer.

]no-highlight]
": "{string}", "lastName
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра buyer.

]no-highlight]
": "{string}", "firstName
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра buyer.

]no-highlight]
": "{string}", "middleName
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра buyer.

]no-highlight]
": "{string}", "email
[no-highlight[

Значение

Адрес электронной почты покупателя.

Допускается любой адрес электронной почты, соответствующий стандарту RFC 2822.

Для формата XML является атрибутом параметра buyer.

]no-highlight]
": "{string}", "phone
[no-highlight[

Значение

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

Формат номера: +<код_страны><код_региона><номер_телефона>.

Для формата XML является атрибутом параметра buyer.

]no-highlight]
": "{string}" }, "delivery
[no-highlight[

Значение

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

]no-highlight]
": { "deliveryPartnerType
[no-highlight[

Значение

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

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

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

  • YANDEX_MARKET — магазин работает со службой доставки через Яндекс.Маркет.

Для формата XML является атрибутом значения delivery.

]no-highlight]
": "{enum}", "id
[no-highlight[

Значение

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

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

Для формата XML является атрибутом параметра delivery.

]no-highlight]
": "{string}", "outletCode
[no-highlight[

Значение

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

Идентификатор указывается:

Параметр указывается, если значением параметра type является PICKUP.

Для формата XML является атрибутом параметра delivery.

]no-highlight]
": "{string}", "price
[no-highlight[

Значение

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

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

Для формата XML является атрибутом параметра delivery.

]no-highlight]
": {double}, "serviceName
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра delivery.

]no-highlight]
": "{string}", "type
[no-highlight[

Значение

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

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

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

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

  • POST — почта.

Для формата XML является атрибутом параметра delivery.

]no-highlight]
": "{enum}", "vat
[no-highlight[

Значение

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

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

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

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

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

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

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

Для формата XML является атрибутом параметра delivery.

]no-highlight]
": "{enum}", "outletId
[no-highlight[

Значение

Внимание! Параметр устарел и не рекомендуется к использованию. Идентификатор пункта самовывоза указан в параметре outlet-code / outletCode.
]no-highlight]
": {int64}, "address
[no-highlight[

Значение

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

Указывается, если значением параметра type является DELIVERY или POST.

]no-highlight]
": { "postcode
[no-highlight[

Значение

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

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

Для формата XML является атрибутом параметра address.

]no-highlight]
": "{string}", "country
[no-highlight[

Значение

Страна.

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

Для формата XML является атрибутом параметра address.

]no-highlight]
": "{string}", "city
[no-highlight[

Значение

Город или населенный пункт.

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

Для формата XML является атрибутом параметра address.

]no-highlight]
": "{string}", "subway
[no-highlight[

Значение

Станция метро.

Для формата XML является атрибутом параметра address.

]no-highlight]
": "{string}", "street
[no-highlight[

Значение

Улица.

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

Для формата XML является атрибутом параметра address.

]no-highlight]
": "{string}", "house
[no-highlight[

Значение

Дом или владение.

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

Для формата XML является атрибутом параметра address.

]no-highlight]
": "{string}", "block
[no-highlight[

Значение

Корпус или строение.

Для формата XML является атрибутом параметра address.

]no-highlight]
": "{string}", "entrance
[no-highlight[

Значение

Подъезд.

Для формата XML является атрибутом параметра address.

]no-highlight]
": "{string}", "entryphone
[no-highlight[

Значение

Домофон.

Для формата XML является атрибутом параметра address.

]no-highlight]
": "{string}", "floor
[no-highlight[

Значение

Этаж.

Для формата XML является атрибутом параметра address.

]no-highlight]
": "{string}", "apartment
[no-highlight[

Значение

Квартира или офис.

Для формата XML является атрибутом параметра address.

]no-highlight]
": "{string}", "phone
[no-highlight[

Значение

Телефон получателя заказа.

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

Для формата XML является атрибутом параметра address.

]no-highlight]
": "{string}", "recipient
[no-highlight[

Значение

Фамилия, имя и отчество получателя заказа.

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

Для формата XML является атрибутом параметра address.

]no-highlight]
": "{string}" }, "dates
[no-highlight[

Значение

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

]no-highlight]
": { "fromDate
[no-highlight[

Значение

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

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

Для формата XML является атрибутом параметра dates.

]no-highlight]
": "{date}", "toDate
[no-highlight[

Значение

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

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

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

Для формата XML является атрибутом параметра dates.

]no-highlight]
": "{date}" }, "region
[no-highlight[

Значение

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

]no-highlight]
": { "id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра region.

]no-highlight]
": {int64}, "name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра region.

]no-highlight]
": "{string}", "type
[no-highlight[

Значение

Тип региона.

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

  • AREA — область.

  • CITY — крупный город.

  • CONTINENT — континент.

  • COUNTRY — страна.

  • DISCTRICT — район города.

  • MONORAIL_STATION — станция монорельса.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • REGION — регион.

  • REPUBLIC — субъект федерации.

  • REPUBLIC_AREA — район субъекта федерации.

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • SETTLEMENT — поселение.

  • SUBURB — пригород.

  • SUBWAY_STATION — станция метро.

  • TOWN — город.

  • UNKNOWN — неизвестный регион.

Для формата XML является атрибутом параметра region.

]no-highlight]
": "{enum}", "parent
[no-highlight[

Значение

Родительский регион.

Указываются родительские регионы до уровня страны (значением параметра type является COUNTRY).

]no-highlight]
": { "id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра parent.

]no-highlight]
": {int64}, "name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра parent.

]no-highlight]
": "{string}", "type
[no-highlight[

Значение

Тип родительского региона.

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

  • AREA — область.

  • CITY — крупный город.

  • CONTINENT — континент.

  • COUNTRY — страна.

  • DISCTRICT — район города.

  • MONORAIL_STATION — станция монорельса.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • REGION — регион.

  • REPUBLIC — субъект федерации.

  • REPUBLIC_AREA — район субъекта федерации.

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • SETTLEMENT — поселение.

  • SUBURB — пригород.

  • SUBWAY_STATION — станция метро.

  • TOWN — город.

  • UNKNOWN — неизвестный регион.

Для формата XML является атрибутом параметра parent.

]no-highlight]
": "{enum}", "parent
[no-highlight[

Значение

Рекурсивно вложенный элемент для указания родительских регионов более высокого уровня.

]no-highlight]
": { ... } } }, "shipments
[no-highlight[

Значение

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

  • Если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET), в параметре может указываться только одна посылка.

  • Если магазин работает со службой доставки напрямую (delivery-partner-type=SHOP) и является зарубежным, в параметре может указываться несколько посылок.

]no-highlight]
": [ { "depth
[no-highlight[

Значение

Глубина упакованного заказа в сантиметрах.

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

Для формата XML является атрибутом параметра shipment.

]no-highlight]
": {int64}, "height
[no-highlight[

Значение

Высота упакованного заказа в сантиметрах.

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

Для формата XML является атрибутом параметра shipment.

]no-highlight]
": {int64}, "status
[no-highlight[

Значение

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

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

  • CREATED — заказ создан в партнерской службе доставки и по нему получен номер посылки.

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

  • NEW — заявка на создание заказ в службе доставки.

  • READY_TO_SHIP — заказ готов к доставке и по нему получен ярлык.

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

Для формата XML является атрибутом параметра shipment.

]no-highlight]
": "{enum}", "weight
[no-highlight[

Значение

Вес упакованного заказа, отгруженного в партнерскую службу доставки, в граммах.

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

Для формата XML является атрибутом параметра shipment.

]no-highlight]
": {int64}, "width
[no-highlight[

Значение

Ширина упакованного заказа, отгруженного в партнерскую службу доставки, в сантиметрах.

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

Для формата XML является атрибутом параметра shipment.

]no-highlight]
": {int64}, "documents
[no-highlight[

Значение

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

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

]no-highlight]
": [ { "type
[no-highlight[

Значение

Тип документа по заказу.

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

  • LABEL — ярлык заказа в формате PDF.

Для формата XML является атрибутом параметра document.

]no-highlight]
": "{enum}", "url
[no-highlight[

Значение

URL-адрес сопроводительного документа.

Для формата XML является атрибутом параметра document.

]no-highlight]
": "{string}" }, ... ], "items
[no-highlight[

Значение

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

]no-highlight]
": [ { "count": {int32}, "id": {int64} }, ... ], "tracks
[no-highlight[

Значение

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

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

  • один номер, если посылку доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET);

  • пять номеров, если магазин работает со службой доставки напрямую (delivery-partner-type=SHOP) и является зарубежным.

]no-highlight]
": [ { "deliveryServiceId
[no-highlight[

Значение

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

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

Для формата XML является атрибутом параметра track.

]no-highlight]
": {int64}, "trackCode
[no-highlight[

Значение

Номер посылки.

  • Если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET), в параметре передается номер, который передал Яндекс.Маркет.

  • Если магазин работает со службой доставки напрямую (delivery-partner-type=SHOP) и является зарубежным, в параметре передается номер, который передал магазин.

Для формата XML является атрибутом параметра track.

]no-highlight]
": "{string}" }, ... ] }, ... ], "tracks
[no-highlight[

Значение

Внимание! Параметр устарел и не рекомендуется к использованию. Информация для отслеживания перемещений заказа указывается в параметре tracks, вложенном в shipment.
]no-highlight]
": [ { "deliveryServiceId
[no-highlight[
Внимание! Параметр устарел и не рекомендуется к использованию. Идентификатор службы доставки указывается в параметре delivery-service-id / deliveryServiceId, вложенном в shipment.
]no-highlight]
": {int64}, "trackCode
[no-highlight[
Внимание! Параметр устарел и не рекомендуется к использованию. Номер посылки указывается в параметре track-code / trackCode, вложенном в shipment.
]no-highlight]
": "{string}" } ] }, "items
[no-highlight[

Значение

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

]no-highlight]
": [ { "count
[no-highlight[

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

Для формата XML является атрибутом параметра item.

]no-highlight]
": {int32}, "feedCategoryId
[no-highlight[

Значение

Идентификатор категории товара из прайс-листа.

Для формата XML является атрибутом параметра item.

]no-highlight]
": "{string}", "feedId
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра item.

]no-highlight]
": {int64}, "feeUE
[no-highlight[

Значение

Сумма комиссий на все товары заказа, оформленного в рамках программы «Заказ на Маркете», в у. е.

Для формата XML является атрибутом параметра order.

]no-highlight]
": {double}, "id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра order.

]no-highlight]
": {int64}", "offerId
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра item.

]no-highlight]
": "{string}", "offerName
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра item.

]no-highlight]
": "{string}", "price
[no-highlight[

Значение

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

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

Для формата XML является атрибутом параметра delivery.

]no-highlight]
": {double}, "vat
[no-highlight[

Значение

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

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

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

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

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

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

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

Для формата XML является атрибутом параметра delivery.

]no-highlight]
": "{enum}", "promos
[no-highlight[

Значение

Акции в рамках программы «Акции Маркета», в которых участвует товарное предложение магазина.

]no-highlight]
": [ { "marketPromoId
[no-highlight[

Значение

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

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

Для формата XML является атрибутом параметра promo.

]no-highlight]
": "{string}", "subsidy
[no-highlight[

Значение

Компенсация магазину от Яндекс.Маркета за единицу товара, участвующего в программе «Акции Маркета».

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

Для формата XML является атрибутом параметра promo.

]no-highlight]
": {float}, "type
[no-highlight[

Значение

Тип акции.

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

  • MARKET_COUPON — скидка по промокоду от Яндекс.Маркета.

  • MARKET_DEAL — скидка в рамках соглашения на оказание услуг по продвижению сервиса между Яндекс.Маркетом и магазином.

Для формата XML является атрибутом параметра promo.

]no-highlight]
": "{enum}", }, ... ] }, ... ], "notes
[no-highlight[

Значение

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

]no-highlight]
": "{string}" } }

Описание параметров:

Параметр для формата XMLПараметр для формата JSONТипЗначение
response

Ответ.

Параметр выводится только для формата XML.

Параметры, вложенные в response

order order

Описание заказа.

Параметры, вложенные в order

creation-date creationDate Date

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

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

Для формата XML является атрибутом параметра order.

currency currency Enum

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

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

  • BYN — белорусский рубль;

  • KZT — казахстанский тенге;

  • RUR — российский рубль;

  • UAH — украинская гривна.

Для формата XML является атрибутом параметра order.

fake fake Boolean

Тип заказа.

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

  • false — настоящий заказ покупателя или контрольный заказ Маркета;

    Примечание. Информация, что заказ является контрольным, содержится в параметре notes. Такие заказы не тарифицируются Маркетом.
  • true — отладочный заказ или контрольный заказ Маркета.

Для формата XML является атрибутом параметра order.

fee-ue feeUE Double

Сумма комиссий на все товары заказа, оформленного в рамках программы «Заказ на Маркете», в у. е.

Для формата XML является атрибутом параметра order.

id id Int64

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

Для формата XML является атрибутом параметра order.

is-booked isBooked Boolean

Признак, что заказ оформлен в рамках программы «Забронировать на Маркете».

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

  • true — заказ оформлен в рамках программы «Забронировать на Маркете».

Параметр выводится только со значением true.

Для формата XML является атрибутом параметра cart.

items-total itemsTotal Double

Общая сумма заказа в валюте заказа без учета доставки.

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

Для формата XML является атрибутом параметра order.

payment-type paymentType Enum

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

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

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

  • PREPAID — предоплата.

Для формата XML является атрибутом параметра order.

payment-method paymentMethod Enum

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

Возможные значения для типа оплаты POSTPAID:

  • CARD_ON_DELIVERY — оплата банковской картой при получении заказа;

  • CASH_ON_DELIVERY — наличный расчет при получении заказа.

Возможное значение для типа оплаты PREPAID:

  • YANDEX — оплата при оформлении (только для России).

Примечание. Как подключить прием предоплаты по заказам с Маркета, описано в Помощи для магазинов.

Для формата XML является атрибутом параметра order.

status status Enum

Статус заказа.

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

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

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

  • DELIVERY — заказ передан в доставку;

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

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

  • RESERVED — заказ в резерве (ожидается подтверждение от пользователя);

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

Для формата XML является атрибутом параметра order.

substatus substatus Enum

Причина отмены заказа.

Выводится, если параметр status имеет значение CANCELLED.

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

  • PROCESSING_EXPIRED — магазин не обработал заказ вовремя;

  • REPLACING_ORDER — покупатель изменяет состав заказа;

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

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

  • USER_CHANGED_MIND — покупатель отменил заказ по собственным причинам;

  • USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID);

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

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

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

  • USER_UNREACHABLE — не удалось связаться с покупателем.

Для формата XML является атрибутом параметра order.

tax-system taxSystem Enum

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

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

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

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

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

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

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

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

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

Для формата XML является атрибутом параметра order.

total total Double

Общая сумма заказа в валюте заказа с учетом доставки.

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

Для формата XML является атрибутом параметра order.

buyer buyer

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

delivery delivery

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

items items

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

notes notes String

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

Параметры, вложенные в buyer

id id String

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

Для формата XML является атрибутом параметра buyer.

last-name lastName String

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

Для формата XML является атрибутом параметра buyer.

first-name firstName String

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

Для формата XML является атрибутом параметра buyer.

middle-name middleName String

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

Для формата XML является атрибутом параметра buyer.

email email String

Адрес электронной почты покупателя.

Допускается любой адрес электронной почты, соответствующий стандарту RFC 2822.

Для формата XML является атрибутом параметра buyer.

phone phone String

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

Формат номера: +<код_страны><код_региона><номер_телефона>.

Для формата XML является атрибутом параметра buyer.

Параметры, вложенные в delivery

delivery-partner-type deliveryPartnerType Enum

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

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

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

  • YANDEX_MARKET — магазин работает со службой доставки через Яндекс.Маркет.

Для формата XML является атрибутом значения delivery.

id id String

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

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

Для формата XML является атрибутом параметра delivery.

outlet-code outletCode

String

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

Идентификатор указывается:

Параметр указывается, если значением параметра type является PICKUP.

Для формата XML является атрибутом параметра delivery.

price price Double

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

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

Для формата XML является атрибутом параметра delivery.

service-name serviceName String

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

Для формата XML является атрибутом параметра delivery.

type type Enum

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

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

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

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

  • POST — почта.

Для формата XML является атрибутом параметра delivery.

vat vat Enum

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

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

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

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

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

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

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

Для формата XML является атрибутом параметра delivery.

outlet-id outletId Int64
Внимание! Параметр устарел и не рекомендуется к использованию. Идентификатор пункта самовывоза указан в параметре outlet-code / outletCode.
address address

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

Указывается, если значением параметра type является DELIVERY или POST.

dates dates

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

region region

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

shipments shipments

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

  • Если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET), в параметре может указываться только одна посылка.

  • Если магазин работает со службой доставки напрямую (delivery-partner-type=SHOP) и является зарубежным, в параметре может указываться несколько посылок.

tracks tracks
Внимание! Параметр устарел и не рекомендуется к использованию. Информация для отслеживания перемещений заказа указывается в параметре tracks, вложенном в shipment.

Параметры, вложенные в address

postcode postcode String

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

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

Для формата XML является атрибутом параметра address.

country country String

Страна.

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

Для формата XML является атрибутом параметра address.

city city String

Город или населенный пункт.

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

Для формата XML является атрибутом параметра address.

subway subway String

Станция метро.

Для формата XML является атрибутом параметра address.

street street String

Улица.

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

Для формата XML является атрибутом параметра address.

house house String

Дом или владение.

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

Для формата XML является атрибутом параметра address.

block block String

Корпус или строение.

Для формата XML является атрибутом параметра address.

entrance entrance String

Подъезд.

Для формата XML является атрибутом параметра address.

entryphone entryphone String

Домофон.

Для формата XML является атрибутом параметра address.

floor floor String

Этаж.

Для формата XML является атрибутом параметра address.

apartment apartment String

Квартира или офис.

Для формата XML является атрибутом параметра address.

phone phone String

Телефон получателя заказа.

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

Для формата XML является атрибутом параметра address.

recipient recipient String

Фамилия, имя и отчество получателя заказа.

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

Для формата XML является атрибутом параметра address.

Параметры, вложенные в dates

from-date fromDate Date

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

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

Для формата XML является атрибутом параметра dates.

to-date toDate Date

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

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

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

Для формата XML является атрибутом параметра dates.

Параметры, вложенные в region

id id Int64

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

Для формата XML является атрибутом параметра region.

name name String

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

Для формата XML является атрибутом параметра region.

type type Enum

Тип региона.

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

  • AREA — область.

  • CITY — крупный город.

  • CONTINENT — континент.

  • COUNTRY — страна.

  • DISCTRICT — район города.

  • MONORAIL_STATION — станция монорельса.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • REGION — регион.

  • REPUBLIC — субъект федерации.

  • REPUBLIC_AREA — район субъекта федерации.

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • SETTLEMENT — поселение.

  • SUBURB — пригород.

  • SUBWAY_STATION — станция метро.

  • TOWN — город.

  • UNKNOWN — неизвестный регион.

Для формата XML является атрибутом параметра region.

parent parent

Родительский регион.

Указываются родительские регионы до уровня страны (значением параметра type является COUNTRY).

Параметры, вложенные в parent

id id Int64

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

Для формата XML является атрибутом параметра parent.

name name String

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

Для формата XML является атрибутом параметра parent.

type type Enum

Тип родительского региона.

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

  • AREA — область.

  • CITY — крупный город.

  • CONTINENT — континент.

  • COUNTRY — страна.

  • DISCTRICT — район города.

  • MONORAIL_STATION — станция монорельса.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • REGION — регион.

  • REPUBLIC — субъект федерации.

  • REPUBLIC_AREA — район субъекта федерации.

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • SETTLEMENT — поселение.

  • SUBURB — пригород.

  • SUBWAY_STATION — станция метро.

  • TOWN — город.

  • UNKNOWN — неизвестный регион.

Для формата XML является атрибутом параметра parent.

parent parent

Рекурсивно вложенный элемент для указания родительских регионов более высокого уровня.

Параметры, вложенные в shipments

shipment

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

Параметр указывается только для формата XML.

Параметры, вложенные в shipment / shipments

depth depth Int64

Глубина упакованного заказа в сантиметрах.

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

Для формата XML является атрибутом параметра shipment.

height height Int64

Высота упакованного заказа в сантиметрах.

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

Для формата XML является атрибутом параметра shipment.

status status Enum

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

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

  • CREATED — заказ создан в партнерской службе доставки и по нему получен номер посылки.

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

  • NEW — заявка на создание заказ в службе доставки.

  • READY_TO_SHIP — заказ готов к доставке и по нему получен ярлык.

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

Для формата XML является атрибутом параметра shipment.

weight weight Int64

Вес упакованного заказа, отгруженного в партнерскую службу доставки, в граммах.

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

Для формата XML является атрибутом параметра shipment.

width width Int64

Ширина упакованного заказа, отгруженного в партнерскую службу доставки, в сантиметрах.

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

Для формата XML является атрибутом параметра shipment.

documents documents

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

Указывается, если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET).

items items

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

tracks tracks

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

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

  • один номер, если посылку доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET);

  • пять номеров, если магазин работает со службой доставки напрямую (delivery-partner-type=SHOP) и является зарубежным.

Параметры, вложенные в documents

document

Документ по заказу.

Параметр указывается только для формата XML.

Параметры, вложенные в document / documents

type type Enum

Тип документа по заказу.

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

  • LABEL — ярлык заказа в формате PDF.

Для формата XML является атрибутом параметра document.

url url String

URL-адрес сопроводительного документа.

Для формата XML является атрибутом параметра document.

Параметры, вложенные в items

item

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

Параметр указывается только для формата XML.

Параметры, вложенные в item / items

count count Int32

Количество товара в посылке.

Для формата XML является атрибутом параметра item.

id id Int64

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

Для формата XML является атрибутом параметра item.

Параметры, вложенные в tracks

track

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

Параметр указывается только для формата XML.

Параметры, вложенные в track / tracks

delivery-service-id deliveryServiceId Int64

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

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

Для формата XML является атрибутом параметра track.

track-code trackCode String

Номер посылки.

  • Если заказ доставляет служба-партнер Яндекс.Маркета (delivery-partner-type=YANDEX_MARKET), в параметре передается номер, который передал Яндекс.Маркет.

  • Если магазин работает со службой доставки напрямую (delivery-partner-type=SHOP) и является зарубежным, в параметре передается номер, который передал магазин.

Для формата XML является атрибутом параметра track.

Параметры, вложенные в tracks

track
Внимание! Параметр устарел и не рекомендуется к использованию. Информация для отслеживания перемещений заказа указывается в параметре track, вложенном в shipment.

Параметры, вложенные в track / tracks

delivery-service-id deliveryServiceId Int64
Внимание! Параметр устарел и не рекомендуется к использованию. Идентификатор службы доставки указывается в параметре delivery-service-id / deliveryServiceId, вложенном в shipment.
track-code trackCode String
Внимание! Параметр устарел и не рекомендуется к использованию. Номер посылки указывается в параметре track-code / trackCode, вложенном в shipment.

Параметры, вложенные в items

item

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

Параметры, вложенные в item / items

count count Int32

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

Для формата XML является атрибутом параметра item.

feed-category-id feedCategoryId String

Идентификатор категории товара из прайс-листа.

Для формата XML является атрибутом параметра item.

feed-id feedId Int64

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

Для формата XML является атрибутом параметра item.

fee-ue feeUE Double

Комиссия на товар в рамках программы «Заказ на Маркете», в у. е.

Для формата XML атрибутом параметра item.

fee-ue feeUE Double

Комиссия на товар в рамках программы «Заказ на Маркете», в у. е.

Для формата XML атрибутом параметра item.

id id Int64

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

Для формата XML является атрибутом параметра item.

offer-id offerId String

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

Для формата XML является атрибутом параметра item.

offer-name offerName String

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

Для формата XML является атрибутом параметра item.

price price Double

Цена товара в валюте заказа.

Внимание! Для товарных предложений, участвующих в программе «Акции Маркета», в параметре price указывается более низкая цена, которую должен заплатить покупатель. Компенсация магазину от Яндекс.Маркета до цены товара из прайс-листа передается в параметре subsidy.

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

Для формата XML является атрибутом параметра item.

vat vat Enum

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

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

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

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

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

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

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

Для формата XML является атрибутом параметра item.

promos promos

Акции в рамках программы «Акции Маркета», в которых участвует товарное предложение магазина.

Параметры, вложенные в promos

promo

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

Параметры, вложенные в promo / promos

market-promo-id marketPromoId String

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

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

Для формата XML является атрибутом параметра promo.

subsidy subsidy Float

Компенсация магазину от Яндекс.Маркета за единицу товара, участвующего в программе «Акции Маркета».

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

Для формата XML является атрибутом параметра promo.

type type Enum

Тип акции.

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

  • MARKET_COUPON — скидка по промокоду от Яндекс.Маркета.

  • MARKET_DEAL — скидка в рамках соглашения на оказание услуг по продвижению сервиса между Яндекс.Маркетом и магазином.

Для формата XML является атрибутом параметра promo.

Примечание. Для заказов в статусе RESERVED, UNPAID, а также в подстатусах RESERVATION_EXPIRED и USER_NOT_PAID статуса CANCELLED персональная информация о покупателе и получателе заказа недоступна. Не выводятся следующие параметры:
  • параметры apartment, entrance, entryphone, phone и recipient, вложенные в параметр address;

  • параметр buyer и все вложенные в него параметры.

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

В случае возникновения ошибочной ситуации сервер возвращает HTTP-код ответа и краткое описание ошибки (все коды и описания ошибок представлены в разделе Сообщения об ошибках в документации партнерского API Маркета). Характерные для данного метода ошибки:

Описание

Пояснение

Способ возможного решения

Ошибка 400 Bad Request

No permission to set status 'status' for order 'orderId' with status 'currentStatus'

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

Установите статус в соответствии с вашими правами.

Order 'orderId' with status 'currentStatus' is not allowed for status 'status'

Указанный статус невозможно установить из-за текущего статуса заказа (нарушение графа статусов).

Установите статус, переход к которому возможен из текущего статуса.

Order status 'newStatus' must be accompanied with a substatus

Указанный статус должен сопровождаться причиной отмены заказа.

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

Order substatus 'substatus' does not match status 'status'

Указанная причина отмены не соответствует текущему статусу. Причина отмены должна соответствовать статусу.

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

Status 'status' is not allowed for delivery type 'type'

Указанный статус невозможно назначить заказу с текущим типом доставки.

Укажите допустимый для данного типа доставки статус или измените тип доставки.

Unknown status: 'status'

Указан неизвестный статус.

Проверьте корректность передаваемого статуса заказа.

Unknown substatus: 'substatus'

Указана неизвестная причина отмены заказа.

Проверьте корректность передаваемой причины отмены заказа.

Ошибка 403 Forbidden

Access denied

Нет доступа к кампании.

Проверьте корректность идентификатора кампании.

Ошибка 404 Not Found

Order not found: 'orderId'

Заказ с указанным идентификатором не найден.

Проверьте корректность идентификатора заказа.

Примеры

Пример запроса:

curl -i -H 'Content-Type: application/xml' -X PUT 'https://api.partner.market.yandex.ru/v2/campaigns/10003/orders/12345/status.xml'

Тело POST-запроса:

-d '<order status="DELIVERY"/>'

Пример ответа:

HTTP/1.1 200 OK
Date: Thu, 8 Jul 2017 00:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <order creation-date="01-07-2017 00:42:42" currency="RUR" fake="false" id="12345" items-total="3700" payment-type="PREPAID" payment-method="YANDEX" status="DELIVERY" tax-system="OSN" total="4050">
    <buyer id="LEgMQuuxR8" last-name="Иванов" first-name="Иван" middle-name="Иванович" email="ivanov.ivan@yandex.ru" phone="+71234567890"/>
    <delivery delivery-partner-type="YANDEX_MARKET" price="350" service-name="СПСР" type="DELIVERY" vat="VAT_10">
      <address postcode="119313" country="Россия" city="Москва" subway="Проспект Вернадского" street="Ленинский проспект" house="90" entrance="10" entryphone="289" floor="6" apartment="289" phone="+71234567890" recipient="Иванов Иван"/>
      <dates from-date="03-07-2017" to-date="04-07-2017"/>
      <region id="213" name="Москва" type="CITY">
        <parent id="1" name="Москва и Московская область" type="REPUBLIC">
          <parent id="3" name="Центральный федеральный округ" type="AREA">
            <parent id="225" name="Россия" type="COUNTRY"/>
          </parent>
        </parent>
      </region>
      <shipments>
        <shipment depth="22" height="22" status="CREATED" weight="2000" width="22">
          <documents>
            <document type="LABEL" url="/campaigns/10003/orders/12345/labels/196"/>
          </documents>
          <items>
            <item count="1" id="6789"/>
            <item count="1" id="1011"/>
          </items>
          <tracks>
            <track delivery-service-id="12345" track-code="AB012345678RU"/>
          </tracks>
        </shipment>
      </shipments>
    </delivery>
    <items>
      <item count="1" feed-category-id="35" feed-id="12345" offer-id="4609283881" offer-name="Чайник электрический 100 W" price="1200" vat="VAT_18">
        <promos>
          <promo market-promo-id="abc" subsidy="300" type="MARKET_DEAL"/>
        </promos>
      </item>
      <item count="1" feed-category-id="41" feed-id="12345" offer-id="4607632101" offer-name="Тостер" price="2200" vat="VAT_18"/>
    </items>
  </order>
</response>

Пример запроса:

curl -i -H 'Content-Type: application/json' -X PUT 'https://api.partner.market.yandex.ru/v2/campaigns/10003/orders/12345/status.json'

Тело POST-запроса:

-d '{
  "order":
  {
    "status": "DELIVERY"
  }
}'

Пример ответа:

HTTP/1.1 200 OK
Date: Thu, 8 Jul 2017 00:42:42 GMT
Content-Type: application/json;charset=utf-8
...

{
  "order":
  {
    "creationDate": "01-07-2017 00:42:42",
    "currency": "RUR",
    "fake": false,
    "id": 12345,
    "itemsTotal": 3700,
    "paymentType": "PREPAID",
    "paymentMethod": "YANDEX",
    "status": "DELIVERY",
    "taxSystem": "OSN",
    "total": 4050,
    "buyer":
    {
      "id": "LEgMQuuxR8",
      "lastName": "Иванов",
      "firstName": "Иван",
      "middleName": "Иванович",
      "email": "ivanov.ivan@yandex.ru",
      "phone": "+71234567890"
    },
    "delivery":
    {
      "deliveryPartnerType": "YANDEX_MARKET",
      "price": 350,
      "serviceName": "СПСР",
      "type": "DELIVERY",
      "vat": "VAT_10",
      "address":
      {
        "postcode": "119313",
        "country": "Россия",
        "city": "Москва",
        "subway": "Проспект Вернадского",
        "street": "Ленинский проспект",
        "house": "90",
        "entrance": "10",
        "entryphone": "289",
        "floor": "6",
        "apartment": "289",
        "phone": "+71234567890",
        "recipient": "Иванов Иван"
      },
      "dates":
      {
        "fromDate": "03-07-2017",
        "toDate": "04-07-2017"
      },
      "region":
      {
        "id": 213,
        "name": "Москва",
        "type": "CITY",
        "parent":
        {
          "id": 1,
          "name": "Москва и Московская область",
          "type": "REPUBLIC",
          "parent":
          {
            "id": 3,
            "name": "Центральный федеральный округ",
            "type": "AREA",
            "parent":
            {
              "id": 225,
              "name": "Россия",
              "type": "COUNTRY"
            }
          }
        }
      },
      "shipments":
      [
        {
          "depth": 22,
          "height": 22,
          "status": "CREATED",
          "weight": 2000,
          "width": 22,
          "documents":
          [
            {
              "type": "LABEL",
              "url": "/campaigns/10003/orders/12345/labels/196"}
          ],
          "items":
          [
            {
              "count": 1,
              "id": 6789
            },
            {
              "count": 1,
              "id": 1011
            }
          ],
          "tracks":
          [
            {
              "deliveryServiceId": 12345,
              "trackCode": "AB012345678RU"
            }
          ]
        }
      ] 
    },
    "items":
    [
      {
        "count": 1,
        "feedCategoryId": "35",
        "feedId": 12345,
        "offerId": "4609283881",
        "offerName": "Чайник электрический 100 W",
        "price": 1200,
        "vat": "VAT_18",
        "promos":
        [
          {
            "marketPromoId": "abc",
            "subsidy": 300,
            "type": "MARKET_DEAL",
          }
        ]
      },
      {
        "count": 1,
        "feedCategoryId": "41",
        "feedId": 12345,
        "offerId": "4607632101",
        "offerName": "Тостер",
        "price": 2200,
        "vat": "VAT_18"
      }
    ]
  }
}
PUT PUT /campaigns/{campaignId}/orders/{orderId}/status Изменение статуса заказа Статус заказа