Уведомление об отмене заказа покупателем. Партнерский API Яндекс Маркета для модели DBS. Руководство разработчика

Запросы Маркета к магазину

Уведомление об отмене заказа покупателем

Внимание. Маркет постепенно перестает поддерживать XML. Поэтому мы рекомендуем переходить на JSON. Сейчас XML можно использовать, если добавить в запрос Content-Type: application/xml. Без этого будут ошибки.

Описание

POST /order/cancellation/notify

Внимание. Запрос выполняется Маркетом и поддерживает обмен данными только в формате JSON.

Уведомляет магазин о создании покупателем заявки на отмену заказа, который находится в статусе DELIVERY или PICKUP.

Чтобы подтвердить или отклонить заявку на отмену заказа, отправьте запрос PUT /campaigns/{campaignId}/orders/{orderId}/cancellation/accept. Если вы не сделаете этого в течение 48 часов, заказ будет отменен автоматически.

URL ресурса:

https://<URL_запроса>/order/cancellation/notify

Таймаут на получение ответа: 10 секунд.

Передаваемые магазину данные

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

{
  "order":
  {
    "businessId": {int64}, 
    "creationDate": "{date}",
    "currency": "{enum}",
    "fake": {boolean},
    "id": {int64},
    "itemsTotal": {double},
    "paymentType": "{enum}",
    "paymentMethod": "{enum}",
    "status": "{enum}",
    "substatus": "{enum}",
    "taxSystem": "{enum}",
    "total": {double},
    "subsidyTotal": {double},
    "buyer":
    {
      "id": "{string}",
      "lastName": "{string}",
      "firstName": "{string}",
      "middleName": "{string}",
    },
    "delivery":
    {
      "deliveryPartnerType": "{enum}",
      "deliveryServiceId": {int64},
      "shopDeliveryId": "{string}",
      "price": {double},
      "serviceName": "{string}",
      "type": "{enum}",
      "dispatchType": "{enum}",
      "vat": "{enum}",
      "address":
      {
        "country": "{string}",
        "city": "{string}",
        "subway": "{string}",
        "street": "{string}",
        "house": "{string}",
        "block": "{string}",
        "entrance": "{string}",
        "entryphone": "{string}",
        "floor": "{string}",
        "apartment": "{string}",
        "recipient": "{string}"
      },
      "dates":
      {
        "fromDate": "{date}", 
        "toDate": "{date}",
        "fromTime": "{time}",
        "toTime": "{time}"
      },
      "outlet":
      {
        "code": "{string}"
      },
      "region":
      {
        "id": {int32},
        "name": "{string}",
        "type": "{enum}",
        "parent":
        {
          "id": {int32},
          "name": "{string}",
          "type": "{enum}",
          "parent":
          {
            ...
          }
        }
      }
    },
    "items":
    [
      {
        "id": {int64},
        "feedId": {int64},
        "offerId": "{string}",
        "offerName": "{string}",
        "feedCategoryId": "{string}",
        "count": {int32},
        "price": {double},
        "subsidy": {double},
        "vat": "{enum}",
        "promos":
        [
          {
            "type": "{enum}",
            "marketPromoId": "{string}",
            "subsidy": {float}
          },
          ...
        ]
      },
      ...
    ]
  }
}

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


Параметр	Тип	Значение
`order`		Описание заказа.
Параметры, вложенные в order
`businessId`	Int64	Идентификатор бизнеса-аккаунта. Объединяет внутри себя набор параметров partnerId.
`creationDate`	Date	Дата оформления заказа. Формат даты: ДД-ММ-ГГГГ ЧЧ:ММ:СС.
`currency`	Enum	Валюта, в которой выражены цены товаров в заказе. Возможные значения: RUR — российский рубль.
`fake`	Boolean	Тип заказа: false — настоящий заказ покупателя. true — тестовый заказ Маркета.
`id`	Int64	Идентификатор заказа.
`itemsTotal`	Double	Общая сумма заказа в валюте заказа без учета стоимости доставки и вознаграждения партнеру за скидки по промокодам, купонам и акциям (параметр `subsidyTotal`). Для отделения целой части от дробной используется точка.
`paymentType`	Enum	Тип оплаты заказа: PREPAID — оплата при оформлении заказа. POSTPAID — оплата при получении заказа.
`paymentMethod`	Enum	Способ оплаты заказа. Возможные значения, если выбрана оплата при оформлении заказа (`"paymentType": "PREPAID"`): YANDEX — банковской картой. APPLE_PAY — Apple Pay. GOOGLE_PAY — Google Pay. TINKOFF_CREDIT — оформить в кредит. TINKOFF_INSTALLMENTS — оформить в рассрочку. SBP — через систему быстрых платежей. Возможные значения, если выбрана оплата при получении заказа (`"paymentType": "POSTPAID"`): CARD_ON_DELIVERY — банковской картой. CASH_ON_DELIVERY — наличными.
`status`	Enum	Статус заказа: CANCELLED — заказ отменен. PROCESSING — заказ находится в обработке. RESERVED — заказ в резерве (ожидается подтверждение от пользователя). UNPAID — заказ оформлен, но еще не оплачен. Также могут передаваться другие значения. Обрабатывать их не требуется.
`substatus`	Enum	Причина отмены заказа: PROCESSING_EXPIRED — магазин не обработал заказ в течение семи дней. RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. RESERVATION_FAILED — магазин не подтвердил, что готов принять заказ. Например, не ответил или ответил некорректно на запрос о передаче и принятии заказа POST /order/accept. USER_CHANGED_MIND — покупатель отменил заказ по собственным причинам. USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут. USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с причиной USER_UNREACHABLE необходимо выполнить условия: не менее 3 звонков с 8 до 21 в часовом поясе покупателя; перерыв между первым и третьим звонком не менее 90 минут; соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. Также могут передаваться другие значения. Обрабатывать их не требуется.
`taxSystem`	Enum	Система налогообложения (СНО) магазина на момент оформления заказа: ECHN — единый сельскохозяйственный налог (ЕСХН). ENVD — единый налог на вмененный доход (ЕНВД). OSN — общая система налогообложения (ОСН). PSN — патентная система налогообложения (ПСН). USN — упрощенная система налогообложения (УСН). USN_MINUS_COST — упрощенная система налогообложения, доходы, уменьшенные на величину расходов (УСН «Доходы минус расходы»).
`total`	Double	Общая сумма заказа в валюте заказа с учетом стоимости доставки, но без учета вознаграждения партнеру за скидки по промокодам, купонам и акциям (параметр `subsidyTotal`). Для отделения целой части от дробной используется точка.
`subsidyTotal`	Double	Общее вознаграждение партнеру за скидки по промокодам, купонам и акциям. Передается в валюте, указанной в параметре currency. Для отделения целой части от дробной используется точка.
`buyer`		Информация о покупателе.
`delivery`		Информация о доставке.
`items`		Список товаров в заказе.
Параметры, вложенные в buyer
`id`	String	Идентификатор покупателя.
`lastName`	String	Фамилия покупателя.
`firstName`	String	Имя покупателя.
`middleName`	String	Отчество покупателя.
Параметры, вложенные в delivery
`dispatchType`	Enum	Способ отгрузки: BUYER — доставка покупателю. MARKET_BRANDED_OUTLET — доставка в пункт выдачи заказов Маркета. SHOP_OUTLET — доставка в пункт выдачи заказов магазина.
`deliveryPartnerType`	Enum	Тип сотрудничества со службой доставки в рамках конкретного заказа: SHOP — магазин работает со службой доставки напрямую или доставляет заказы самостоятельно.
`deliveryServiceId`	Enum	Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса GET /delivery/services.
`shopDeliveryId`	String	Идентификатор доставки, присвоенный магазином. Передается, только если магазин передал данный идентификатор в ответе на запрос POST /cart, в параметре id, вложенном в deliveryOptions.
`price`	Double	Маркет всегда передает в этом поле 0 — поле устарело и не используется, в будущем будет удалено. До 1 июля 2021 в нем возвращалась ваша стоимость доставки заказа. Сейчас Маркет рассчитывает ее автоматически, по единому тарифу на доставку: нажмите, чтобы прочитать подробности.
`serviceName`	String	Наименование службы доставки.
`type`	Enum	Способ доставки заказа. Возможные значения: DELIVERY — курьерская доставка. PICKUP — самовывоз.
`vat`	Enum	Ставка налога на добавленную стоимость (НДС) на услугу доставки заказа: NO_VAT — НДС не облагается, используется только для отдельных видов услуг. VAT_0 — НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров. VAT_10 — НДС 10%. Применяется для некоторых товаров, например, для лекарств. VAT_10_110 — НДС 10/110. Расчетная ставка НДС 10%, применяется только для случая предоплаты. VAT_20 — НДС 20%. Основная ставка НДС. VAT_20_120 — НДС 20/120. Расчетная ставка НДС 20%, применяется только для случая предоплаты.
`address`		Адрес доставки. Передается, если параметр `type` имеет значение DELIVERY.
`dates`		Диапазон дат доставки.
`outlet`		Пункт самовывоза, выбранный покупателем для получения заказа. Не возвращается в ответе, если покупатель выбрал получение заказа в брендированном пункте выдачи заказов Маркета (значение MARKET_BRANDED_OUTLET параметра `dispatchType`).
`region`		Регион доставки.
Параметры, вложенные в address
`country`	String	Страна.
`city`	String	Город или населенный пункт.
`subway`	String	Станция метро.
`street`	String	Улица.
`house`	String	Дом или владение.
`block`	String	Корпус или строение.
`entrance`	String	Подъезд.
`entryphone`	String	Код домофона.
`floor`	String	Этаж.
`apartment`	String	Квартира или офис.
`recipient`	String	Фамилия, имя и отчество получателя заказа.
Параметры, вложенные в dates
`fromDate`	Date	Ближайшая возможная дата доставки. Формат даты: ДД-ММ-ГГГГ.
`toDate`	Date	Самая поздняя дата доставки. Формат: ДД-ММ-ГГГГ.
`fromTime`	Time	Начало интервала времени доставки. Формат времени: 24-часовой, ЧЧ:ММ. В качестве минут всегда указано 00 (исключение — 23:59).
`toTime`	Time	Конец интервала времени доставки. Формат времени: 24-часовой, ЧЧ:ММ. В качестве минут всегда указано 00 (исключение — 23:59).
Параметры, вложенные в outlet
`code`	String	Идентификатор пункта самовывоза, присвоенный магазином.
Параметры, вложенные в region
`id`	Int32	Идентификатор региона.
`name`	String	Название региона.
`type`	Enum	Тип региона. Возможные значения: `CITY` — город. `CITY_DISTRICT` — район города. `CONTINENT` — континент. `COUNTRY` — страна. `COUNTRY_DISTRICT` — федеральный округ. `METRO_STATION` — станция метро. `MONORAIL_STATION` — станция монорельса. `OTHERS_UNIVERSAL` — другой тип населенного пункта. `OVERSEAS_TERRITORY` — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.). `REGION` — регион. `SECONDARY_DISTRICT` — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.). `SETTLEMENT` — поселение. `SUBJECT_FEDERATION` — субъект федерации. `SUBJECT_FEDERATION_DISTRICT` — район субъекта федерации. `SUBURB` — пригород. `VILLAGE` — село.
`parent`		Родительский регион. Указываются родительские регионы до уровня страны включительно (`"type": "COUNTRY"`).
Параметры, вложенные в parent
`id`	Int32	Идентификатор родительского региона.
`name`	String	Название родительского региона.
`type`	Enum	Тип родительского региона. Возможные значения: `CITY` — город. `CITY_DISTRICT` — район города. `CONTINENT` — континент. `COUNTRY` — страна. `COUNTRY_DISTRICT` — федеральный округ. `METRO_STATION` — станция метро. `MONORAIL_STATION` — станция монорельса. `OTHERS_UNIVERSAL` — другой тип населенного пункта. `OVERSEAS_TERRITORY` — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.). `REGION` — регион. `SECONDARY_DISTRICT` — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.). `SETTLEMENT` — поселение. `SUBJECT_FEDERATION` — субъект федерации. `SUBJECT_FEDERATION_DISTRICT` — район субъекта федерации. `SUBURB` — пригород. `VILLAGE` — село.
`parent`		Рекурсивно вложенный элемент для указания родительских регионов более высокого уровня.
Параметры, вложенные в items
`id`	Int64	Идентификатор товара в заказе.
`feedId`	Int64	Идентификатор прайс-листа, содержащего предложение.
`offerId`	String	Идентификатор предложения из прайс-листа.
`offerName`	String	Название товара.
`feedCategoryId`	String	Идентификатор категории, указанной в прайс-листе.
`count`	Int32	Количество единиц товара.
`price`	Double	Цена товара в валюте заказа. Для отделения целой части от дробной используется точка.
`subsidy`	Double	Общее вознаграждение партнеру за все скидки на товар по промокодам, купонам и акциям. Передается в валюте заказа, для отделения целой части от дробной используется точка.
`vat`	Enum	Ставка налога на добавленную стоимость (НДС) на товар. Используется только совместно с параметром `"paymentMethod": "YANDEX"`. Возможные значения: NO_VAT — НДС не облагается, используется только для отдельных видов услуг. VAT_0 — НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров. VAT_10 — НДС 10%. Применяется для некоторых товаров, например, для лекарств. VAT_10_110 — НДС 10/110. Расчетная ставка НДС 10%, применяется только для случая предоплаты. VAT_20 — НДС 20%. Основная ставка НДС. VAT_20_120 — НДС 20/120. Расчетная ставка НДС 20%, применяется только для случая предоплаты.
`promos`		Информация о вознаграждениях партнеру за скидки на товар по промокодам, купонам и акциям.
Параметры, вложенные в promos
`type`	Enum	Тип скидки: MARKET_COUPON — скидка по промокоду от Маркета. MARKET_DEAL — скидка в рамках соглашения на оказание услуг по продвижению сервиса между Маркетом и партнером. MARKET_COIN — скидка по купонам.
`marketPromoId`	String	Идентификатор акции в рамках соглашения на оказание услуг по продвижению сервиса между Маркетом и партнером. Параметр передается, только если параметр `type` имеет значение MARKET_DEAL.
`subsidy`	Float	Вознаграждение партнеру за скидку. Передается в валюте заказа, для отделения целой части от дробной используется точка.


Параметр	Тип	Значение
`order`		Описание заказа.
Параметры, вложенные в order
`businessId`	Int64	Идентификатор бизнеса-аккаунта. Объединяет внутри себя набор параметров partnerId.
`creationDate`	Date	Дата оформления заказа. Формат даты: ДД-ММ-ГГГГ ЧЧ:ММ:СС.
`currency`	Enum	Валюта, в которой выражены цены товаров в заказе. Возможные значения: RUR — российский рубль.
`fake`	Boolean	Тип заказа: false — настоящий заказ покупателя. true — тестовый заказ Маркета.
`id`	Int64	Идентификатор заказа.
`itemsTotal`	Double	Общая сумма заказа в валюте заказа без учета стоимости доставки и вознаграждения партнеру за скидки по промокодам, купонам и акциям (параметр `subsidyTotal`). Для отделения целой части от дробной используется точка.
`paymentType`	Enum	Тип оплаты заказа: PREPAID — оплата при оформлении заказа. POSTPAID — оплата при получении заказа.
`paymentMethod`	Enum	Способ оплаты заказа. Возможные значения, если выбрана оплата при оформлении заказа (`"paymentType": "PREPAID"`): YANDEX — банковской картой. APPLE_PAY — Apple Pay. GOOGLE_PAY — Google Pay. TINKOFF_CREDIT — оформить в кредит. TINKOFF_INSTALLMENTS — оформить в рассрочку. SBP — через систему быстрых платежей. Возможные значения, если выбрана оплата при получении заказа (`"paymentType": "POSTPAID"`): CARD_ON_DELIVERY — банковской картой. CASH_ON_DELIVERY — наличными.
`status`	Enum	Статус заказа: CANCELLED — заказ отменен. PROCESSING — заказ находится в обработке. RESERVED — заказ в резерве (ожидается подтверждение от пользователя). UNPAID — заказ оформлен, но еще не оплачен. Также могут передаваться другие значения. Обрабатывать их не требуется.
`substatus`	Enum	Причина отмены заказа: PROCESSING_EXPIRED — магазин не обработал заказ в течение семи дней. RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. RESERVATION_FAILED — магазин не подтвердил, что готов принять заказ. Например, не ответил или ответил некорректно на запрос о передаче и принятии заказа POST /order/accept. USER_CHANGED_MIND — покупатель отменил заказ по собственным причинам. USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут. USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с причиной USER_UNREACHABLE необходимо выполнить условия: не менее 3 звонков с 8 до 21 в часовом поясе покупателя; перерыв между первым и третьим звонком не менее 90 минут; соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. Также могут передаваться другие значения. Обрабатывать их не требуется.
`taxSystem`	Enum	Система налогообложения (СНО) магазина на момент оформления заказа: ECHN — единый сельскохозяйственный налог (ЕСХН). ENVD — единый налог на вмененный доход (ЕНВД). OSN — общая система налогообложения (ОСН). PSN — патентная система налогообложения (ПСН). USN — упрощенная система налогообложения (УСН). USN_MINUS_COST — упрощенная система налогообложения, доходы, уменьшенные на величину расходов (УСН «Доходы минус расходы»).
`total`	Double	Общая сумма заказа в валюте заказа с учетом стоимости доставки, но без учета вознаграждения партнеру за скидки по промокодам, купонам и акциям (параметр `subsidyTotal`). Для отделения целой части от дробной используется точка.
`subsidyTotal`	Double	Общее вознаграждение партнеру за скидки по промокодам, купонам и акциям. Передается в валюте, указанной в параметре currency. Для отделения целой части от дробной используется точка.
`buyer`		Информация о покупателе.
`delivery`		Информация о доставке.
`items`		Список товаров в заказе.
Параметры, вложенные в buyer
`id`	String	Идентификатор покупателя.
`lastName`	String	Фамилия покупателя.
`firstName`	String	Имя покупателя.
`middleName`	String	Отчество покупателя.
Параметры, вложенные в delivery
`dispatchType`	Enum	Способ отгрузки: BUYER — доставка покупателю. MARKET_BRANDED_OUTLET — доставка в пункт выдачи заказов Маркета. SHOP_OUTLET — доставка в пункт выдачи заказов магазина.
`deliveryPartnerType`	Enum	Тип сотрудничества со службой доставки в рамках конкретного заказа: SHOP — магазин работает со службой доставки напрямую или доставляет заказы самостоятельно.
`deliveryServiceId`	Enum	Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса GET /delivery/services.
`shopDeliveryId`	String	Идентификатор доставки, присвоенный магазином. Передается, только если магазин передал данный идентификатор в ответе на запрос POST /cart, в параметре id, вложенном в deliveryOptions.
`price`	Double	Маркет всегда передает в этом поле 0 — поле устарело и не используется, в будущем будет удалено. До 1 июля 2021 в нем возвращалась ваша стоимость доставки заказа. Сейчас Маркет рассчитывает ее автоматически, по единому тарифу на доставку: нажмите, чтобы прочитать подробности.
`serviceName`	String	Наименование службы доставки.
`type`	Enum	Способ доставки заказа. Возможные значения: DELIVERY — курьерская доставка. PICKUP — самовывоз.
`vat`	Enum	Ставка налога на добавленную стоимость (НДС) на услугу доставки заказа: NO_VAT — НДС не облагается, используется только для отдельных видов услуг. VAT_0 — НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров. VAT_10 — НДС 10%. Применяется для некоторых товаров, например, для лекарств. VAT_10_110 — НДС 10/110. Расчетная ставка НДС 10%, применяется только для случая предоплаты. VAT_20 — НДС 20%. Основная ставка НДС. VAT_20_120 — НДС 20/120. Расчетная ставка НДС 20%, применяется только для случая предоплаты.
`address`		Адрес доставки. Передается, если параметр `type` имеет значение DELIVERY.
`dates`		Диапазон дат доставки.
`outlet`		Пункт самовывоза, выбранный покупателем для получения заказа. Не возвращается в ответе, если покупатель выбрал получение заказа в брендированном пункте выдачи заказов Маркета (значение MARKET_BRANDED_OUTLET параметра `dispatchType`).
`region`		Регион доставки.
Параметры, вложенные в address
`country`	String	Страна.
`city`	String	Город или населенный пункт.
`subway`	String	Станция метро.
`street`	String	Улица.
`house`	String	Дом или владение.
`block`	String	Корпус или строение.
`entrance`	String	Подъезд.
`entryphone`	String	Код домофона.
`floor`	String	Этаж.
`apartment`	String	Квартира или офис.
`recipient`	String	Фамилия, имя и отчество получателя заказа.
Параметры, вложенные в dates
`fromDate`	Date	Ближайшая возможная дата доставки. Формат даты: ДД-ММ-ГГГГ.
`toDate`	Date	Самая поздняя дата доставки. Формат: ДД-ММ-ГГГГ.
`fromTime`	Time	Начало интервала времени доставки. Формат времени: 24-часовой, ЧЧ:ММ. В качестве минут всегда указано 00 (исключение — 23:59).
`toTime`	Time	Конец интервала времени доставки. Формат времени: 24-часовой, ЧЧ:ММ. В качестве минут всегда указано 00 (исключение — 23:59).
Параметры, вложенные в outlet
`code`	String	Идентификатор пункта самовывоза, присвоенный магазином.
Параметры, вложенные в region
`id`	Int32	Идентификатор региона.
`name`	String	Название региона.
`type`	Enum	Тип региона. Возможные значения: `CITY` — город. `CITY_DISTRICT` — район города. `CONTINENT` — континент. `COUNTRY` — страна. `COUNTRY_DISTRICT` — федеральный округ. `METRO_STATION` — станция метро. `MONORAIL_STATION` — станция монорельса. `OTHERS_UNIVERSAL` — другой тип населенного пункта. `OVERSEAS_TERRITORY` — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.). `REGION` — регион. `SECONDARY_DISTRICT` — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.). `SETTLEMENT` — поселение. `SUBJECT_FEDERATION` — субъект федерации. `SUBJECT_FEDERATION_DISTRICT` — район субъекта федерации. `SUBURB` — пригород. `VILLAGE` — село.
`parent`		Родительский регион. Указываются родительские регионы до уровня страны включительно (`"type": "COUNTRY"`).
Параметры, вложенные в parent
`id`	Int32	Идентификатор родительского региона.
`name`	String	Название родительского региона.
`type`	Enum	Тип родительского региона. Возможные значения: `CITY` — город. `CITY_DISTRICT` — район города. `CONTINENT` — континент. `COUNTRY` — страна. `COUNTRY_DISTRICT` — федеральный округ. `METRO_STATION` — станция метро. `MONORAIL_STATION` — станция монорельса. `OTHERS_UNIVERSAL` — другой тип населенного пункта. `OVERSEAS_TERRITORY` — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.). `REGION` — регион. `SECONDARY_DISTRICT` — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.). `SETTLEMENT` — поселение. `SUBJECT_FEDERATION` — субъект федерации. `SUBJECT_FEDERATION_DISTRICT` — район субъекта федерации. `SUBURB` — пригород. `VILLAGE` — село.
`parent`		Рекурсивно вложенный элемент для указания родительских регионов более высокого уровня.
Параметры, вложенные в items
`id`	Int64	Идентификатор товара в заказе.
`feedId`	Int64	Идентификатор прайс-листа, содержащего предложение.
`offerId`	String	Идентификатор предложения из прайс-листа.
`offerName`	String	Название товара.
`feedCategoryId`	String	Идентификатор категории, указанной в прайс-листе.
`count`	Int32	Количество единиц товара.
`price`	Double	Цена товара в валюте заказа. Для отделения целой части от дробной используется точка.
`subsidy`	Double	Общее вознаграждение партнеру за все скидки на товар по промокодам, купонам и акциям. Передается в валюте заказа, для отделения целой части от дробной используется точка.
`vat`	Enum	Ставка налога на добавленную стоимость (НДС) на товар. Используется только совместно с параметром `"paymentMethod": "YANDEX"`. Возможные значения: NO_VAT — НДС не облагается, используется только для отдельных видов услуг. VAT_0 — НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров. VAT_10 — НДС 10%. Применяется для некоторых товаров, например, для лекарств. VAT_10_110 — НДС 10/110. Расчетная ставка НДС 10%, применяется только для случая предоплаты. VAT_20 — НДС 20%. Основная ставка НДС. VAT_20_120 — НДС 20/120. Расчетная ставка НДС 20%, применяется только для случая предоплаты.
`promos`		Информация о вознаграждениях партнеру за скидки на товар по промокодам, купонам и акциям.
Параметры, вложенные в promos
`type`	Enum	Тип скидки: MARKET_COUPON — скидка по промокоду от Маркета. MARKET_DEAL — скидка в рамках соглашения на оказание услуг по продвижению сервиса между Маркетом и партнером. MARKET_COIN — скидка по купонам.
`marketPromoId`	String	Идентификатор акции в рамках соглашения на оказание услуг по продвижению сервиса между Маркетом и партнером. Параметр передается, только если параметр `type` имеет значение MARKET_DEAL.
`subsidy`	Float	Вознаграждение партнеру за скидку. Передается в валюте заказа, для отделения целой части от дробной используется точка.

Внимание. Для заказов в статусах RESERVED и UNPAID, а также в подстатусах RESERVATION_EXPIRED и USER_NOT_PAID статуса CANCELLED персональная информация о покупателе и получателе заказа недоступна. Не выводятся следующие параметры:

параметры apartment, entrance, entryphone и recipient, вложенные в параметр address;
параметр buyer и все вложенные в него параметры.

Ответные данные от магазина

Не ожидаются.

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

Магазин может вернуть следующие статусы ответов:


Описание	Пояснение
Ошибка `400 Bad Request`	Если магазин считает запрос, поступающий от Маркета, некорректным, магазин должен вернуть статус ответа 400 с описанием причины ошибки в теле ответа. Такие ответы будут анализироваться на предмет нарушений и недоработок API со стороны Маркета.
Ошибка `404 Not Found`	Если магазин не реализует метод, то может вернуть статус ответа 404. Такие ответы не будут рассматриваться Маркетом как нарушение реализации API.
Ошибка `500 Internal Server Error`	В случае технической ошибки на стороне магазина он должен вернуть статус ответа 500. Магазины с большим количеством таких ответов могут быть отключены от Маркета.


Описание	Пояснение
Ошибка `400 Bad Request`	Если магазин считает запрос, поступающий от Маркета, некорректным, магазин должен вернуть статус ответа 400 с описанием причины ошибки в теле ответа. Такие ответы будут анализироваться на предмет нарушений и недоработок API со стороны Маркета.
Ошибка `404 Not Found`	Если магазин не реализует метод, то может вернуть статус ответа 404. Такие ответы не будут рассматриваться Маркетом как нарушение реализации API.
Ошибка `500 Internal Server Error`	В случае технической ошибки на стороне магазина он должен вернуть статус ответа 500. Магазины с большим количеством таких ответов могут быть отключены от Маркета.

Примеры

Запрос от Маркета:

POST /order/cancellation/notify

Тело POST-запроса:

{
  "order":
  {
    "businessId": 495291,  
    "creationDate": "15-09-2020 00:42:42",
    "currency": "RUR",
    "fake": false,
    "id": 12345,
    "itemsTotal": 3400,
    "paymentType": "PREPAID",
    "paymentMethod": "YANDEX",
    "status": "PROCESSING",
    "taxSystem": "OSN",
    "total": 3750,
    "subsidyTotal": 300,
    "buyer":
    {
      "id": "LEgMQuuxR8",
      "lastName": "Иванов",
      "firstName": "Иван",
      "middleName": "Иванович",
    },
    "delivery":
    {
      "price": 350,
      "serviceName": "СПСР",
      "type": "DELIVERY",
      "dispatchType": "BUYER",
      "vat": "VAT_10",
      "address":
      {
        "country": "Россия",
        "city": "Москва",
        "subway": "Проспект Вернадского",
        "street": "Ленинский проспект",
        "house": "90",
        "floor": "6"
      },
      "dates":
      {
        "fromDate": "15-09-2020",
        "toDate": "15-09-2020",
        "fromTime": "09:00",
        "toTime": "21:00"
      },
      "region":
      {
        "id": 213,
        "name": "Москва",
        "type": "CITY",
        "parent":
        {
          "id": 1,
          "name": "Москва и Московская область",
          "type": "SUBJECT_FEDERATION",
          "parent":
          {
            "id": 3,
            "name": "Центральный федеральный округ",
            "type": "COUNTRY_DISTRICT",
            "parent":
            {
              "id": 225,
              "name": "Россия",
              "type": "COUNTRY"
            }
          }
        }
      }
    },
    "items":
    [
      {
        "count": 1,
        "feedCategoryId": "35",
        "feedId": 12345,
        "offerId": "4609283881",
        "offerName": "Чайник электрический 100 W",
        "price": 1200,
        "vat": "VAT_20",
        "promos":
        [
          {
            "marketPromoId": "abc",
            "subsidy": 300,
            "type": "MARKET_DEAL",
          }
        ]
      },
      {
        "count": 1,
        "feedCategoryId": "41",
        "feedId": 12345,
        "offerId": "4607632101",
        "offerName": "Тостер",
        "price": 2200,
        "vat": "VAT_20"
      }
    ]
  }
}

Ответ магазина:

HTTP/1.1 200 OK

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

Расскажите, что вам не понравилось в статье:

Уведомление о смене статуса заказа

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

В этой статье

Описание Передаваемые магазину данные Ответные данные от магазина Описание ошибок Примеры

Уведомление о смене статуса заказа

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