- Request
- Body
- OrderStatusShopOrderDTO
- OrderStatusType
- OrderSubstatusType
- CurrencyType
- OrderPaymentType
- OrderPaymentMethodType
- ShopOrderItemDTO
- OrderTaxSystemType
- OrderBuyerDTO
- OrderStatusDeliveryDTO
- OrderVatType
- OrderItemPromoDTO
- OrderItemInstanceDTO
- OrderBuyerType
- OrderDeliveryType
- OrderDeliveryPartnerType
- OrderDeliveryDatesDTO
- ShopRegionDTO
- OrderLiftType
- ShopOutletDTO
- OrderDeliveryDispatchType
- ShopOrderShipmentDTO
- OrderDeliveryEacType
- OrderCourierDTO
- ShopOrderDeliveryAddressDTO
- OrderPromoType
- ShopRegionType
- OrderParcelStatusType
- ShopOrderParcelBoxDTO
- ShopOutletScheduleItemDTO
- ShopOrderBoxItemDTO
- DayOfWeekType
- Responses
- 200 OK
- 400 Bad Request
- 500 Internal Server Error
Уведомление о смене статуса заказа
Уведомляет магазин о смене статуса заказа.
Таймаут на получение ответа: 10 секунд.
Request
POST
/order/status
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,
"buyerItemsTotal": 0,
"buyerTotal": 0,
"buyerItemsTotalBeforeDiscount": 0,
"buyerTotalBeforeDiscount": 0,
"paymentType": "PREPAID",
"paymentMethod": "SHOP_PREPAID",
"fake": false,
"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,
"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": {
"id": "string",
"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 |
Type |
Description |
order* |
Заказ. |
OrderStatusShopOrderDTO
Name |
Type |
Description |
businessId |
integer<int64> |
Идентификатор бизнеса-аккаунта. |
id |
integer<int64> |
Идентификатор заказа. |
status |
Статус заказа:
Также могут возвращаться другие значения. Обрабатывать их не требуется.
|
|
substatus |
Этап обработки заказа (если он имеет статус Возможные значения для заказа в статусе
Возможные значения для заказа в статусе
Также могут возвращаться другие значения. Обрабатывать их не требуется.
|
|
creationDate |
string<date-dd-MM-yyyy-HH-mm-ss> |
Дата и время оформления заказа. Формат даты и времени:
|
currency |
Валюта, в которой указаны цены товаров в заказе. Принимает значение
|
|
itemsTotal |
number<decimal> |
Общая сумма заказа в валюте заказа без учета стоимости доставки и вознаграждения партнеру за скидки по промокодам, купонам и акциям (параметр Для отделения целой части от дробной используется точка. |
total |
number<decimal> |
Общая сумма заказа в валюте заказа с учетом стоимости доставки, но без учета вознаграждения партнеру за скидки по промокодам, купонам, кешбэку и акциям (параметр Для отделения целой части от дробной используется точка. |
deliveryTotal |
number<decimal> |
Стоимость доставки в валюте заказа. Для отделения целой части от дробной используется точка. |
subsidyTotal |
number<decimal> |
Общее вознаграждение партнеру за скидки:
Передается в валюте, указанной в параметре Для отделения целой части от дробной используется точка. |
totalWithSubsidy |
number<decimal> |
Сумма стоимости всех товаров в заказе и вознаграждения за них в валюте магазина (сумма параметров |
buyerItemsTotal |
number<decimal> |
Стоимость всех товаров в заказе в валюте покупателя после применения скидок и без учета стоимости доставки. |
buyerTotal |
number<decimal> |
Стоимость всех товаров в заказе в валюте покупателя после применения скидок и с учетом стоимости доставки. |
buyerItemsTotalBeforeDiscount |
number<decimal> |
Стоимость всех товаров в заказе в валюте покупателя до применения скидок и без учета стоимости доставки. |
buyerTotalBeforeDiscount |
number<decimal> |
Стоимость всех товаров в заказе в валюте покупателя до применения скидок и с учетом стоимости доставки. |
paymentType |
Тип оплаты заказа:
Если параметр отсутствует, заказ будет оплачен при получении.
|
|
paymentMethod |
Способ оплаты заказа:
Значение по умолчанию:
|
|
fake |
boolean |
Тип заказа:
|
items |
Список товаров в заказе. |
|
notes |
string |
Комментарий к заказу. |
taxSystem |
Система налогообложения (СНО) магазина на момент оформления заказа:
|
|
expiryDate |
string<date-dd-MM-yyyy> |
Дата, после которой заказ будет отменен, если не сменит статус. Формат даты:
|
electronicAcceptanceCertificateCode |
string |
Только для модели FBS Шестизначный код подтверждения для:
Подробно о работе с кодами рассказано в Справке для продавцов. |
buyer |
Информация о покупателе. Параметры |
|
delivery |
Информация о доставке. |
OrderStatusType
Статус заказа:
-
CANCELLED
— отменен. -
DELIVERED
— получен покупателем. -
DELIVERY
— передан в службу доставки. -
PICKUP
— доставлен в пункт самовывоза. -
PROCESSING
— находится в обработке. -
PENDING
— ожидает обработки со стороны продавца. -
UNPAID
— оформлен, но еще не оплачен (если выбрана оплата при оформлении). -
PLACING
— оформляется, подготовка к резервированию. -
RESERVED
— зарезервирован, но недооформлен. -
PARTIALLY_RETURNED
— возвращен частично. -
RETURNED
— возвращен полностью. -
UNKNOWN
— неизвестный статус.
Также могут возвращаться другие значения. Обрабатывать их не требуется.
Type |
Description |
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.
Также могут возвращаться другие значения. Обрабатывать их не требуется.
Type |
Description |
Enum: |
CurrencyType
Коды валют. Возможные значения:
BYR
— белорусский рубль.KZT
— казахстанский тенге.RUR
— российский рубль.UAH
— украинская гривна.
Type |
Description |
Enum: |
OrderPaymentType
Тип оплаты заказа:
-
PREPAID
— оплата при оформлении заказа. -
POSTPAID
— оплата при получении заказа. -
UNKNOWN
— неизвестный тип.
Если параметр отсутствует, заказ будет оплачен при получении.
Type |
Description |
Enum: |
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: |
ShopOrderItemDTO
Список товаров в заказе.
Name |
Type |
Description |
id |
integer<int64> |
Идентификатор товара в заказе. Позволяет идентифицировать товар в рамках данного заказа. |
feedId |
integer<int64> |
Идентификатор каталога товаров. |
offerId |
string |
Идентификатор вашего товарного предложения для определенного товара. Описание поля в Справке для продавцов
|
feedCategoryId |
string |
Только для модели DBS Идентификатор категории, указанный в каталоге. |
offerName |
string |
Только для модели DBS Название товара. |
fulfilmentShopId |
integer<int64> |
Только для модели DBS Идентификатор поставщика товара. Чтобы узнать его, войдите в кабинет продавца на Маркете и нажмите на его название. Идентификатор указан в поле ID магазина в строке нужного склада. |
price |
number<decimal> |
Цена товара в валюте заказа без учета вознаграждения партнеру за скидки по промокодам, купонам и акциям (параметр Для отделения целой части от дробной используется точка. |
buyerPrice |
number<decimal> |
Цена товара в валюте покупателя. В цене уже учтены скидки по:
Для отделения целой части от дробной используется точка. Внимание Для поддержания обратной совместимости также заполняется устаревшее поле В будущем оно будет удалено. Пожалуйста, используйте поле |
buyerPriceBeforeDiscount |
number<decimal> |
Стоимость товара в валюте покупателя до применения скидок. Для отделения целой части от дробной используется точка. |
priceBeforeDiscount |
number<decimal> |
Стоимость товара в валюте магазина до применения скидок. Для отделения целой части от дробной используется точка. |
count |
integer |
Количество единиц товара. |
delivery |
boolean |
Только для модели FBS Доставка товара в указанный в запросе регион:
Принимает значение, которое вы передали в параметре |
vat |
Ставка налога на добавленную стоимость (НДС) на товар. Используется только совместно с параметром
|
|
shopSku |
string |
Ваш SKU — идентификатор товара в вашей системе. Разрешена любая последовательность длиной до 80 знаков. В нее могут входить английские и русские буквы, цифры и символы Правила использования SKU:
Что такое SKU и как его назначать
|
sku |
string |
SKU на Маркете — идентификатор текущей карточки товара на Маркете. |
subsidy |
number<decimal> |
Общее вознаграждение партнеру за все скидки на товар:
Передается в валюте заказа, для отделения целой части от дробной используется точка. |
warehouseId |
integer<int64> |
Только для модели FBS Идентификатор склада на Маркете. |
partnerWarehouseId |
string |
Только для модели FBS Идентификатор склада в системе партнера, на который сформирован заказ. Внимание Параметр устарел, временно поддерживается, но не доступен для ввода и редактирования. |
params |
string |
Характеристики товара (например, его цвет). |
promos |
Информация о вознаграждениях партнеру за скидки на товар по промокодам, купонам и акциям. |
|
instances |
Информация о маркировке единиц товара. Возвращаются данные для маркировки, переданные в запросе PUT campaigns/{campaignId}/orders/{orderId}/cis. Если магазин еще не передавал коды для этого заказа, |
OrderTaxSystemType
Система налогообложения (СНО) магазина на момент оформления заказа:
-
ECHN
— единый сельскохозяйственный налог (ЕСХН). -
ENVD
— единый налог на вмененный доход (ЕНВД). -
OSN
— общая система налогообложения (ОСН). -
PSN
— патентная система налогообложения (ПСН). -
USN
— упрощенная система налогообложения (УСН). -
USN_MINUS_COST
— упрощенная система налогообложения, доходы, уменьшенные на величину расходов (УСН «Доходы минус расходы»). -
NPD
— налог на профессиональный доход (НПД). -
UNKNOWN_VALUE
— неизвестное значение. Используется только совместно с параметромpayment-method=YANDEX
.
Type |
Description |
Enum: |
OrderBuyerDTO
Информация о покупателе.
Параметры id
, lastName
, firstName
и middleName
возвращаются, только если вы работаете по модели DBS.
Name |
Type |
Description |
id |
string |
Идентификатор покупателя. |
lastName |
string |
Фамилия покупателя. |
firstName |
string |
Имя покупателя. |
middleName |
string |
Отчество покупателя. |
type |
Тип покупателя: физическое лицо или организация. Этот параметр используется FBS- и FBY-магазинами, размещающими товары на витрине business.market.yandex.ru.
|
OrderStatusDeliveryDTO
Name |
Type |
Description |
id |
string |
Только для модели FBS Идентификатор доставки. Для модели DBS: передавайте идентификатор доставки, присвоенный магазином, в параметре |
shopDeliveryId |
string |
Только для модели DBS Идентификатор доставки, присвоенный магазином. Указывается, только если магазин передал данный идентификатор в ответе на запрос методом POST cart в параметре |
type |
Способ доставки заказа.
|
|
serviceName |
string |
Наименование службы доставки. |
price |
number<decimal> |
До 1 июля 2021 в нем возвращалась ваша стоимость доставки заказа. Сейчас Маркет всегда передает в этом поле 0, так как поле устарело и не используется, а стоимость доставки заказа рассчитывает автоматически, по единому тарифу на доставку. |
subsidy |
number<decimal> |
Субсидия за доставку в валюте заказа. Для отделения целой части от дробной используется точка. |
deliveryOptionId |
string |
Идентификатор опции доставки, переданный магазином. |
deliveryPartnerType |
Тип сотрудничества со службой доставки в рамках конкретного заказа.
|
|
dates |
Только для модели DBS Диапазон дат доставки. |
|
region |
Регион доставки. |
|
vat |
Только для модели DBS Ставка налога на добавленную стоимость (НДС) на услугу доставки заказа.
|
|
deliveryServiceId |
integer<int64> |
Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса GET delivery/services. |
liftType |
Только для модели DBS Тип подъема заказа на этаж.
|
|
liftPrice |
number<decimal> |
Только для модели DBS Стоимость подъема на этаж. |
outlet |
Только для модели DBS Пункт самовывоза, выбранный покупателем для получения заказа. Не возвращается в ответе, если покупатель выбрал получение заказа в брендированном пункте выдачи заказов Маркета (значение |
|
dispatchType |
Только для модели DBS Способ отгрузки.
|
|
shipments |
Информация о посылках. Для модели DBS: передается, если заказ был создан в пункт выдачи Маркета.
|
|
estimated |
boolean |
Только для модели DBS Признак, который показывает, что дата доставки по заказу не подтверждена. Передается для товаров на заказ с долгим сроком доставки (31–60 дней). Окончательную дату доставки нужно передать Маркету в течение 7 дней с даты оформления заказа в запросе PUT campaigns/{campaignId}/orders/{orderId}/delivery/date. |
eacType |
Только для модели Экспресс Тип кода подтверждения ЭАПП.
|
|
courier |
Только для модели Экспресс Информация о курьере. |
|
address |
Только для модели DBS Адрес доставки. Передается, если параметр |
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: |
OrderItemPromoDTO
Информация о вознаграждениях партнеру за скидки на товар по промокодам, купонам и акциям.
Name |
Type |
Description |
type* |
Тип скидки.
|
|
subsidy |
number<decimal> |
Вознаграждение партнеру от Маркета за товар, проданный в рамках акции. Передается в валюте заказа, для отделения целой части от дробной используется точка. |
marketPromoId |
string |
Идентификатор акции в рамках соглашения на оказание услуг по продвижению сервиса между Маркетом и партнером. Параметр передается, только если параметр |
OrderItemInstanceDTO
Переданные вами для данной позиции коды маркировки или УИНы. Коды «Честного знака» возвращаются в двух вариантах — с криптохвостом и без.
Name |
Type |
Description |
cis |
string |
Код идентификации единицы товара в системе «Честный ЗНАК» без криптохвоста. |
cisFull |
string |
Код идентификации единицы товара в системе «Честный ЗНАК» с криптохвостом. |
uin |
string |
УИН ювелирного изделия (16-значный код) Производитель получает УИН, когда регистрирует изделие в системе контроля за оборотом драгоценных металлов и камней — ГИИС ДМДК. |
rnpt |
string |
Регистрационный номер партии товара. Представляет собой строку из четырех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ/ХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на партию товара. Далее — дата, номер декларации и номер маркированного товара в декларации. |
gtd |
string |
Грузовая таможенная декларация. Представляет собой строку из трех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на ввезенные товары. Далее — дата и номер декларации. |
OrderBuyerType
Тип покупателя:
-
PERSON
— физическое лицо. -
BUSINESS
— организация.
Type |
Description |
Enum: |
OrderDeliveryType
Способ доставки заказа:
-
DELIVERY
— курьерская доставка. -
PICKUP
— самовывоз. -
POST
— почта. -
DIGITAL
— для цифровых товаров. -
UNKNOWN
— неизвестный тип.
Type |
Description |
Enum: |
OrderDeliveryPartnerType
Тип сотрудничества со службой доставки в рамках конкретного заказа:
-
SHOP
— магазин работает со службой доставки напрямую или доставляет заказы самостоятельно. -
YANDEX_MARKET
— магазин работает со службой доставки через Маркет. -
UNKNOWN
— неизвестный тип.
Type |
Description |
Enum: |
OrderDeliveryDatesDTO
Диапазон дат доставки.
Name |
Type |
Description |
fromDate |
string<date-dd-MM-yyyy> |
Ближайшая дата доставки. Формат даты:
|
toDate |
string<date-dd-MM-yyyy> |
Самая поздняя дата доставки. Если параметр Формат даты:
|
fromTime |
string<time> |
Начало интервала времени доставки. Передается только совместно с параметром Формат времени: 24-часовой, Минимальное значение: |
toTime |
string<time> |
Конец интервала времени доставки. Передается только совместно с параметром Формат времени: 24-часовой, Максимальное значение: |
realDeliveryDate |
string<date-dd-MM-yyyy> |
Дата, когда товар доставлен до пункта выдачи заказа (в случае самовывоза) или до покупателя (если заказ доставляет курьер).
|
ShopRegionDTO
Регион доставки.
Name |
Type |
Description |
id |
integer<int64> |
Идентификатор региона. |
name* |
string |
Название региона. |
type* |
Тип региона.
|
|
parent |
Информация о родительском регионе. Указываются родительские регионы до уровня страны. |
OrderLiftType
Тип подъема заказа на этаж:
-
NOT_NEEDED
— не требуется. -
MANUAL
— ручной. -
ELEVATOR
— лифт. -
CARGO_ELEVATOR
— грузовой лифт. -
FREE
— любой из перечисленных выше, если включена опция бесплатного подъема. -
UNKNOWN
— неизвестный тип.
Type |
Description |
Enum: |
ShopOutletDTO
Пункт самовывоза, выбранный покупателем для получения заказа. Не возвращается в ответе, если покупатель выбрал получение заказа в брендированном пункте выдачи заказов Маркета (значение MARKET_BRANDED_OUTLET
параметра dispatchType
).
Name |
Type |
Description |
code |
string |
Идентификатор пункта самовывоза, присвоенный магазином. |
OrderDeliveryDispatchType
Способ отгрузки:
-
BUYER
— доставка покупателю. -
MARKET_PARTNER_OUTLET
— доставка в пункт выдачи партнера. -
MARKET_BRANDED_OUTLET
— доставка в пункт выдачи заказов Маркета. -
SHOP_OUTLET
— доставка в пункт выдачи заказов магазина. -
DROPOFF
— доставка в пункт выдачи, который принимает заказы от продавцов и передает их курьерам. -
UNKNOWN
— неизвестный тип.
Type |
Description |
Enum: |
ShopOrderShipmentDTO
Список посылок.
Name |
Type |
Description |
id |
integer<int64> |
Идентификатор посылки, присвоенный Маркетом. |
status |
Статус заказа в партнерской службе доставки:
|
|
shipmentDate |
string<date-dd-MM-yyyy> |
День, в который нужно отгрузить заказ службе доставки. Формат даты: Для модели FBS: если заказ сделан организацией, параметр не возвращается до согласования даты доставки. Для модели DBS: если вы не передали параметр
|
shipmentTime |
string<time> |
Только для модели Экспресс Время, к которому магазин должен упаковать заказ и перевести его в статус Формат времени: 24-часовой, Если заказ сделан организацией, параметр не возвращается до согласования даты доставки. |
weight |
integer<int64> |
Вес упакованного заказа в граммах. Указывается, если заказ доставляет служба-партнер Маркета ( |
width |
integer<int64> |
Ширина упакованного заказа в сантиметрах. Указывается, если заказ доставляет служба-партнер Маркета ( |
height |
integer<int64> |
Высота упакованного заказа в сантиметрах. Указывается, если заказ доставляет служба-партнер Маркета ( |
depth |
integer<int64> |
Глубина упакованного заказа в сантиметрах. Указывается, если заказ доставляет служба-партнер Маркета ( |
boxes |
Список грузовых мест. |
OrderDeliveryEacType
Тип кода подтверждения ЭАПП:
-
MERCHANT_TO_COURIER
— продавец передает код курьеру. -
COURIER_TO_MERCHANT
— курьер передает код продавцу. -
CHECKING_BY_MERCHANT
— продавец проверяет код на своей стороне.
Type |
Description |
Enum: |
OrderCourierDTO
Информация о курьере.
Name |
Type |
Description |
fullName |
string |
Полное имя курьера. |
phone |
string |
Номер телефона курьера. |
phoneExtension |
string |
Добавочный номер телефона. |
vehicleNumber |
string |
Номер транспортного средства. |
vehicleDescription |
string |
Описание машины. Например, модель и цвет. |
ShopOrderDeliveryAddressDTO
Name |
Type |
Description |
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 |
number<decimal> |
Широта. Параметр указывается, если покупатель выбрал доставку заказа в брендированный пункт выдачи Маркета. Не гарантируем заполнение, так как это опциональное поле. |
lon |
number<decimal> |
Долгота. Параметр указывается, если покупатель выбрал доставку заказа в брендированный пункт выдачи Маркета. Не гарантируем заполнение, так как это опциональное поле. |
notes |
string |
Примечание к адресу. Например, вход со двора. Параметр указывается, если покупатель выбрал доставку заказа в брендированный пункт выдачи Маркета. |
outletPhones |
string[] |
Телефоны пункта выдачи в формате Параметр указывается, если покупатель выбрал доставку заказа в брендированный пункт выдачи Маркета.
|
schedule |
Расписание работы пункта выдачи. Параметр указывается, если покупатель выбрал доставку заказа в брендированный пункт выдачи Маркета.
|
|
phone |
string |
Телефон получателя заказа. Обязательный параметр. |
recipient |
string |
Фамилия, имя и отчество получателя заказа. Обязательный параметр. |
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: |
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: |
OrderParcelStatusType
Статус заказа в партнерской службе доставки:
-
NEW
— новый. -
CREATED
— создан в службе доставки. -
READY_TO_SHIP
— готов к передаче в службу доставки. -
ERROR
— ошибка создания заказа. -
UNKNOWN
— неизвестный статус.
Type |
Description |
Enum: |
ShopOrderParcelBoxDTO
Информация о грузоместе.
Name |
Type |
Description |
id |
integer<int64> |
Идентификатор грузового места. |
weight |
integer<int64> |
Вес грузового места в граммах. |
width |
integer<int64> |
Ширина грузового места в сантиметрах. |
height |
integer<int64> |
Высота грузового места в сантиметрах. |
depth |
integer<int64> |
Глубина грузового места в сантиметрах. |
items |
Информация о коробке. |
ShopOutletScheduleItemDTO
Расписание работы точки продаж.
Name |
Type |
Description |
fromDay* |
День недели, в который пункт выдачи начинает работать:
Обязательный параметр.
|
|
toDay* |
День недели, в который пункт выдачи заканчивает работать:
Обязательный параметр.
|
|
fromTime* |
string |
Время начала работы пункта выдачи. Формат времени: 24-часовой, Обязательный параметр.
|
toTime* |
string |
Время окончания работы пункта выдачи. Формат времени: 24-часовой, Обязательный параметр.
|
ShopOrderBoxItemDTO
Информация о коробке.
Name |
Type |
Description |
id |
integer<int64> |
Идентификатор коробки. |
count |
integer |
Количество товара в коробке. |
DayOfWeekType
День недели:
MONDAY
— понедельник.TUESDAY
— вторник.WEDNESDAY
— среда.THURSDAY
— четверг.FRIDAY
— пятница.SATURDAY
— суббота.SUNDAY
— воскресенье.
Type |
Description |
Enum: |
Responses
200 OK
Пустой ответ.
Если запрос от Маркета вернется повторно, на него необходимо ответить со статусом 200, поскольку Маркет не ожидает ответ от магазина.
400 Bad Request
Если магазин считает запрос, поступающий от Маркета, некорректным, магазин должен вернуть статус ответа 400 с описанием причины ошибки в теле ответа. Такие ответы будут анализироваться на предмет нарушений и недоработок API со стороны Маркета.
500 Internal Server Error
В случае технической ошибки на стороне магазина он должен вернуть статус ответа 500. Магазины с большим количеством таких ответов могут быть отключены от Маркета.