- Request
- Body
- OrderStatusShopOrderDTO
- OrderBuyerDTO
- CurrencyType
- OrderStatusDeliveryDTO
- ShopOrderItemDTO
- OrderPaymentMethodType
- OrderPaymentType
- OrderStatusType
- OrderSubsidyDTO
- OrderSubstatusType
- OrderTaxSystemType
- OrderBuyerType
- ShopOrderDeliveryAddressDTO
- OrderCourierDTO
- OrderDeliveryDatesDTO
- OrderDeliveryPartnerType
- OrderDeliveryDispatchType
- OrderDeliveryEacType
- OrderLiftType
- ShopOutletDTO
- ShopRegionDTO
- ShopOrderShipmentDTO
- OrderDeliveryType
- OrderVatType
- OrderItemInstanceDTO
- OrderItemPromoDTO
- OrderItemSubsidyDTO
- OrderSubsidyType
- ShopOutletScheduleItemDTO
- ShopRegionType
- ShopOrderParcelBoxDTO
- OrderParcelStatusType
- OrderPromoType
- OrderItemSubsidyType
- DayOfWeekType
- ShopOrderBoxItemDTO
- Responses
- 200 OK
Уведомление об отмене заказа покупателем
Уведомляет магазин о том, что покупатель хочет отменить заказ, который находится в статусе DELIVERY
или PICKUP
. Причина отмены указана в поле substatus
.
Обязательно ответьте на заявку с помощью запроса PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept — подтвердите отмену, если покупатель пока не получил товар, или отклоните заявку, если товар уже находится у покупателя.
Оплата при получении
Если у заказа выбрана оплата при получении, заявки на отмену не будет. Заказ будет отменен автоматически, а вы получите уведомление о смене его статуса.
Если не выполнить запрос PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept в течение 48 часов, отмена подтвердится автоматически.
Персональная информация о покупателе и получателе заказа
Для заказов в статусах RESERVED
и UNPAID
, а также в подстатусах RESERVATION_EXPIRED
и USER_NOT_PAID
статуса CANCELLED
персональная информация о покупателе и получателе заказа недоступна. Не выводятся следующие параметры:
- параметры
apartment
,entrance
,entryphone
иrecipient
, вложенные в параметрaddress
; - параметр
buyer
и все вложенные в него параметры.
Таймаут на получение ответа: 10 секунд.
Request
POST
/order/cancellation/notify
Body
{
"order": {
"businessId": 0,
"id": 0,
"status": "PLACING",
"substatus": "RESERVATION_EXPIRED",
"creationDate": "23-09-2022 09:12:41",
"currency": "RUR",
"itemsTotal": 0,
"total": 0,
"deliveryTotal": 0,
"subsidyTotal": 0,
"totalWithSubsidy": 0,
"subsidies": [
{
"type": "YANDEX_CASHBACK",
"amount": 0
}
],
"buyerItemsTotal": 0,
"buyerTotal": 0,
"buyerItemsTotalBeforeDiscount": 0,
"buyerTotalBeforeDiscount": 0,
"paymentType": "PREPAID",
"paymentMethod": "SHOP_PREPAID",
"fake": false,
"shopOrderId": "string",
"items": [
{
"id": 0,
"feedId": 0,
"offerId": "string",
"feedCategoryId": "string",
"offerName": "string",
"fulfilmentShopId": 0,
"price": 0,
"buyerPrice": 0,
"buyerPriceBeforeDiscount": 0,
"priceBeforeDiscount": 0,
"count": 0,
"delivery": false,
"vat": "NO_VAT",
"shopSku": "string",
"sku": "string",
"subsidy": 0,
"subsidies": [
{
"type": "YANDEX_CASHBACK",
"amount": 0
}
],
"warehouseId": 0,
"partnerWarehouseId": "string",
"params": "string",
"promos": [
{
"type": "DIRECT_DISCOUNT",
"subsidy": 0,
"marketPromoId": "string"
}
],
"instances": [
{
"cis": "string",
"cisFull": "string",
"uin": "string",
"rnpt": "string",
"gtd": "string"
}
]
}
],
"notes": "string",
"taxSystem": "OSN",
"expiryDate": "23-09-2022",
"electronicAcceptanceCertificateCode": "string",
"buyer": {
"id": "string",
"lastName": "string",
"firstName": "string",
"middleName": "string",
"type": "PERSON"
},
"delivery": {
"shopDeliveryId": "string",
"type": "DELIVERY",
"serviceName": "string",
"price": 0,
"subsidy": 0,
"deliveryOptionId": "string",
"deliveryPartnerType": "SHOP",
"dates": {
"fromDate": "23-09-2022",
"toDate": "23-09-2022",
"fromTime": "string",
"toTime": "string",
"realDeliveryDate": "23-09-2022"
},
"region": {
"id": 0,
"name": "string",
"type": "OTHER",
"parent": {
"id": 0,
"name": "string",
"type": "OTHER"
}
},
"vat": "NO_VAT",
"deliveryServiceId": 0,
"liftType": "NOT_NEEDED",
"liftPrice": 0,
"outlet": {
"code": "string"
},
"dispatchType": "UNKNOWN",
"shipments": [
{
"id": 0,
"status": "NEW",
"shipmentDate": "23-09-2022",
"shipmentTime": "string",
"weight": 0,
"width": 0,
"height": 0,
"depth": 0,
"boxes": [
{
"id": 0,
"weight": 0,
"width": 0,
"height": 0,
"depth": 0,
"items": [
{
"id": 0,
"count": 0
}
]
}
]
}
],
"estimated": false,
"eacType": "MERCHANT_TO_COURIER",
"courier": {
"fullName": "string",
"phone": "string",
"phoneExtension": "string",
"vehicleNumber": "string",
"vehicleDescription": "string"
},
"address": {
"country": "string",
"postcode": "string",
"city": "string",
"district": "string",
"subway": "string",
"street": "string",
"house": "string",
"block": "string",
"entrance": "string",
"entryphone": "string",
"floor": "string",
"apartment": "string",
"lat": 0,
"lon": 0,
"notes": "string",
"outletPhones": [
"string"
],
"schedule": [
{
"fromDay": "MONDAY",
"toDay": "MONDAY",
"fromTime": "string",
"toTime": "string"
}
],
"phone": "string",
"recipient": "string"
}
}
}
}
Name |
Description |
order* |
Type: OrderStatusShopOrderDTO Заказ. |
OrderStatusShopOrderDTO
Name |
Description |
businessId |
Type: integer<int64> Идентификатор бизнеса-аккаунта. |
buyer |
Type: OrderBuyerDTO Информация о покупателе. Параметры |
buyerItemsTotal |
Type: number<decimal> Стоимость всех товаров в заказе в валюте покупателя после применения скидок и без учета стоимости доставки. |
buyerItemsTotalBeforeDiscount |
Type: number<decimal> Стоимость всех товаров в заказе в валюте покупателя до применения скидок и без учета стоимости доставки. |
buyerTotal |
Type: number<decimal> Стоимость всех товаров в заказе в валюте покупателя после применения скидок и с учетом стоимости доставки. |
buyerTotalBeforeDiscount |
Type: number<decimal> Стоимость всех товаров в заказе в валюте покупателя до применения скидок и с учетом стоимости доставки. |
creationDate |
Type: string<date-dd-MM-yyyy-HH-mm-ss> Дата и время оформления заказа. Формат даты и времени: Example: |
currency |
Type: CurrencyType Валюта, в которой указаны цены на товары в заказе. Принимает значение Enum: |
delivery |
Type: OrderStatusDeliveryDTO Информация о доставке. |
deliveryTotal |
Type: number<decimal> Стоимость доставки в валюте заказа. |
electronicAcceptanceCertificateCode |
Type: string Только для модели FBS Шестизначный код подтверждения для:
Подробно о работе с кодами рассказано в Справке для продавцов. |
expiryDate |
Type: string<date-dd-MM-yyyy> Дата, после которой заказ будет отменен, если не сменит статус. Формат даты: Example: |
fake |
Type: boolean Тип заказа:
|
id |
Type: integer<int64> Идентификатор заказа. |
items |
Type: ShopOrderItemDTO[] Список товаров в заказе. |
itemsTotal |
Type: number<decimal> Общая сумма заказа в валюте заказа без учета стоимости доставки и вознаграждения партнеру за скидки по промокодам, купонам и акциям (параметр |
notes |
Type: string Комментарий к заказу. |
paymentMethod |
Type: OrderPaymentMethodType Способ оплаты заказа:
Значение по умолчанию: Enum: |
paymentType |
Type: OrderPaymentType Тип оплаты заказа:
Если параметр отсутствует, заказ будет оплачен при получении. Enum: |
shopOrderId |
Type: string Идентификатор заказа в магазине. |
status |
Type: OrderStatusType Статус заказа:
Также могут возвращаться другие значения. Обрабатывать их не требуется. Enum: |
subsidies |
Type: OrderSubsidyDTO[] Список субсидий по типам.
Передается в валюте заказа. |
subsidyTotal |
Type: number<decimal> Общее вознаграждение партнеру за скидки:
Передается в валюте, указанной в параметре |
substatus |
Type: OrderSubstatusType Этап обработки заказа (если он имеет статус
Также могут возвращаться другие значения. Обрабатывать их не требуется. Enum: |
taxSystem |
Type: OrderTaxSystemType Система налогообложения (СНО) магазина на момент оформления заказа:
Enum: |
total |
Type: number<decimal> Общая сумма заказа в валюте заказа с учетом стоимости доставки, но без учета вознаграждения партнеру за скидки по промокодам, купонам, кешбэку и акциям (параметр |
totalWithSubsidy |
Type: number<decimal> Сумма стоимости всех товаров в заказе и вознаграждения за них в валюте магазина (сумма параметров |
OrderBuyerDTO
Информация о покупателе.
Параметры id
, lastName
, firstName
и middleName
возвращаются, только если вы работаете по модели DBS.
Name |
Description |
firstName |
Type: string Имя покупателя. |
id |
Type: string Идентификатор покупателя. |
lastName |
Type: string Фамилия покупателя. |
middleName |
Type: string Отчество покупателя. |
type |
Type: OrderBuyerType Тип покупателя: физическое лицо или организация. Этот параметр используется FBS- и FBY-магазинами, размещающими товары на витрине business.market.yandex.ru. Enum: |
CurrencyType
Коды валют. Возможные значения:
BYR
— белорусский рубль.KZT
— казахстанский тенге.RUR
— российский рубль.UAH
— украинская гривна.
Type |
Description |
Enum: |
OrderStatusDeliveryDTO
Name |
Description |
address |
Type: ShopOrderDeliveryAddressDTO Только для модели DBS Адрес доставки. Передается, если параметр |
courier |
Type: OrderCourierDTO Только для модели Экспресс Информация о курьере. |
dates |
Type: OrderDeliveryDatesDTO Только для модели DBS Диапазон дат доставки. |
deliveryOptionId |
Type: string Идентификатор опции доставки, переданный магазином. |
deliveryPartnerType |
Type: OrderDeliveryPartnerType Тип сотрудничества со службой доставки в рамках конкретного заказа. Enum: |
deliveryServiceId |
Type: integer<int64> Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса GET delivery/services. |
dispatchType |
Type: OrderDeliveryDispatchType Только для модели DBS Способ отгрузки. Enum: |
eacType |
Type: OrderDeliveryEacType Только для модели Экспресс Тип кода подтверждения ЭАПП. Enum: |
estimated |
Type: boolean Только для модели DBS Признак, который показывает, что дата доставки по заказу не подтверждена. Передается для товаров на заказ с долгим сроком доставки (31–60 дней). Окончательную дату доставки нужно передать Маркету в течение 7 дней с даты оформления заказа в запросе PUT campaigns/{campaignId}/orders/{orderId}/delivery/date. |
liftPrice |
Type: number<decimal> Только для модели DBS Стоимость подъема на этаж. |
liftType |
Type: OrderLiftType Только для модели DBS Тип подъема заказа на этаж. Enum: |
outlet |
Type: ShopOutletDTO Только для модели DBS Пункт самовывоза, выбранный покупателем для получения заказа. Не возвращается в ответе, если покупатель выбрал получение заказа в брендированном пункте выдачи заказов Маркета (значение |
price |
Type: number<decimal> До 1 июля 2021 в нем возвращалась ваша стоимость доставки заказа. Сейчас Маркет всегда передает в этом поле 0, так как поле устарело и не используется, а стоимость доставки заказа рассчитывает автоматически, по единому тарифу на доставку. |
region |
Type: ShopRegionDTO Регион доставки. |
serviceName |
Type: string Наименование службы доставки. |
shipments |
Type: ShopOrderShipmentDTO[] Информация о посылках. Для модели DBS: передается, если заказ был создан в пункт выдачи Маркета.
|
shopDeliveryId |
Type: string Только для модели DBS Идентификатор доставки, присвоенный магазином. Указывается, только если магазин передал данный идентификатор в ответе на запрос методом POST cart в параметре |
subsidy |
Type: number<decimal> Субсидия за доставку в валюте заказа. |
type |
Type: OrderDeliveryType Способ доставки заказа. Enum: |
vat |
Type: OrderVatType Только для модели DBS Ставка налога на добавленную стоимость (НДС) на услугу доставки заказа. Enum: |
ShopOrderItemDTO
Список товаров в заказе.
Name |
Description |
buyerPrice |
Type: number<decimal> Цена на товар в валюте покупателя. В цене уже учтены скидки по:
Для поддержания обратной совместимости также заполняется устаревший параметр Используйте параметр |
buyerPriceBeforeDiscount |
Type: number<decimal> Стоимость товара в валюте покупателя до применения скидок. |
count |
Type: integer Количество единиц товара. |
delivery |
Type: boolean Только для модели FBS Доставка товара в указанный в запросе регион:
Принимает значение, которое вы передали в параметре |
feedCategoryId |
Type: string Только для модели DBS Идентификатор категории, указанный в каталоге. |
feedId |
Type: integer<int64> Идентификатор каталога товаров. |
fulfilmentShopId |
Type: integer<int64> Идентификатор поставщика товара. Чтобы узнать его, войдите в кабинет продавца на Маркете и нажмите на его название. Идентификатор указан в поле ID магазина в строке нужного склада. |
id |
Type: integer<int64> Идентификатор товара в заказе. Позволяет идентифицировать товар в рамках данного заказа. |
instances |
Type: OrderItemInstanceDTO[] Информация о маркировке единиц товара. Возвращаются данные для маркировки, переданные в запросе PUT campaigns/{campaignId}/orders/{orderId}/cis. Если магазин еще не передавал коды для этого заказа, |
offerId |
Type: string Идентификатор вашего товарного предложения для определенного товара. Описание поля в Справке Маркета для продавцов Min length: Max length: Pattern: |
offerName |
Type: string Только для модели DBS Название товара. |
params |
Type: string Характеристики товара (например, его цвет). |
partnerWarehouseId |
Type: string Этот параметр устарел. Не используйте его. Только для модели FBS Идентификатор склада в системе партнера, на который сформирован заказ. |
price |
Type: number<decimal> Цена на товар в валюте заказа без учета вознаграждения партнеру за скидки по промокодам, купонам и акциям (параметр |
priceBeforeDiscount |
Type: number<decimal> Стоимость товара в валюте магазина до применения скидок. |
promos |
Type: OrderItemPromoDTO[] Информация о вознаграждениях партнеру за скидки на товар по промокодам, купонам и акциям. |
shopSku |
Type: string Ваш SKU — идентификатор товара в вашей системе. Разрешена любая последовательность длиной до 255 знаков. Правила использования SKU:
Что такое SKU и как его назначать Min length: Max length: Pattern: |
sku |
Type: string SKU на Маркете — идентификатор текущей карточки товара на Маркете. |
subsidies |
Type: OrderItemSubsidyDTO[] Список субсидий по типам.
Передается в валюте заказа. |
subsidy |
Type: number<decimal> Этот параметр устарел. Вместо него используйте Общее вознаграждение партнеру за все скидки на товар:
Передается в валюте заказа. |
vat |
Type: OrderVatType Ставка налога на добавленную стоимость (НДС) на товар. Используется только совместно с параметром Enum: |
warehouseId |
Type: integer<int64> Только для модели FBS Идентификатор склада на Маркете. |
OrderPaymentMethodType
Способ оплаты заказа:
-
Значения, если выбрана оплата при оформлении заказа (
"paymentType": "PREPAID"
):-
YANDEX
— банковской картой. -
APPLE_PAY
— Apple Pay. -
GOOGLE_PAY
— Google Pay. -
CREDIT
— в кредит. -
TINKOFF_CREDIT
— в кредит в Тинькофф Банке. -
TINKOFF_INSTALLMENTS
— рассрочка в Тинькофф Банке. -
EXTERNAL_CERTIFICATE
— подарочным сертификатом (например, из приложения «Сбербанк Онлайн»). -
SBP
— через систему быстрых платежей. -
B2B_ACCOUNT_PREPAYMENT
— заказ оплачивает организация.
-
-
Значения, если выбрана оплата при получении заказа (
"paymentType": "POSTPAID"
):-
CARD_ON_DELIVERY
— банковской картой. -
CASH_ON_DELIVERY
— наличными. -
B2B_ACCOUNT_POSTPAYMENT
— заказ оплачивает организация после доставки.
-
-
UNKNOWN
— неизвестный тип.
Значение по умолчанию: CASH_ON_DELIVERY
.
Type |
Description |
Enum: |
OrderPaymentType
Тип оплаты заказа:
-
PREPAID
— оплата при оформлении заказа. -
POSTPAID
— оплата при получении заказа. -
UNKNOWN
— неизвестный тип.
Если параметр отсутствует, заказ будет оплачен при получении.
Type |
Description |
Enum: |
OrderStatusType
Статус заказа:
-
CANCELLED
— отменен. -
DELIVERED
— получен покупателем. -
DELIVERY
— передан в службу доставки. -
PICKUP
— доставлен в пункт самовывоза. -
PROCESSING
— находится в обработке. -
PENDING
— ожидает обработки со стороны продавца. -
UNPAID
— оформлен, но еще не оплачен (если выбрана оплата при оформлении). -
PLACING
— оформляется, подготовка к резервированию. -
RESERVED
— зарезервирован, но недооформлен. -
PARTIALLY_RETURNED
— возвращен частично. -
RETURNED
— возвращен полностью. -
UNKNOWN
— неизвестный статус.
Также могут возвращаться другие значения. Обрабатывать их не требуется.
Type |
Description |
Enum: |
OrderSubsidyDTO
Общее вознаграждение партнеру за DBS-доставку и все скидки на товар:
- по промокодам, купонам и акциям;
- по баллам Плюса;
- по доставке (DBS).
Передается в валюте заказа.
Name |
Description |
amount |
Type: number<decimal> Сумма субсидии. |
type |
Type: OrderSubsidyType Тип субсидии:
Enum: |
OrderSubstatusType
Этап обработки заказа (если он имеет статус PROCESSING
) или причина отмены заказа (если он имеет статус CANCELLED
).
-
Значения для заказа в статусе
PROCESSING
:-
STARTED
— заказ подтвержден, его можно начать обрабатывать. -
READY_TO_SHIP
— заказ собран и готов к отправке.
-
-
Значения для заказа в статусе
CANCELLED
:-
PROCESSING_EXPIRED
— значение более не используется. -
REPLACING_ORDER
— покупатель решил заменить товар другим по собственной инициативе. -
RESERVATION_EXPIRED
— покупатель не завершил оформление зарезервированного заказа в течение 10 минут. -
SHOP_FAILED
— магазин не может выполнить заказ. -
USER_CHANGED_MIND
— покупатель отменил заказ по личным причинам. -
USER_NOT_PAID
— покупатель не оплатил заказ (для типа оплатыPREPAID
) в течение 30 минут. -
USER_REFUSED_DELIVERY
— покупателя не устроили условия доставки. -
USER_REFUSED_PRODUCT
— покупателю не подошел товар. -
USER_REFUSED_QUALITY
— покупателя не устроило качество товара. -
USER_UNREACHABLE
— не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:- не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
- перерыв между первым и третьим звонком не менее 90 минут;
- соединение не короче 5 секунд.
Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.
-
-
TECHNICAL_ERROR
— техническая ошибка на стороне Маркета. Обратитесь в поддержку.
Также могут возвращаться другие значения. Обрабатывать их не требуется.
Type |
Description |
Enum: |
OrderTaxSystemType
Система налогообложения (СНО) магазина на момент оформления заказа:
-
ECHN
— единый сельскохозяйственный налог (ЕСХН). -
ENVD
— единый налог на вмененный доход (ЕНВД). -
OSN
— общая система налогообложения (ОСН). -
PSN
— патентная система налогообложения (ПСН). -
USN
— упрощенная система налогообложения (УСН). -
USN_MINUS_COST
— упрощенная система налогообложения, доходы, уменьшенные на величину расходов (УСН «Доходы минус расходы»). -
NPD
— налог на профессиональный доход (НПД). -
UNKNOWN_VALUE
— неизвестное значение. Используется только совместно с параметромpayment-method=YANDEX
.
Type |
Description |
Enum: |
OrderBuyerType
Тип покупателя:
-
PERSON
— физическое лицо. -
BUSINESS
— организация.
Type |
Description |
Enum: |
ShopOrderDeliveryAddressDTO
Name |
Description |
apartment |
Type: string Квартира или офис. |
block |
Type: string Корпус или строение. |
city |
Type: string Город или населенный пункт. Обязательный параметр. |
country |
Type: string Страна. Обязательный параметр. |
district |
Type: string Район. |
entrance |
Type: string Подъезд. |
entryphone |
Type: string Код домофона. |
floor |
Type: string Этаж. |
house |
Type: string Дом или владение. Обязательный параметр. |
lat |
Type: number<decimal> Широта. Параметр указывается, если покупатель выбрал доставку заказа в брендированный пункт выдачи Маркета. Не гарантируем заполнение, так как это опциональное поле. |
lon |
Type: number<decimal> Долгота. Параметр указывается, если покупатель выбрал доставку заказа в брендированный пункт выдачи Маркета. Не гарантируем заполнение, так как это опциональное поле. |
notes |
Type: string Примечание к адресу. Например, Параметр указывается, если покупатель выбрал доставку заказа в брендированный пункт выдачи Маркета. |
outletPhones |
Type: string[] Телефоны пункта выдачи в формате Параметр указывается, если покупатель выбрал доставку заказа в брендированный пункт выдачи Маркета.
|
phone |
Type: string Телефон получателя заказа. Обязательный параметр. |
postcode |
Type: string Почтовый индекс. Указывается, если выбрана доставка почтой ( |
recipient |
Type: string Фамилия, имя и отчество получателя заказа. Обязательный параметр. |
schedule |
Type: ShopOutletScheduleItemDTO[] Расписание работы пункта выдачи. Параметр указывается, если покупатель выбрал доставку заказа в брендированный пункт выдачи Маркета.
|
street |
Type: string Улица. |
subway |
Type: string Станция метро. |
OrderCourierDTO
Информация о курьере.
Name |
Description |
fullName |
Type: string Полное имя курьера. |
phone |
Type: string Номер телефона курьера. |
phoneExtension |
Type: string Добавочный номер телефона. |
vehicleDescription |
Type: string Описание машины. Например, модель и цвет. |
vehicleNumber |
Type: string Номер транспортного средства. |
OrderDeliveryDatesDTO
Диапазон дат доставки.
Name |
Description |
fromDate |
Type: string<date-dd-MM-yyyy> Ближайшая дата доставки. Формат даты: Example: |
fromTime |
Type: string<time> Начало интервала времени доставки. Передается только совместно с параметром Формат времени: 24-часовой, Минимальное значение: |
realDeliveryDate |
Type: string<date-dd-MM-yyyy> Дата, когда товар доставлен до пункта выдачи заказа (в случае самовывоза) или до покупателя (если заказ доставляет курьер). Example: |
toDate |
Type: string<date-dd-MM-yyyy> Самая поздняя дата доставки. Если параметр Формат даты: Example: |
toTime |
Type: string<time> Конец интервала времени доставки. Передается только совместно с параметром Формат времени: 24-часовой, Максимальное значение: |
OrderDeliveryPartnerType
Тип сотрудничества со службой доставки в рамках конкретного заказа:
-
SHOP
— магазин работает со службой доставки напрямую или доставляет заказы самостоятельно. -
YANDEX_MARKET
— магазин работает со службой доставки через Маркет. -
UNKNOWN
— неизвестный тип.
Type |
Description |
Enum: |
OrderDeliveryDispatchType
Способ отгрузки:
-
BUYER
— доставка покупателю. -
MARKET_PARTNER_OUTLET
— доставка в пункт выдачи партнера. -
MARKET_BRANDED_OUTLET
— доставка в пункт выдачи заказов Маркета. -
SHOP_OUTLET
— доставка в пункт выдачи заказов магазина. -
DROPOFF
— доставка в пункт выдачи, который принимает заказы от продавцов и передает их курьерам. -
UNKNOWN
— неизвестный тип.
Type |
Description |
Enum: |
OrderDeliveryEacType
Тип кода подтверждения ЭАПП:
-
MERCHANT_TO_COURIER
— продавец передает код курьеру. -
COURIER_TO_MERCHANT
— курьер передает код продавцу. -
CHECKING_BY_MERCHANT
— продавец проверяет код на своей стороне.
Type |
Description |
Enum: |
OrderLiftType
Тип подъема заказа на этаж:
-
NOT_NEEDED
— не требуется. -
MANUAL
— ручной. -
ELEVATOR
— лифт. -
CARGO_ELEVATOR
— грузовой лифт. -
FREE
— любой из перечисленных выше, если включена опция бесплатного подъема. -
UNKNOWN
— неизвестный тип.
Type |
Description |
Enum: |
ShopOutletDTO
Пункт самовывоза, выбранный покупателем для получения заказа. Не возвращается в ответе, если покупатель выбрал получение заказа в брендированном пункте выдачи заказов Маркета (значение MARKET_BRANDED_OUTLET
параметра dispatchType
).
Name |
Description |
code |
Type: string Идентификатор пункта самовывоза, присвоенный магазином. |
ShopRegionDTO
Регион доставки.
Name |
Description |
name* |
Type: string Название региона. |
type* |
Type: ShopRegionType Тип региона. Enum: |
id |
Type: integer<int64> Идентификатор региона. |
parent |
Type: ShopRegionDTO Информация о родительском регионе. Указываются родительские регионы до уровня страны. |
ShopOrderShipmentDTO
Список посылок.
Name |
Description |
boxes |
Type: ShopOrderParcelBoxDTO[] Список грузовых мест. |
depth |
Type: integer<int64> Глубина упакованного заказа в сантиметрах. Указывается, если заказ доставляет служба-партнер Маркета ( |
height |
Type: integer<int64> Высота упакованного заказа в сантиметрах. Указывается, если заказ доставляет служба-партнер Маркета ( |
id |
Type: integer<int64> Идентификатор посылки, присвоенный Маркетом. |
shipmentDate |
Type: string<date-dd-MM-yyyy> День, в который нужно отгрузить заказ службе доставки. Формат даты: Для модели FBS: если заказ сделан организацией, параметр не возвращается до согласования даты доставки. Для модели DBS: если вы не передали параметр Example: |
shipmentTime |
Type: string<time> Только для модели Экспресс Время, к которому магазин должен упаковать заказ и перевести его в статус Формат времени: 24-часовой, Если заказ сделан организацией, параметр не возвращается до согласования даты доставки. |
status |
Type: OrderParcelStatusType Статус заказа в партнерской службе доставки:
Enum: |
weight |
Type: integer<int64> Вес упакованного заказа в граммах. Указывается, если заказ доставляет служба-партнер Маркета ( |
width |
Type: integer<int64> Ширина упакованного заказа в сантиметрах. Указывается, если заказ доставляет служба-партнер Маркета ( |
OrderDeliveryType
Способ доставки заказа:
-
DELIVERY
— курьерская доставка. -
PICKUP
— самовывоз. -
POST
— почта. -
DIGITAL
— для цифровых товаров. -
UNKNOWN
— неизвестный тип.
Type |
Description |
Enum: |
OrderVatType
Ставка налога на добавленную стоимость (НДС) на товар:
-
NO_VAT
— НДС не облагается, используется только для отдельных видов услуг. -
VAT_0
— НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров. -
VAT_10
— НДС 10%. Например, используется при реализации отдельных продовольственных и медицинских товаров. -
VAT_10_110
— НДС 10/110. Расчетная ставка НДС 10%, применяется только при предоплате. -
VAT_20
— НДС 20%. Основная ставка с 2019 года. -
VAT_20_120
— НДС 20/120. Расчетная ставка НДС 20%, применяется только при предоплате. -
VAT_18
— НДС 18%. Основная ставка до 2019 года. -
VAT_18_118
— НДС 18/118. Ставка использовалась до 1 января 2019 года при предоплате. -
UNKNOWN_VALUE
— неизвестный тип.
Используется только совместно с параметром payment-method=YANDEX
.
Type |
Description |
Enum: |
OrderItemInstanceDTO
Переданные вами для данной позиции коды маркировки или УИНы. Коды «Честного знака» возвращаются в двух вариантах — с криптохвостом и без.
Name |
Description |
cis |
Type: string Код идентификации единицы товара в системе «Честный ЗНАК» без криптохвоста. |
cisFull |
Type: string Код идентификации единицы товара в системе «Честный ЗНАК» с криптохвостом. |
gtd |
Type: string Грузовая таможенная декларация. Представляет собой строку из трех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на ввезенные товары. Далее — дата и номер декларации. |
rnpt |
Type: string Регистрационный номер партии товара. Представляет собой строку из четырех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ/ХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на партию товара. Далее — дата, номер декларации и номер маркированного товара в декларации. |
uin |
Type: string УИН ювелирного изделия (16-значный код) Производитель получает УИН, когда регистрирует изделие в системе контроля за оборотом драгоценных металлов и камней — ГИИС ДМДК. |
OrderItemPromoDTO
Информация о вознаграждениях партнеру за скидки на товар по промокодам, купонам и акциям.
Name |
Description |
type* |
Type: OrderPromoType Тип скидки. Enum: |
marketPromoId |
Type: string Идентификатор акции в рамках соглашения на оказание услуг по продвижению сервиса между Маркетом и партнером. Параметр передается, только если параметр |
subsidy |
Type: number<decimal> Вознаграждение партнеру от Маркета за товар, проданный в рамках акции. Передается в валюте заказа. |
OrderItemSubsidyDTO
Общее вознаграждение партнеру за все скидки на товар:
- по промокодам, купонам и акциям;
- по баллам Плюса.
Передается в валюте заказа.
Name |
Description |
amount |
Type: number<decimal> Сумма субсидии. |
type |
Type: OrderItemSubsidyType Тип субсидии:
Enum: |
OrderSubsidyType
Тип субсидии:
-
YANDEX_CASHBACK
— скидка по подписке Яндекс Плюс. -
SUBSIDY
— скидка Маркета (по акциям, промокодам, купонам и т. д.) -
DELIVERY
— скидка за доставку (DBS).
Type |
Description |
Enum: |
ShopOutletScheduleItemDTO
Расписание работы точки продаж.
Name |
Description |
fromDay* |
Type: DayOfWeekType День недели, в который пункт выдачи начинает работать:
Обязательный параметр. Enum: |
fromTime* |
Type: string Время начала работы пункта выдачи. Формат времени: 24-часовой, Обязательный параметр. Min length: |
toDay* |
Type: DayOfWeekType День недели, в который пункт выдачи заканчивает работать:
Обязательный параметр. Enum: |
toTime* |
Type: string Время окончания работы пункта выдачи. Формат времени: 24-часовой, Обязательный параметр. Min length: |
ShopRegionType
Тип региона:
-
CITY_DISTRICT
— район города. -
CITY
— крупный город. -
CONTINENT
— континент. -
COUNTRY_DISTRICT
— федеральный округ. -
COUNTRY
— страна. -
REGION
— регион. -
METRO_STATION
— станция метро. -
MONORAIL_STATION
— станция монорельса. -
OVERSEAS_TERRITORY
— отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.). -
SECONDARY_DISTRICT
— район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.). -
SETTLEMENT
— поселение. -
SUBJECT_FEDERATION
— субъект федерации. -
SUBJECT_FEDERATION_DISTRICT
— район субъекта федерации. -
VILLAGE
— город. -
SUBURB
— пригород. -
OTHER
— неизвестный регион.
Type |
Description |
Enum: |
ShopOrderParcelBoxDTO
Информация о грузоместе.
Name |
Description |
depth |
Type: integer<int64> Глубина грузового места в сантиметрах. |
height |
Type: integer<int64> Высота грузового места в сантиметрах. |
id |
Type: integer<int64> Идентификатор грузового места. |
items |
Type: ShopOrderBoxItemDTO[] Информация о коробке. |
weight |
Type: integer<int64> Вес грузового места в граммах. |
width |
Type: integer<int64> Ширина грузового места в сантиметрах. |
OrderParcelStatusType
Статус заказа в партнерской службе доставки:
-
NEW
— новый. -
CREATED
— создан в службе доставки. -
READY_TO_SHIP
— готов к передаче в службу доставки. -
ERROR
— ошибка создания заказа. -
UNKNOWN
— неизвестный статус.
Type |
Description |
Enum: |
OrderPromoType
Тип скидки:
-
DIRECT_DISCOUNT
— прямая скидка, которую устанавливает продавец или Маркет. -
BLUE_SET
— комплекты. -
BLUE_FLASH
— флеш-акция. -
MARKET_COUPON
— скидка по промокоду Маркета. -
MARKET_PROMOCODE
— скидка по промокоду магазина. -
MARKET_BLUE
— скидка на Маркете. -
YANDEX_PLUS
— бесплатная доставка с подпиской Яндекс Плюс. -
YANDEX_EMPLOYEE
— бесплатная доставка по определенным адресам. -
LIMITED_FREE_DELIVERY_PROMO
— бесплатная доставка по ограниченному предложению. -
FREE_DELIVERY_THRESHOLD
— бесплатная доставка при достижении определенной суммы заказа. -
MULTICART_DISCOUNT
— скидка за то, что оформлена мультикорзина. -
FREE_DELIVERY_FOR_LDI
— бесплатная доставка за то, что один из товаров крупногабаритный. -
FREE_DELIVERY_FOR_LSC
— бесплатная доставка за то, что одна из корзин в мультикорзине крупногабаритная. -
FREE_PICKUP
— бесплатная доставка в пункт выдачи заказов. -
CHEAPEST_AS_GIFT
— самый дешевый товар в подарок. -
CASHBACK
— кешбэк. -
SUPPLIER_MULTICART_DISCOUNT
— скидка за доставку. -
SPREAD_DISCOUNT_COUNT
— скидка за количество одинаковых товаров. -
SPREAD_DISCOUNT_RECEIPT
— скидка от суммы чека. -
ANNOUNCEMENT_PROMO
— информационная акция, скидка не применяется к товарам. -
DISCOUNT_BY_PAYMENT_TYPE
— прямая скидка при оплате картой Плюса. -
PERCENT_DISCOUNT
— прямая скидка в процентах. -
DCO_EXTRA_DISCOUNT
— дополнительная скидка, необходимая для расчета субсидии от Маркета. -
EMPTY_PROMO
— скрытые промокоды. -
BLOCKING_PROMO
— блокирующее промо. -
UNKNOWN
— неизвестный тип.
Неактуальные типы:
-
GENERIC_BUNDLE
. -
MARKET_DEAL
. -
MARKET_PRIME
. -
MARKET_COIN
. -
BERU_PLUS
. -
PRICE_DROP_AS_YOU_SHOP
. -
SECRET_SALE
.
Type |
Description |
Enum: |
OrderItemSubsidyType
Тип субсидии:
-
YANDEX_CASHBACK
— скидка по подписке Яндекс Плюс. -
SUBSIDY
— скидка Маркета (по акциям, промокодам, купонам и т. д.).
Type |
Description |
Enum: |
DayOfWeekType
День недели:
MONDAY
— понедельник.TUESDAY
— вторник.WEDNESDAY
— среда.THURSDAY
— четверг.FRIDAY
— пятница.SATURDAY
— суббота.SUNDAY
— воскресенье.
Type |
Description |
Enum: |
ShopOrderBoxItemDTO
Информация о коробке.
Name |
Description |
count |
Type: integer Количество товара в коробке. |
id |
Type: integer<int64> Идентификатор коробки. |
Responses
200 OK
Пустой ответ.