Уведомление о смене статуса заказа
- Описание
- Передаваемые магазину данные
- Параметры, вложенные в order
- Параметры, вложенные в buyer
- Параметры, вложенные в delivery
- Параметры, вложенные в shipments
- Параметры, вложенные в address
- Параметры, вложенные в dates
- Параметры, вложенные в outlet
- Параметры, вложенные в region
- Параметры, вложенные в courier
- Параметры, вложенные в boxes
- Параметры, вложенные в items
- Параметры, вложенные в instances
- Параметры, вложенные в promos
- Ответные данные от магазина
- Описание ошибок
- Примеры
Описание
POST order/status
Уведомляет магазин о смене статуса заказа.
URL ресурса:
https://<URL_запроса>/order/status
Таймаут на получение ответа: 10 секунд.
Передаваемые магазину данные
Порядок следования параметров не гарантируется.
{
"order":
{
"businessId": {int64},
"creationDate": "{date}",
"currency": "{enum}",
"fake": {boolean},
"id": {int64},
"paymentType": "{enum}",
"paymentMethod": "{enum}",
"status": "{enum}",
"substatus": "{enum}",
"vehicleNumber": "{string}",
"taxSystem": "{enum}",
"buyerItemsTotalBeforeDiscount": {double},
"buyerTotalBeforeDiscount": {double},
"buyerItemsTotal": {double},
"buyerTotal": {double},
"itemsTotal": {double},
"total": {double},
"subsidyTotal": {double},
"totalWithSubsidy": {double},
"deliveryTotal": {double},
"delivery":
{
"deliveryPartnerType": "{enum}",
"courier":
{
"fullName": "{string}",
"phone": "{string}",
"phoneExtension": "{string}",
"vehicleNumber": "{string}",
"vehicleDescription": "{string}"
},
"deliveryServiceId": {int64},
"id": "{string}",
"serviceName": "{string}",
"type": "{enum}",
"region":
{
"id": {int32},
"name": "{string}",
"type": "{enum}",
"parent":
{
"id": {int32},
"name": "{string}",
"type": "{enum}",
"parent":
{
...
}
}
},
"shipments":
[
{
"id": {int64},
"shipmentDate": "{date}",
"depth": {int64},
"height": {int64},
"status": "{enum}",
"weight": {int64},
"width": {int64}
"boxes":
[
{
"id": {int64}
},
...
]
},
...
]
},
"items":
[
{
"count": {int32},
"feedId": {int64},
"offerId": "{string}",
"price": {double},
"buyer-price": {double},
"buyerPriceBeforeDiscount": {double},
"priceBeforeDiscount": {double},
"subsidy": {double},
"vat": "{enum}",
"warehouseId": {int64},
"partnerWarehouseId": "{string}",
"instances":
[
{
"cis": "{string}"
},
...
],
"promos":
[
{
"marketPromoId": "{string}",
"subsidy": {float},
"type": "{enum}"
},
...
]
},
...
],
"electronicAcceptanceCertificateCode": "{string}",
"notes": "{string}"
}
}
{
"order":
{
"businessId": {int64},
"creationDate": "{date}",
"currency": "{enum}",
"fake": {boolean},
"id": {int64},
"itemsTotal": {double},
"paymentType": "{enum}",
"paymentMethod": "{enum}",
"status": "{enum}",
"substatus": "{enum}",
"taxSystem": "{enum}",
"buyerItemsTotalBeforeDiscount": {double},
"buyerTotalBeforeDiscount": {double},
"buyerItemsTotal": {double},
"buyerTotal": {double},
"itemsTotal": {double},
"totalWithSubsidy": {double},
"deliveryTotal": {double},
"total": {double},
"subsidyTotal": {double},
"buyer":
{
"id": "{string}",
"lastName": "{string}",
"firstName": "{string}",
"middleName": "{string}"
},
"delivery":
{
"dispatchType": "{enum}",
"deliveryPartnerType": "{enum}",
"deliveryServiceId": {int64},
"shopDeliveryId": "{string}",
"price": {double},
"serviceName": "{string}",
"type": "{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}",
"fulfilmentShopId": {int64},
"count": {int32},
"price": {double},
"buyer-price": {double},
"buyerPriceBeforeDiscount": {double},
"priceBeforeDiscount": {double},
"subsidy": {double},
"vat": "{enum}",
"promos":
[
{
"type": "{enum}",
"marketPromoId": "{string}",
"subsidy": {float}
},
...
]
},
...
],
"notes": "{string}"
}
}
|
Параметр |
Тип |
Значение |
|
|
Описание заказа. |
Параметры, вложенные в order
|
Параметр |
Тип |
Значение |
|
|
Int64 |
Идентификатор бизнеса-аккаунта. |
|
|
Date |
Дата и время оформления заказа. Формат даты и времени: ДД-ММ-ГГГГ ЧЧ:ММ:СС. Часовой пояс — UTC+03:00 (Москва). |
|
|
Enum |
Валюта, в которой выражены цены товаров в заказе. Возможные значения:
|
|
|
Boolean |
Тип заказа. Возможные значения:
|
|
|
Int64 |
Идентификатор заказа. |
|
|
Enum |
Тип оплаты заказа. Возможные значения:
Если параметр отсутствует, заказ будет оплачен при получении. |
|
|
Enum |
Способ оплаты заказа.
Возможные значения, если выбрана оплата при оформлении заказа (
Возможные значения, если выбрана оплата при получении заказа (
Значение по умолчанию:
|
|
|
Enum |
FBS
DBS
Статус заказа:
Также могут передаваться другие значения. Обрабатывать их не требуется. Статус заказа:
Также могут передаваться другие значения. Обрабатывать их не требуется. |
|
|
Enum |
FBS
DBS
Указывает:
Возможные значения для заказа в статусе
Возможные значения для заказа в статусе
Возможные значения для заказа в статусе
Возможные значения для заказа в статусе
Подстатус актуален только для заказов с типом доставки почтой, в пункт выдачи заказов и постаматы.
Подстатус не является финальным. Если пользователь вернет заказ, подстатус изменится на Также могут передаваться другие значения. Обрабатывать их не требуется. Причины отмены заказа:
Также могут передаваться другие значения. Обрабатывать их не требуется. |
|
FBS |
String |
Номер автомобиля службы доставки. Если курьер пеший, в элементе возвращается значение |
|
|
Enum |
Система налогообложения (СНО) магазина на момент оформления заказа. Используется только совместно с параметром Возможные значения:
|
|
|
Double |
Стоимость всех товаров в заказе в валюте покупателя:
|
|
|
Double |
Стоимость всех товаров в заказе в валюте покупателя:
|
|
|
Double |
Стоимость всех товаров в заказе в валюте покупателя:
|
|
|
Double |
Стоимость всех товаров в заказе в валюте покупателя:
|
|
|
Double |
Стоимость всех товаров в заказе в валюте магазина:
|
|
|
Double |
Стоимость всех товаров в заказе в валюте магазина:
|
|
|
Double |
Общее вознаграждение партнеру за скидки по всем товарам в заказе:
Передается в валюте, указанной в параметре Для отделения целой части от дробной используется точка. |
|
|
Double |
Сумма стоимости всех товаров в заказе и вознаграждения за них в валюте магазина (сумма параметров |
|
|
Double |
Стоимость доставки в валюте заказа. Для отделения целой части от дробной используется точка. |
|
|
Информация о доставке. |
|
|
|
Список товаров в заказе. |
|
|
FBS |
String |
Шестизначный код подтверждения для:
Подробно о работе с кодами рассказано в Справке для продавцов. |
|
|
String |
Комментарий к заказу. |
|
|
Информация о покупателе. |
Параметры, вложенные в buyer
|
Параметр |
Тип |
Значение |
|
|
enum |
Тип плательщика: |
|
Параметр |
Тип |
Значение |
|
|
String |
Идентификатор покупателя. |
|
|
String |
Фамилия покупателя. |
|
|
String |
Имя покупателя. |
|
|
String |
Отчество покупателя. |
Параметры, вложенные в delivery
|
Параметр |
Тип |
Значение |
|
|
Enum |
Тип сотрудничества со службой доставки в рамках конкретного заказа. Возможные значения:
|
|
|
Enum |
Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса GET delivery/services. |
|
|
String |
Идентификатор доставки. |
|
|
String |
Наименование службы доставки. |
|
|
Enum |
Способ доставки заказа. Возможные значения:
|
|
|
Регион доставки. |
|
|
|
Список посылок. |
|
|
|
Информация о курьере. |
|
Параметр |
Тип |
Значение |
|
|
Enum |
Способ отгрузки:
|
|
|
Enum |
Тип сотрудничества со службой доставки в рамках конкретного заказа:
|
|
|
Enum |
Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса GET delivery/services. |
|
|
String |
Идентификатор доставки, присвоенный магазином. Передается, только если магазин передал данный идентификатор в ответе на запрос POST cart, в параметре |
|
|
Double |
Маркет всегда передает в этом поле 0 — поле устарело и не используется, в будущем будет удалено. До 1 июля 2021 в нем возвращалась ваша стоимость доставки заказа. Сейчас Маркет рассчитывает ее автоматически, по единому тарифу на доставку. Подробнее о тарифе на доставку |
|
|
String |
Наименование службы доставки. |
|
|
Enum |
Способ доставки заказа. Возможные значения:
|
|
|
Enum |
Ставка налога на добавленную стоимость (НДС) на услугу доставки заказа:
|
|
|
Адрес доставки. Передается, если параметр |
|
|
|
Диапазон дат доставки. |
|
|
|
Пункт самовывоза, выбранный покупателем для получения заказа. Не возвращается в ответе, если покупатель выбрал получение заказа в брендированном пункте выдачи заказов Маркета (значение |
|
|
|
Регион доставки. |
Параметры, вложенные в shipments
|
Параметр |
Тип |
Значение |
|
|
Int64 |
Идентификатор грузового места. |
|
|
Date |
День, в который нужно отгрузить заказы службе доставки. Формат даты: ДД-ММ-ГГГГ. Если заказ сделала огранизация, параметр отсутствует до согласования даты доставки. |
|
|
Список грузовых мест. |
|
|
|
Int64 |
Глубина упакованного заказа в сантиметрах.
Указывается, если заказ доставляет служба-партнер Маркета ( |
|
|
Int64 |
Высота упакованного заказа в сантиметрах.
Указывается, если заказ доставляет служба-партнер Маркета ( |
|
|
Enum |
Статус заказа в партнерской службе доставки. Возможные значения:
Указывается, если заказ доставляет служба-партнер Маркета ( Для формата XML является атрибутом параметра |
|
|
Int64 |
Вес упакованного заказа, отгруженного в партнерскую службу доставки, в граммах. Указывается, если заказ доставляет служба-партнер Маркета ( Для формата XML является атрибутом параметра |
|
|
Int64 |
Ширина упакованного заказа, отгруженного в партнерскую службу доставки, в сантиметрах. Указывается, если заказ доставляет служба-партнер Маркета ( Для формата XML является атрибутом параметра |
Параметры, вложенные в address
|
Параметр |
Тип |
Значение |
|
|
String |
Страна |
|
|
String |
Город или населенный пункт |
|
|
String |
Станция метро |
|
|
String |
Улица |
|
|
String |
Дом или владение |
|
|
String |
Корпус или строение |
|
|
String |
Этаж |
|
|
String |
Подъезд |
|
|
String |
Код домофона |
|
|
String |
Квартира или офис |
|
|
String |
Фамилия, имя и отчество получателя заказа. |
Параметры, вложенные в dates
|
Параметр |
Тип |
Значение |
|
|
Date |
Ближайшая возможная дата доставки. Формат даты: ДД-ММ-ГГГГ. |
|
|
Date |
Самая поздняя дата доставки. Формат даты: ДД-ММ-ГГГГ. |
|
|
Time |
Начало интервала времени доставки.
Формат времени: 24-часовой, ЧЧ:ММ. В качестве минут всегда должно быть указано |
|
|
Time |
Конец интервала времени доставки.
Формат времени: 24-часовой, ЧЧ:ММ. В качестве минут всегда должно быть указано |
Параметры, вложенные в outlet
|
Параметр |
Тип |
Значение |
|
|
String |
Идентификатор пункта самовывоза, присвоенный магазином. |
Параметры, вложенные в region
|
Параметр |
Тип |
Значение |
|
|
Int32 |
Идентификатор региона. |
|
|
String |
Название региона. |
|
|
Enum |
Тип региона. Возможные значения:
|
|
|
|
Родительский регион. Указываются родительские регионы до уровня страны включительно ( |
Параметры, вложенные в courier
|
Параметр |
Тип |
Значение |
|
|
String |
ФИО курьера. |
|
|
String |
Номер телефона. |
|
|
String |
Добавочный номер. |
|
|
String |
Номер машины. Формат: А111АА222. |
|
|
String |
Описание машины. Например, модель и цвет. |
Параметры, вложенные в boxes
|
Параметр |
Тип |
Значение |
|
|
Int64 |
Идентификатор грузового места. |
Параметры, вложенные в items
|
Параметр |
Тип |
Значение |
|
|
Int64 |
Идентификатор товара. Получить идентификатор можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId} или GET campaigns/{campaignId}/orders. |
|
|
Int32 |
Количество единиц товара в грузовом месте. |
|
|
String |
Идентификатор вашего товарного предложения для определенного товара (ваш SKU). |
|
|
Double |
Цена товара, которую оплачивает покупатель, в валюте магазина. В цене уже учтены скидки по:
Для отделения целой части от дробной используется точка. |
|
|
Double |
Цена товара в валюте покупателя. В цене уже учтены скидки по:
Для отделения целой части от дробной используется точка. |
|
|
Double |
Общее вознаграждение партнеру от Маркета за все акции Маркета, в которых участвует товар. Передается в валюте заказа, для отделения целой части от дробной используется точка. |
|
|
Double |
Стоимость товара в валюте покупателя до применения скидок. Для отделения целой части от дробной используется точка. |
|
|
Double |
Стоимость товара в валюте магазина до применения скидок. Для отделения целой части от дробной используется точка. |
|
|
Enum |
Ставка налога на добавленную стоимость (НДС) на товар. Используется только совместно с параметром Возможные значения:
|
|
|
Int64 |
Идентификатор склада на Маркете. |
|
|
String |
Идентификатор склада в системе партнера. Важно Параметр устарел, временно поддерживается, но не доступен для ввода и редактирования. |
|
|
String |
Идентификатор каталога товаров. |
|
|
String |
Идентификатор категории, указанной в прайс-листе. |
|
|
Информация о маркировке единиц товара. Возвращаются данные для маркировки, переданные в запросе PUT campaigns/{campaignId}/orders/{orderId}/cis. |
|
|
|
Информация о вознаграждениях партнеру за скидки на товар по промокодам, купонам и акциям. |
|
Параметр |
Тип |
Значение |
|
|
Int64 |
Идентификатор товара. Позволяет идентифицировать товар в рамках данного заказа. |
|
|
Int64 |
Идентификатор прайс-листа, содержащего предложение. |
|
|
String |
Идентификатор предложения из прайс-листа. |
|
|
String |
Название товара. |
|
|
String |
Идентификатор категории, указанной в прайс-листе. |
|
|
Int64 |
Идентификатор поставщика товара. Чтобы узнать его, войдите в личный кабинет магазина и нажмите на его название. Идентификатор указан в поле ID магазина в строке нужного склада. |
|
|
Int32 |
Количество единиц товара. |
|
|
Double |
Цена товара, которую оплачивает покупатель, в валюте магазина. В цене уже учтены скидки по:
Для отделения целой части от дробной используется точка. |
|
|
Double |
Цена товара в валюте покупателя. В цене уже учтены скидки по:
Для отделения целой части от дробной используется точка. |
|
|
Double |
Общее вознаграждение партнеру от Маркета за все акции Маркета, в которых участвует товар. Передается в валюте заказа, для отделения целой части от дробной используется точка. |
|
|
Double |
Стоимость товара в валюте покупателя до применения скидок. Передается в валюте заказа, для отделения целой части от дробной используется точка. |
|
|
Double |
Стоимость товара в валюте магазина до применения скидок. Для отделения целой части от дробной используется точка. |
|
|
Enum |
Ставка налога на добавленную стоимость (НДС) на товар. Используется только совместно с параметром Возможные значения:
|
|
|
Информация о вознаграждениях партнеру за скидки на товар по промокодам, купонам и акциям. |
Параметры, вложенные в instances
|
Параметр |
Тип |
Значение |
|
|
String |
Код идентификации единицы товара в системе «Честный ЗНАК». |
Параметры, вложенные в promos
|
Параметр |
Тип |
Значение |
|
|
String |
Идентификатор акции в рамках соглашения на оказание услуг по продвижению сервиса между Маркетом и партнером. Параметр передается, только если параметр |
|
|
Float |
Вознаграждение партнеру от Маркета за товар, проданный в рамках акции. Передается в валюте заказа, для отделения целой части от дробной используется точка. |
|
|
Enum |
Тип акции. Возможные значения:
|
Ответные данные от магазина
Не ожидаются.
Если запрос от Маркета вернется повторно, на него необходимо ответить со статусом 200, поскольку Маркет не ожидает ответ от магазина.
Описание ошибок
Магазин может вернуть следующие статусы ответов:
|
Описание |
Пояснение |
|
Ошибка |
Если магазин считает запрос, поступающий от Маркета, некорректным, магазин должен вернуть статус ответа 400 с описанием причины ошибки в теле ответа. Такие ответы будут анализироваться на предмет нарушений и недоработок API со стороны Маркета. |
|
Ошибка |
В случае технической ошибки на стороне магазина он должен вернуть статус ответа 500. Магазины с большим количеством таких ответов могут быть отключены от Маркета. |
Примеры
{
"order":
{
"businessId": 95291,
"creationDate": "10-12-2019 13:53:17",
"currency": "RUR",
"fake": false,
"id": 12345,
"paymentType": "PREPAID",
"paymentMethod": "YANDEX",
"status": "PROCESSING",
"substatus": "STARTED",
"vehicleNumber": "А123НН750",
"taxSystem": "OSN",
"subsidyTotal": 150,
"buyerItemsTotalBeforeDiscount": 5800,
"buyerTotalBeforeDiscount": 6150,
"buyerItemsTotal": 5650,
"buyerTotal": 6000,
"itemsTotal": 5650,
"total": 6000,
"totalWithSubsidy": 6150,
"deliveryTotal": 350,
"delivery":
{
"serviceName": "СПСР",
"type": "DELIVERY",
"courier":
{
"fullName": "Иванов Иван Иванович",
"phone": "+79123456789",
"phoneExtension": "1234",
"vehicleNumber": "A777AА750",
"vehicleDescription": "Mazda 6 зеленый"
},
"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"
}
}
}
},
"shipments":
[
{
"id": 90141,
"weight": 350,
"width": 10,
"height": 20,
"depth": 7,
"status": "CREATED",
"shipmentDate": "11-12-2019"
"boxes":
[ {
"id": 288532885
} ]
}
]
},
"items":
[
{
"offerId": "100423035876",
"count": 3,
"price": 1150,
"buyer-price": 1150,
"buyerPriceBeforeDiscount": 1200,
"priceBeforeDiscount": 1200,
"subsidy": 50,
"vat": "VAT_20",
"warehouseId": 12345,
"partnerWarehouseId": "67890",
"instances":
[
{
"cis": "010465006531553121CtPoNqNB7qOdc"
}
],
"promos":
[
{
"marketPromoId": "abc",
"subsidy": 50,
"type": "MARKET_DEAL"
}
]
},
{
"offerId": "100556386844",
"count": 1,
"price": 2200,
"buyer-price": 2200,
"buyerPriceBeforeDiscount": 2200,
"priceBeforeDiscount": 2200,
"subsidy": 0,
"vat": "VAT_20",
"warehouseId": 12345,
"partnerWarehouseId": "67890"
}
],
"electronicAcceptanceCertificateCode": "123456",
"notes": "Привезите побыстрее, пожалуйста!"
}
}
{
"order":
{
"businessId": 95291,
"creationDate": "15-09-2020 00:42:42",
"currency": "RUR",
"fake": false,
"id": 12345,
"paymentType": "PREPAID",
"paymentMethod": "YANDEX",
"status": "PROCESSING",
"taxSystem": "OSN",
"subsidyTotal": 150,
"buyerItemsTotalBeforeDiscount": 5800,
"buyerTotalBeforeDiscount": 6150,
"buyerItemsTotal": 5650,
"buyerTotal": 6000,
"itemsTotal": 5650,
"total": 6000,
"totalWithSubsidy": 6150,
"deliveryTotal": 350,
"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": 3,
"feedCategoryId": "35",
"fulfilmentShopId": 1234567,
"feedId": 12345,
"offerId": "4609283881",
"offerName": "Чайник электрический 100 W",
"price": 1150,
"buyer-price": 1150,
"buyerPriceBeforeDiscount": 1200,
"priceBeforeDiscount": 1200,
"subsidy": 50,
"vat": "VAT_20",
"promos":
[
{
"marketPromoId": "abc",
"subsidy": 300,
"type": "MARKET_DEAL"
}
]
},
{
"count": 1,
"feedCategoryId": "41",
"fulfilmentShopId": 1234567,
"feedId": 12345,
"offerId": "4607632101",
"offerName": "Тостер",
"price": 2200,
"buyer-price": 2200,
"buyerPriceBeforeDiscount": 2200,
"priceBeforeDiscount": 1200,
"subsidy": 0,
"vat": "VAT_20"
}
],
"notes": "Не работает звонок. Пожалуйста, стучите."
}
}