- Request
- Body
- OrderStatusType
- OrderSubstatusType
- DateDdMmYyyyHhMmSs
- LegacyDateTime
- CurrencyType
- OrderSubsidyType
- OrderSubsidyDTO
- OrderPaymentType
- OrderPaymentMethodType
- ShopSku
- OrderVatType
- OrderItemSubsidyType
- OrderItemSubsidyDTO
- OrderPromoType
- OrderItemPromoDTO
- CountryCode
- OrderItemInstanceDTO
- ItemTag
- ShopOrderItemDTO
- OrderTaxSystemType
- DateDdMmYyyy
- LegacyDate
- OrderTag
- BaseShopOrderDTO
- OrderBuyerType
- OrderBuyerBasicInfoDTO
- OrderBuyerDTO
- OrderDeliveryType
- OrderDeliveryPartnerType
- OrderDeliveryDatesDTO
- ShopRegionType
- ShopRegionDTO
- OrderLiftType
- ShopOutletDTO
- OrderDeliveryDispatchType
- OrderParcelStatusType
- ShopOrderBoxItemDTO
- ShopOrderParcelBoxDTO
- ShopOrderShipmentDTO
- OrderDeliveryEacType
- BaseDeliveryDTO
- OrderCourierDTO
- AddressDTO
- DayOfWeekType
- ShopOutletScheduleItemDTO
- DeliveryAddressWithoutPersonalDataDTO
- ShopOrderDeliveryAddressDTO
- OrderStatusDeliveryDTO
- OrderStatusShopOrderDTO
- Responses
- 200 OK
- 400 Bad Request
- 500 Internal Server Error
С 31 декабря push-API методы будут недоступны. С 1 октября они могут работать нестабильно.
Чтобы получать информацию об изменении статуса заказа, подключите API-уведомления. Как это сделать
Уведомление о смене статуса заказа
Уведомляет магазин о смене статуса заказа.
Таймаут на получение ответа: 10 секунд.
Request
POST
/order/status
Body
application/json
{
"order": {
"businessId": 0,
"id": 0,
"status": "PLACING",
"substatus": "RESERVATION_EXPIRED",
"creationDate": "23-09-2022 09:12:41",
"currency": "RUR",
"itemsTotal": 0.5,
"total": 0.5,
"deliveryTotal": 0.5,
"subsidyTotal": 0.5,
"totalWithSubsidy": 0.5,
"subsidies": [
{
"type": "YANDEX_CASHBACK",
"amount": 0.5
}
],
"buyerItemsTotal": 0.5,
"buyerTotal": 0.5,
"buyerItemsTotalBeforeDiscount": 0.5,
"buyerTotalBeforeDiscount": 0.5,
"paymentType": "PREPAID",
"paymentMethod": "SHOP_PREPAID",
"fake": true,
"shopOrderId": "example",
"items": [
{
"id": 0,
"feedId": 0,
"offerId": "example",
"feedCategoryId": "example",
"offerName": "example",
"fulfilmentShopId": 0,
"price": 0.5,
"buyerPrice": 0.5,
"buyerPriceBeforeDiscount": 0.5,
"priceBeforeDiscount": 0.5,
"count": 0,
"delivery": true,
"vat": "NO_VAT",
"shopSku": null,
"sku": "example",
"subsidy": 0.5,
"subsidies": [
null
],
"warehouseId": 0,
"partnerWarehouseId": "example",
"params": "example",
"promos": [
null
],
"instances": [
null
],
"tags": [
null
]
}
],
"notes": "example",
"taxSystem": "OSN",
"expiryDate": "23-09-2022",
"electronicAcceptanceCertificateCode": "example",
"tags": [
"ULTIMA"
],
"buyer": {
"id": "example",
"lastName": "example",
"firstName": "example",
"middleName": "example",
"email": "example",
"type": "PERSON",
"phone": "example"
},
"delivery": {
"id": "example",
"shopDeliveryId": "example",
"type": "DELIVERY",
"serviceName": "example",
"price": 0.5,
"subsidy": 0.5,
"deliveryOptionId": "example",
"deliveryPartnerType": "SHOP",
"dates": {},
"region": {},
"vat": null,
"deliveryServiceId": 0,
"liftType": "NOT_NEEDED",
"liftPrice": 0.5,
"outlet": {},
"dispatchType": "UNKNOWN",
"shipments": [
null
],
"estimated": true,
"eacType": "MERCHANT_TO_COURIER",
"courier": {},
"address": {}
}
}
}
|
Name |
Description |
|
order |
Type: OrderStatusShopOrderDTO Example
|
OrderStatusType
Статус заказа:
-
PLACING— оформляется, подготовка к резервированию. -
RESERVED— зарезервирован, но недооформлен. -
UNPAID— оформлен, но еще не оплачен (если выбрана оплата при оформлении). -
PROCESSING— находится в обработке. -
DELIVERY— передан в службу доставки. -
PICKUP— доставлен в пункт выдачи. -
DELIVERED— получен покупателем. -
CANCELLED— отменен. -
PENDING— ожидает обработки со стороны продавца. -
PARTIALLY_RETURNED— возвращен частично. -
RETURNED— возвращен полностью. -
UNKNOWN— неизвестный статус.
Также могут возвращаться другие значения. Обрабатывать их не нужно.
Type: string
Enum: PLACING, RESERVED, UNPAID, PROCESSING, DELIVERY, PICKUP, DELIVERED, CANCELLED, PENDING, PARTIALLY_RETURNED, RETURNED, UNKNOWN
OrderSubstatusType
Этап обработки заказа (статус PROCESSING) или причина отмены заказа (статус CANCELLED).
-
Значения для заказа в статусе
PROCESSING:-
STARTED— заказ подтвержден, его можно начать обрабатывать. -
READY_TO_SHIP— заказ собран и готов к отправке.
-
-
Значения для заказа в статусе
CANCELLED:-
RESERVATION_EXPIRED— покупатель не завершил оформление зарезервированного заказа в течение 10 минут. -
USER_NOT_PAID— покупатель не оплатил заказ (для типа оплатыPREPAID) в течение 30 минут. -
USER_UNREACHABLE— не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:- не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
- перерыв между первым и третьим звонком не менее 90 минут;
- соединение не короче 5 секунд.
Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.
-
USER_CHANGED_MIND— покупатель отменил заказ по личным причинам. -
USER_REFUSED_DELIVERY— покупателя не устроили условия доставки. -
USER_REFUSED_PRODUCT— покупателю не подошел товар. -
SHOP_FAILED— магазин не может выполнить заказ. -
USER_REFUSED_QUALITY— покупателя не устроило качество товара. -
REPLACING_ORDER— покупатель решил заменить товар другим по собственной инициативе. -
PROCESSING_EXPIRED— значение более не используется. -
PICKUP_EXPIRED— закончился срок хранения заказа в пункт выдачи. -
TOO_MANY_DELIVERY_DATE_CHANGES— заказ переносили слишком много раз. -
TOO_LONG_DELIVERY— заказ доставляется слишком долго. -
INCORRECT_PERSONAL_DATA— для заказа из-за рубежа указаны неправильные данные получателя, заказ не пройдет проверку на таможне.
-
-
TECHNICAL_ERROR— техническая ошибка на стороне Маркета. Обратитесь в поддержку.
Также могут возвращаться другие значения. Обрабатывать их не нужно.
Type: string
Enum: RESERVATION_EXPIRED, USER_NOT_PAID, USER_UNREACHABLE, USER_CHANGED_MIND, USER_REFUSED_DELIVERY, USER_REFUSED_PRODUCT, SHOP_FAILED, USER_REFUSED_QUALITY, REPLACING_ORDER, PROCESSING_EXPIRED, PENDING_EXPIRED, SHOP_PENDING_CANCELLED, PENDING_CANCELLED, USER_FRAUD, RESERVATION_FAILED, USER_PLACED_OTHER_ORDER, USER_BOUGHT_CHEAPER, MISSING_ITEM, BROKEN_ITEM, WRONG_ITEM, PICKUP_EXPIRED, DELIVERY_PROBLEMS, LATE_CONTACT, CUSTOM, DELIVERY_SERVICE_FAILED, WAREHOUSE_FAILED_TO_SHIP, DELIVERY_SERVICE_UNDELIVERED, PREORDER, AWAIT_CONFIRMATION, STARTED, PACKAGING, READY_TO_SHIP, SHIPPED, ASYNC_PROCESSING, WAITING_USER_INPUT, WAITING_BANK_DECISION, BANK_REJECT_CREDIT_OFFER, CUSTOMER_REJECT_CREDIT_OFFER, CREDIT_OFFER_FAILED, AWAIT_DELIVERY_DATES_CONFIRMATION, SERVICE_FAULT, DELIVERY_SERVICE_RECEIVED, USER_RECEIVED, WAITING_FOR_STOCKS, AS_PART_OF_MULTI_ORDER, READY_FOR_LAST_MILE, LAST_MILE_STARTED, ANTIFRAUD, DELIVERY_USER_NOT_RECEIVED, DELIVERY_SERVICE_DELIVERED, DELIVERED_USER_NOT_RECEIVED, USER_WANTED_ANOTHER_PAYMENT_METHOD, USER_RECEIVED_TECHNICAL_ERROR, USER_FORGOT_TO_USE_BONUS, DELIVERY_SERVICE_NOT_RECEIVED, DELIVERY_SERVICE_LOST, SHIPPED_TO_WRONG_DELIVERY_SERVICE, DELIVERED_USER_RECEIVED, WAITING_TINKOFF_DECISION, COURIER_SEARCH, COURIER_FOUND, COURIER_IN_TRANSIT_TO_SENDER, COURIER_ARRIVED_TO_SENDER, COURIER_RECEIVED, COURIER_NOT_FOUND, COURIER_NOT_DELIVER_ORDER, COURIER_RETURNS_ORDER, COURIER_RETURNED_ORDER, WAITING_USER_DELIVERY_INPUT, PICKUP_SERVICE_RECEIVED, PICKUP_USER_RECEIVED, CANCELLED_COURIER_NOT_FOUND, COURIER_NOT_COME_FOR_ORDER, DELIVERY_NOT_MANAGED_REGION, INCOMPLETE_CONTACT_INFORMATION, INCOMPLETE_MULTI_ORDER, INAPPROPRIATE_WEIGHT_SIZE, TECHNICAL_ERROR, SORTING_CENTER_LOST, COURIER_SEARCH_NOT_STARTED, LOST, AWAIT_PAYMENT, AWAIT_LAVKA_RESERVATION, USER_WANTS_TO_CHANGE_ADDRESS, FULL_NOT_RANSOM, PRESCRIPTION_MISMATCH, DROPOFF_LOST, DROPOFF_CLOSED, DELIVERY_TO_STORE_STARTED, USER_WANTS_TO_CHANGE_DELIVERY_DATE, WRONG_ITEM_DELIVERED, DAMAGED_BOX, AWAIT_DELIVERY_DATES, LAST_MILE_COURIER_SEARCH, PICKUP_POINT_CLOSED, LEGAL_INFO_CHANGED, USER_HAS_NO_TIME_TO_PICKUP_ORDER, DELIVERY_CUSTOMS_ARRIVED, DELIVERY_CUSTOMS_CLEARED, FIRST_MILE_DELIVERY_SERVICE_RECEIVED, AWAIT_AUTO_DELIVERY_DATES, AWAIT_USER_PERSONAL_DATA, NO_PERSONAL_DATA_EXPIRED, CUSTOMS_PROBLEMS, AWAIT_CASHIER, WAITING_POSTPAID_BUDGET_RESERVATION, AWAIT_SERVICEABLE_CONFIRMATION, POSTPAID_BUDGET_RESERVATION_FAILED, AWAIT_CUSTOM_PRICE_CONFIRMATION, READY_FOR_PICKUP, TOO_MANY_DELIVERY_DATE_CHANGES, TOO_LONG_DELIVERY, DEFERRED_PAYMENT, POSTPAID_FAILED, INCORRECT_PERSONAL_DATA, UNKNOWN
DateDdMmYyyyHhMmSs
Type: string<date-dd-MM-yyyy-HH-mm-ss>
Example: 23-09-2022 09:12:41
LegacyDateTime
Дата и время в формате dd-MM-yyyy-HH-mm-ss
Type: DateDdMmYyyyHhMmSs
Example: 23-09-2022 09:12:41
CurrencyType
Коды валют:
RUR— российский рубль.UAH— украинская гривна.BYR— белорусский рубль.KZT— казахстанский тенге.UZS— узбекский сум.
Type: string
Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE
OrderSubsidyType
Тип субсидии:
-
YANDEX_CASHBACK— скидка по подписке Яндекс Плюс. -
SUBSIDY— скидка Маркета (по акциям, промокодам, купонам и т. д.) -
DELIVERY— скидка за доставку (DBS).
Type: string
Enum: YANDEX_CASHBACK, SUBSIDY, DELIVERY
OrderSubsidyDTO
Общее вознаграждение продавцу за DBS-доставку и все скидки на товар:
- по промокодам, купонам и акциям;
- по баллам Плюса;
- по доставке (DBS).
|
Name |
Description |
|
amount |
Type: number Сумма субсидии. |
|
type |
Type: OrderSubsidyType Тип субсидии:
Enum: |
Example
{
"type": "YANDEX_CASHBACK",
"amount": 0.5
}
OrderPaymentType
Тип оплаты заказа:
-
PREPAID— оплата при оформлении заказа. -
POSTPAID— оплата при получении заказа. -
UNKNOWN— неизвестный тип.
Если параметр отсутствует, заказ будет оплачен при получении.
Type: string
Enum: PREPAID, POSTPAID, UNKNOWN
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— банковской картой. -
BOUND_CARD_ON_DELIVERY— привязанной картой при получении. -
BNPL_BANK_ON_DELIVERY— супер Сплитом. -
BNPL_ON_DELIVERY— Сплитом. -
CASH_ON_DELIVERY— наличными. -
B2B_ACCOUNT_POSTPAYMENT— заказ оплачивает организация после доставки.
-
-
UNKNOWN— неизвестный тип.
Значение по умолчанию: CASH_ON_DELIVERY.
Type: string
Enum: SHOP_PREPAID, BANK_CARD, YANDEX_MONEY, CASH_ON_DELIVERY, CARD_ON_DELIVERY, BOUND_CARD_ON_DELIVERY, BNPL_BANK_ON_DELIVERY, BNPL_ON_DELIVERY, YANDEX, APPLE_PAY, EXTERNAL_CERTIFICATE, CREDIT, INSTALLMENT, GOOGLE_PAY, TINKOFF_CREDIT, SBP, TINKOFF_INSTALLMENTS, B2B_ACCOUNT_PREPAYMENT, B2B_ACCOUNT_POSTPAYMENT, UNKNOWN
ShopSku
Ваш SKU — идентификатор товара в вашей системе.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.
Важно
Пробельные символы в начале и конце значения автоматически удаляются. Например, " SKU123 " и "SKU123" будут обработаны как одинаковые значения.
Что такое SKU и как его назначать
Type: string
Min length: 1
Max length: 255
Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$
Example: example
OrderVatType
НДС на товар или доставку:
-
NO_VAT— НДС не облагается, используется только для отдельных видов услуг. -
VAT_0— НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров. -
VAT_10— НДС 10%. Например, используется при реализации отдельных продовольственных и медицинских товаров. -
VAT_10_110— НДС 10/110. НДС 10%, применяется только при предоплате. -
VAT_20— НДС 20%. Основной НДС с 2019 года до 1 января 2026 года. -
VAT_20_120— НДС 20/120. НДС 20%, применяется только при предоплате. -
VAT_18— НДС 18%. Основной НДС до 2019 года. -
VAT_18_118— НДС 18/118. НДС использовался до 1 января 2019 года при предоплате. -
VAT_12— НДС 12%. Используется только в Узбекистане. -
VAT_05— НДС 5%. НДС для упрощенной системы налогообложения (УСН). -
VAT_07— НДС 7%. НДС для упрощенной системы налогообложения (УСН). -
VAT_22— НДС 22%. Основной НДС с 1 января 2026 года. -
UNKNOWN_VALUE— неизвестный тип.
Type: string
Enum: NO_VAT, VAT_0, VAT_10, VAT_10_110, VAT_20, VAT_20_120, VAT_18, VAT_18_118, VAT_12, VAT_05, VAT_07, VAT_22, UNKNOWN_VALUE
OrderItemSubsidyType
Тип субсидии:
-
YANDEX_CASHBACK— скидка по подписке Яндекс Плюс. -
SUBSIDY— скидка Маркета (по акциям, промокодам, купонам и т. д.).
Type: string
Enum: YANDEX_CASHBACK, SUBSIDY
OrderItemSubsidyDTO
Общее вознаграждение продавцу за все скидки на товар:
- по промокодам, купонам и акциям;
- по баллам Плюса.
|
Name |
Description |
|
amount |
Type: number Сумма субсидии. |
|
type |
Type: OrderItemSubsidyType Тип субсидии:
Enum: |
Example
{
"type": "YANDEX_CASHBACK",
"amount": 0.5
}
OrderPromoType
Тип скидки:
-
DIRECT_DISCOUNT— прямая скидка, которую устанавливает продавец или Маркет. -
BLUE_SET— комплекты. -
BLUE_FLASH— флеш-акция. -
MARKET_COUPON— скидка по промокоду Маркета. -
MARKET_PROMOCODE— скидка по промокоду магазина. -
MARKET_BLUE— скидка на Маркете. -
CHEAPEST_AS_GIFT— самый дешевый товар в подарок. -
CASHBACK— кешбэк. -
SPREAD_DISCOUNT_COUNT— скидка за количество одинаковых товаров. -
SPREAD_DISCOUNT_RECEIPT— скидка от суммы чека. -
DISCOUNT_BY_PAYMENT_TYPE— прямая скидка при оплате картой Плюса. -
PERCENT_DISCOUNT— прямая скидка в процентах. -
DCO_EXTRA_DISCOUNT— дополнительная скидка, необходимая для расчета субсидии от Маркета. -
UNKNOWN— неизвестный тип.
Устаревшие типы:
-
GENERIC_BUNDLE. -
MARKET_COIN. -
PRICE_DROP_AS_YOU_SHOP. -
SECRET_SALE.
Type: string
Enum: DIRECT_DISCOUNT, BLUE_SET, BLUE_FLASH, GENERIC_BUNDLE, MARKET_COUPON, MARKET_PROMOCODE, MARKET_BLUE, MARKET_COIN, PRICE_DROP_AS_YOU_SHOP, SECRET_SALE, CHEAPEST_AS_GIFT, CASHBACK, SPREAD_DISCOUNT_COUNT, SPREAD_DISCOUNT_RECEIPT, DISCOUNT_BY_PAYMENT_TYPE, PERCENT_DISCOUNT, DCO_EXTRA_DISCOUNT, UNKNOWN
OrderItemPromoDTO
Информация о вознаграждении продавцу за скидки на товар по промокодам, купонам и акциям.
|
Name |
Description |
|
type |
Type: OrderPromoType Тип скидки. Тип скидки:
Устаревшие типы:
Enum: |
|
marketPromoId |
Type: string Идентификатор акции в рамках соглашения на оказание услуг по продвижению сервиса между Маркетом и продавцом. Example: |
|
subsidy |
Type: number Вознаграждение продавцу от Маркета за товар, проданный в рамках акции. |
Example
{
"type": "DIRECT_DISCOUNT",
"subsidy": 0.5,
"marketPromoId": "example"
}
CountryCode
Страна производства в формате ISO 3166-1 alpha-2. Как получить
Type: string
Min length: 2
Max length: 2
Pattern: ^[A-Z]{2}$
Example: RU
OrderItemInstanceDTO
Переданные для данной позиции коды маркировки или УИНы. Коды «Честного знака» возвращаются в двух вариантах — с криптохвостом и без.
|
Name |
Description |
|
cis |
Type: string Код идентификации единицы товара в системе «Честный ЗНАК» без криптохвоста или «ASL BELGISI» (для продавцов Market Yandex Go). Example: |
|
cisFull |
Type: string Код идентификации единицы товара в системе «Честный ЗНАК» с криптохвостом. Example: |
|
countryCode |
Type: CountryCode Страна производства в формате ISO 3166-1 alpha-2. Как получить Min length: Max length: Pattern: Example: |
|
gtd |
Type: string Грузовая таможенная декларация. Представляет собой строку из трех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на ввезенные товары. Далее — дата и номер декларации. Example: |
|
rnpt |
Type: string Регистрационный номер партии товара. Представляет собой строку из четырех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ/ХХХ. Первая часть — код таможни, которая зарегистрировала декларацию на партию товара. Далее — дата, номер декларации и номер маркированного товара в декларации. Example: |
|
uin |
Type: string УИН ювелирного изделия (16-значный код) Производитель получает УИН, когда регистрирует изделие в системе контроля за оборотом драгоценных металлов и камней — ГИИС ДМДК. Example: |
Example
{
"cis": "example",
"cisFull": "example",
"uin": "example",
"rnpt": "example",
"gtd": "example",
"countryCode": "RU"
}
ItemTag
Признак товара:
ULTIMA— премиум-товар.SAFE_TAG— товар с защитной меткой. Она помогает исключить подмену товара при возврате. Вернуть товар без защитной метки, которая была при покупке, не получится.TURBO— товар, который быстро раскупают.
Type: string
Enum: ULTIMA, SAFE_TAG, TURBO
ShopOrderItemDTO
Список товаров в заказе.
|
Name |
Description |
|
buyerPrice |
Type: number Цена товара в валюте покупателя. В цене уже учтены скидки по:
Обратная совместимость Также заполняется устаревший параметр |
|
buyerPriceBeforeDiscount |
Type: number Стоимость товара в валюте покупателя до применения скидок. |
|
count |
Type: integer Количество единиц товара. |
|
delivery |
Type: boolean Только для модели FBS Доставка товара в указанный в запросе регион:
Принимает значение, которое вы передали в параметре |
|
feedCategoryId |
Type: string Только для модели DBS Идентификатор категории, указанный в каталоге. Example: |
|
feedId |
Type: integer Идентификатор каталога товаров. |
|
fulfilmentShopId |
Type: integer Идентификатор поставщика товара. Чтобы узнать его, войдите в кабинет продавца на Маркете и нажмите на его название. Идентификатор указан в поле ID магазина в строке нужного склада. |
|
id |
Type: integer Идентификатор товара в заказе. Позволяет идентифицировать товар в рамках заказа. |
|
instances |
Type: OrderItemInstanceDTO[] Информация о маркировке единиц товара. Возвращаются данные для маркировки, переданные в запросе PUT v2/campaigns/{campaignId}/orders/{orderId}/identifiers. Если магазин еще не передавал коды для этого заказа, Example
|
|
offerId |
Type: ShopSku Идентификатор вашего товарного предложения для определенного товара. Описание поля в Справке Маркета для продавцов Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU:
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Важно Пробельные символы в начале и конце значения автоматически удаляются. Например, Что такое SKU и как его назначать Min length: Max length: Pattern: Example: |
|
offerName |
Type: string Только для модели DBS Название товара. Example: |
|
params |
Type: string Характеристики товара (например, его цвет). Example: |
|
partnerWarehouseId |
Type: string Только для модели FBS Идентификатор склада в системе магазина, на который сформирован заказ. Example: |
|
price |
Type: number Цена товара в валюте заказа без учета вознаграждения продавцу за скидки по промокодам, купонам и акциям (параметр |
|
priceBeforeDiscount |
Type: number Стоимость товара в валюте магазина до применения скидок. |
|
promos |
Type: OrderItemPromoDTO[] Информация о вознаграждении продавцу за скидки на товар по промокодам, купонам и акциям. Example
|
|
shopSku |
Type: ShopSku Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU:
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Важно Пробельные символы в начале и конце значения автоматически удаляются. Например, Что такое SKU и как его назначать Min length: Max length: Pattern: Example: |
|
sku |
Type: string SKU на Маркете — идентификатор текущей карточки товара на Маркете. Example: |
|
subsidies |
Type: OrderItemSubsidyDTO[] Список субсидий по типам. Example
|
|
subsidy |
Type: number Вместо него используйте Общее вознаграждение продавцу за все скидки на товар:
|
|
tags |
Type: ItemTag[] Признаки товара. Example
|
|
vat |
Type: OrderVatType НДС на товар. Используется только вместе с параметром НДС на товар или доставку:
Enum: |
|
warehouseId |
Type: integer Только для модели FBS Идентификатор склада на Маркете. |
Example
{
"id": 0,
"feedId": 0,
"offerId": "example",
"feedCategoryId": "example",
"offerName": "example",
"fulfilmentShopId": 0,
"price": 0.5,
"buyerPrice": 0.5,
"buyerPriceBeforeDiscount": 0.5,
"priceBeforeDiscount": 0.5,
"count": 0,
"delivery": true,
"vat": "NO_VAT",
"shopSku": null,
"sku": "example",
"subsidy": 0.5,
"subsidies": [
{
"type": "YANDEX_CASHBACK",
"amount": 0.5
}
],
"warehouseId": 0,
"partnerWarehouseId": "example",
"params": "example",
"promos": [
{
"type": "DIRECT_DISCOUNT",
"subsidy": 0.5,
"marketPromoId": "example"
}
],
"instances": [
{
"cis": "example",
"cisFull": "example",
"uin": "example",
"rnpt": "example",
"gtd": "example",
"countryCode": "RU"
}
],
"tags": [
"ULTIMA"
]
}
OrderTaxSystemType
Система налогообложения (СНО) магазина на момент оформления заказа:
-
ECHN— единый сельскохозяйственный налог (ЕСХН). -
ENVD— единый налог на вмененный доход (ЕНВД). -
OSN— общая система налогообложения (ОСН). -
PSN— патентная система налогообложения (ПСН). -
USN— упрощенная система налогообложения (УСН). -
USN_MINUS_COST— упрощенная система налогообложения, доходы, уменьшенные на величину расходов (УСН «Доходы минус расходы»). -
NPD— налог на профессиональный доход (НПД). -
UNKNOWN_VALUE— неизвестное значение.
Type: string
Enum: OSN, USN, USN_MINUS_COST, ENVD, ECHN, PSN, NPD, UNKNOWN_VALUE
DateDdMmYyyy
Формат даты: ДД-ММ-ГГГГ.
Type: string<date-dd-MM-yyyy>
Example: 23-09-2022
LegacyDate
Дата в формате dd-MM-yyyy
Формат даты: ДД-ММ-ГГГГ.
Type: DateDdMmYyyy
Example: 23-09-2022
OrderTag
Признак заказа:
ULTIMA— заказ с премиум-товаром.
Type: string
Const: ULTIMA
Example: example
BaseShopOrderDTO
Заказ.
|
Name |
Description |
|
businessId |
Type: integer Идентификатор кабинета. |
|
buyerItemsTotal |
Type: number Стоимость всех товаров в заказе в валюте покупателя после применения скидок и без учета стоимости доставки. |
|
buyerItemsTotalBeforeDiscount |
Type: number Стоимость всех товаров в заказе в валюте покупателя до применения скидок и без учета стоимости доставки. |
|
buyerTotal |
Type: number Стоимость всех товаров в заказе в валюте покупателя после применения скидок и с учетом стоимости доставки. |
|
buyerTotalBeforeDiscount |
Type: number Стоимость всех товаров в заказе в валюте покупателя до применения скидок и с учетом стоимости доставки. |
|
creationDate |
Type: LegacyDateTime Дата и время оформления заказа. Формат даты и времени: Дата и время в формате dd-MM-yyyy-HH-mm-ss Example: |
|
currency |
Type: CurrencyType Валюта, в которой указаны цены на товары в заказе. Принимает значение Коды валют:
Enum: |
|
deliveryTotal |
Type: number Стоимость доставки в валюте заказа. |
|
electronicAcceptanceCertificateCode |
Type: string Только для модели FBS Шестизначный код подтверждения для:
Подробно о работе с кодами рассказано в Справке Маркета для продавцов. Example: |
|
expiryDate |
Type: LegacyDate Дата, после которой заказ будет отменен, если не сменит статус. Формат даты: Дата в формате dd-MM-yyyy Формат даты: Example: |
|
fake |
Type: boolean Тип заказа:
|
|
id |
Type: integer Идентификатор заказа. |
|
items |
Type: ShopOrderItemDTO[] Список товаров в заказе. Example
|
|
itemsTotal |
Type: number Общая сумма заказа в валюте заказа без учета стоимости доставки и вознаграждения продавцу за скидки по промокодам, купонам и акциям (параметр |
|
notes |
Type: string Комментарий к заказу. Example: |
|
paymentMethod |
Type: OrderPaymentMethodType Способ оплаты заказа:
Значение по умолчанию: Enum: |
|
paymentType |
Type: OrderPaymentType Тип оплаты заказа:
Если параметр отсутствует, заказ будет оплачен при получении. Enum: |
|
shopOrderId |
Type: string Идентификатор заказа в магазине. Example: |
|
status |
Type: OrderStatusType Статус заказа:
Также могут возвращаться другие значения. Обрабатывать их не нужно. Enum: |
|
subsidies |
Type: OrderSubsidyDTO[] Список субсидий по типам. Example
|
|
subsidyTotal |
Type: number Общее вознаграждение продавцу за скидки:
|
|
substatus |
Type: OrderSubstatusType Этап обработки заказа (статус
Также могут возвращаться другие значения. Обрабатывать их не нужно. Enum: |
|
tags |
Type: OrderTag[] Признаки заказа. Example
|
|
taxSystem |
Type: OrderTaxSystemType Система налогообложения (СНО) магазина на момент оформления заказа:
Enum: |
|
total |
Type: number Общая сумма заказа в валюте заказа с учетом стоимости доставки, но без учета вознаграждения продавцу за скидки по промокодам, купонам, кешбэку и акциям (параметр |
|
totalWithSubsidy |
Type: number Сумма стоимости всех товаров в заказе и вознаграждения за них в валюте магазина (сумма параметров |
Example
{
"businessId": 0,
"id": 0,
"status": "PLACING",
"substatus": "RESERVATION_EXPIRED",
"creationDate": "23-09-2022 09:12:41",
"currency": "RUR",
"itemsTotal": 0.5,
"total": 0.5,
"deliveryTotal": 0.5,
"subsidyTotal": 0.5,
"totalWithSubsidy": 0.5,
"subsidies": [
{
"type": "YANDEX_CASHBACK",
"amount": 0.5
}
],
"buyerItemsTotal": 0.5,
"buyerTotal": 0.5,
"buyerItemsTotalBeforeDiscount": 0.5,
"buyerTotalBeforeDiscount": 0.5,
"paymentType": "PREPAID",
"paymentMethod": "SHOP_PREPAID",
"fake": true,
"shopOrderId": "example",
"items": [
{
"id": 0,
"feedId": 0,
"offerId": "example",
"feedCategoryId": "example",
"offerName": "example",
"fulfilmentShopId": 0,
"price": 0.5,
"buyerPrice": 0.5,
"buyerPriceBeforeDiscount": 0.5,
"priceBeforeDiscount": 0.5,
"count": 0,
"delivery": true,
"vat": "NO_VAT",
"shopSku": null,
"sku": "example",
"subsidy": 0.5,
"subsidies": [
{
"type": "YANDEX_CASHBACK",
"amount": 0.5
}
],
"warehouseId": 0,
"partnerWarehouseId": "example",
"params": "example",
"promos": [
{
"type": "DIRECT_DISCOUNT",
"subsidy": 0.5,
"marketPromoId": "example"
}
],
"instances": [
{
"cis": "example",
"cisFull": "example",
"uin": "example",
"rnpt": "example",
"gtd": "example",
"countryCode": "RU"
}
],
"tags": [
"ULTIMA"
]
}
],
"notes": "example",
"taxSystem": "OSN",
"expiryDate": "23-09-2022",
"electronicAcceptanceCertificateCode": "example",
"tags": [
"ULTIMA"
]
}
OrderBuyerType
Тип покупателя:
-
PERSON— физическое лицо. -
BUSINESS— организация.
Type: string
Enum: PERSON, BUSINESS
OrderBuyerBasicInfoDTO
Информация о покупателе с базовыми полями.
|
Name |
Description |
|
type |
Type: OrderBuyerType Тип покупателя: физическое лицо или организация. Только для FBS- и FBY-магазинов, которые размещают товары на витрине business.market.yandex.ru. Тип покупателя:
Enum: |
|
firstName |
Type: string Имя. Example: |
|
id |
Type: string Идентификатор покупателя. Example: |
|
lastName |
Type: string Фамилия. Example: |
|
middleName |
Type: string Отчество. Example: |
Example
{
"id": "example",
"lastName": "example",
"firstName": "example",
"middleName": "example",
"type": "PERSON"
}
OrderBuyerDTO
Информация о покупателе.
Параметры id, lastName, firstName и middleName возвращаются, только если вы работаете по модели DBS.
Type: object
All of 2 types
-
Type: OrderBuyerBasicInfoDTO
Информация о покупателе с базовыми полями.
Example
{ "id": "example", "lastName": "example", "firstName": "example", "middleName": "example", "email": "example", "type": "PERSON" } -
Type: object
phone
Type: string
Номер телефона покупателя.
Формат номера:
+<код_страны><код_региона><номер_телефона>.Example:
exampleExample
{ "phone": "example" }
Example
{
"id": "example",
"lastName": "example",
"firstName": "example",
"middleName": "example",
"email": "example",
"type": "PERSON",
"phone": "example"
}
OrderDeliveryType
Способ доставки заказа:
-
DELIVERY— курьерская доставка. -
PICKUP— самовывоз. -
POST— почта. -
DIGITAL— для цифровых товаров. -
UNKNOWN— неизвестный тип.
Type: string
Enum: DELIVERY, PICKUP, POST, DIGITAL, UNKNOWN
OrderDeliveryPartnerType
Тип сотрудничества со службой доставки в рамках конкретного заказа:
-
SHOP— магазин работает со службой доставки напрямую или доставляет заказы самостоятельно. -
YANDEX_MARKET— магазин работает со службой доставки через Маркет. -
UNKNOWN— неизвестный тип.
Type: string
Enum: SHOP, YANDEX_MARKET, UNKNOWN
OrderDeliveryDatesDTO
Диапазон дат доставки.
|
Name |
Description |
|
fromDate |
Type: DateDdMmYyyy Ближайшая дата доставки. Формат даты: Формат даты: Example: |
|
fromTime |
Type: string<time> Начало интервала времени доставки. Передается только вместе с параметром Формат времени: 24-часовой, Минимальное значение: Example: |
|
realDeliveryDate |
Type: DateDdMmYyyy Дата, когда товар доставлен до пункта выдачи (в случае самовывоза) или до покупателя (если заказ доставляет курьер). Формат даты: Example: |
|
toDate |
Type: DateDdMmYyyy Самая поздняя дата доставки. Если Формат даты: Формат даты: Example: |
|
toTime |
Type: string<time> Конец интервала времени доставки. Передается только вместе с параметром Формат времени: 24-часовой, Максимальное значение: Example: |
Example
{
"fromDate": "23-09-2022",
"toDate": null,
"fromTime": "12:00:00",
"toTime": "12:00:00",
"realDeliveryDate": null
}
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: string
Enum: OTHER, CITY_DISTRICT, CITY, CONTINENT, COUNTRY_DISTRICT, COUNTRY, REGION, METRO_STATION, MONORAIL_STATION, OVERSEAS_TERRITORY, SECONDARY_DISTRICT, SETTLEMENT, SUBJECT_FEDERATION, SUBJECT_FEDERATION_DISTRICT, VILLAGE, SUBURB
ShopRegionDTO
Регион доставки.
|
Name |
Description |
|
name |
Type: string Название региона. Example: |
|
type |
Type: ShopRegionType Тип региона. Тип региона:
Enum: |
|
id |
Type: integer Идентификатор региона. |
|
parent |
Type: ShopRegionDTO Информация о родительском регионе. Указываются родительские регионы до уровня страны. Регион доставки. Example
|
Example
{
"id": 0,
"name": "example",
"type": "OTHER",
"parent": {
"id": 0,
"name": "example",
"type": null,
"parent": null
}
}
OrderLiftType
Тип подъема заказа на этаж:
-
NOT_NEEDED— не требуется. -
MANUAL— ручной. -
ELEVATOR— лифт. -
CARGO_ELEVATOR— грузовой лифт. -
FREE— любой из перечисленных выше, если включена опция бесплатного подъема. -
UNKNOWN— неизвестный тип.
Type: string
Enum: NOT_NEEDED, MANUAL, ELEVATOR, CARGO_ELEVATOR, FREE, UNKNOWN
ShopOutletDTO
Пункт самовывоза, выбранный покупателем для получения заказа. Не возвращается в ответе, если покупатель выбрал получение заказа в брендированном пункте выдачи заказов Маркета (значение MARKET_BRANDED_OUTLET параметра dispatchType).
|
Name |
Description |
|
code |
Type: string Идентификатор пункта выдачи, присвоенный магазином. Example: |
Example
{
"code": "example"
}
OrderDeliveryDispatchType
Способ доставки:
-
BUYER— курьерская доставка покупателю. -
MARKET_BRANDED_OUTLET— доставка в пункт выдачи заказов Маркета. -
SHOP_OUTLET— доставка в пункт выдачи заказов магазина. -
UNKNOWN— неизвестный тип.
Type: string
Enum: UNKNOWN, BUYER, MARKET_BRANDED_OUTLET, SHOP_OUTLET
OrderParcelStatusType
Deprecated
Статус заказа в партнерской службе доставки:
-
NEW— новый. -
CREATED— создан в службе доставки. -
READY_TO_SHIP— готов к передаче в службу доставки. -
ERROR— ошибка создания заказа. -
UNKNOWN— неизвестный статус.
Type: string
Enum: NEW, CREATED, READY_TO_SHIP, ERROR, UNKNOWN
ShopOrderBoxItemDTO
Информация о коробке.
|
Name |
Description |
|
count |
Type: integer Количество товара в коробке. |
|
id |
Type: integer Идентификатор коробки. |
Example
{
"id": 0,
"count": 0
}
ShopOrderParcelBoxDTO
Информация о грузоместе.
|
Name |
Description |
|
depth |
Type: integer Глубина грузового места в сантиметрах. |
|
height |
Type: integer Высота грузового места в сантиметрах. |
|
id |
Type: integer Идентификатор грузового места. |
|
items |
Type: ShopOrderBoxItemDTO[] Example
|
|
weight |
Type: integer Вес грузового места в граммах. |
|
width |
Type: integer Ширина грузового места в сантиметрах. |
Example
{
"id": 0,
"weight": 0,
"width": 0,
"height": 0,
"depth": 0,
"items": [
{
"id": 0,
"count": 0
}
]
}
ShopOrderShipmentDTO
Список посылок.
|
Name |
Description |
|
boxes |
Type: ShopOrderParcelBoxDTO[] Список грузовых мест. Example
|
|
depth |
Type: integer Глубина упакованного заказа в сантиметрах. Указывается, если заказ доставляет служба-партнер Маркета ( |
|
height |
Type: integer Высота упакованного заказа в сантиметрах. Указывается, если заказ доставляет служба-партнер Маркета ( |
|
id |
Type: integer Идентификатор посылки, присвоенный Маркетом. |
|
shipmentDate |
Type: LegacyDate День, в который нужно отгрузить заказ службе доставки. Формат даты: Для модели FBS: если заказ сделан организацией, параметр не возвращается до согласования даты доставки. Для модели DBS: если вы не передали параметр Дата в формате dd-MM-yyyy Формат даты: Example: |
|
shipmentTime |
Type: string<time> Только для модели Экспресс Время, к которому магазин должен упаковать заказ и перевести его в статус Формат времени: 24-часовой, Если заказ сделан организацией, параметр не возвращается до согласования даты доставки. Example: |
|
status |
Type: OrderParcelStatusType Статус заказа в партнерской службе доставки:
Enum: |
|
weight |
Type: integer Вес упакованного заказа в граммах. Указывается, если заказ доставляет служба-партнер Маркета ( |
|
width |
Type: integer Ширина упакованного заказа в сантиметрах. Указывается, если заказ доставляет служба-партнер Маркета ( |
Example
{
"id": 0,
"status": "NEW",
"shipmentDate": "23-09-2022",
"shipmentTime": "12:00:00",
"weight": 0,
"width": 0,
"height": 0,
"depth": 0,
"boxes": [
{
"id": 0,
"weight": 0,
"width": 0,
"height": 0,
"depth": 0,
"items": [
{
"id": 0,
"count": 0
}
]
}
]
}
OrderDeliveryEacType
Тип кода подтверждения ЭАПП:
-
MERCHANT_TO_COURIER(временно не возвращается) — продавец передает код курьеру для получения невыкупа. -
COURIER_TO_MERCHANT— курьер передает код продавцу для получения заказа. -
CHECKING_BY_MERCHANT— продавец проверяет код на своей стороне.
Type: string
Enum: MERCHANT_TO_COURIER, COURIER_TO_MERCHANT, CHECKING_BY_MERCHANT
BaseDeliveryDTO
Информация о доставке.
|
Name |
Description |
|
dates |
Type: OrderDeliveryDatesDTO Только для модели DBS Диапазон дат доставки. Диапазон дат доставки. Example
|
|
deliveryPartnerType |
Type: OrderDeliveryPartnerType Тип сотрудничества со службой доставки в рамках указанного заказа. Тип сотрудничества со службой доставки в рамках конкретного заказа:
Enum: |
|
deliveryServiceId |
Type: integer Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса GET delivery/services. |
|
dispatchType |
Type: OrderDeliveryDispatchType Только для модели DBS Способ отгрузки. Способ доставки:
Enum: |
|
eacType |
Type: OrderDeliveryEacType Только для модели Экспресс Тип кода подтверждения ЭАПП. Тип кода подтверждения ЭАПП:
Enum: |
|
estimated |
Type: boolean Только для модели DBS Признак, который показывает, что дата доставки по заказу не подтверждена. Передается для товаров на заказ с долгим сроком доставки (31–60 дней). Окончательную дату доставки нужно передать Маркету в течение 7 дней с даты оформления заказа в запросе PUT v2/campaigns/{campaignId}/orders/{orderId}/delivery/date. |
|
liftPrice |
Type: number Только для модели DBS Стоимость подъема на этаж. |
|
liftType |
Type: OrderLiftType Только для модели DBS Тип подъема заказа на этаж. Тип подъема заказа на этаж:
Enum: |
|
outlet |
Type: ShopOutletDTO Только для модели DBS Пункт самовывоза, выбранный покупателем для получения заказа. Не возвращается в ответе, если покупатель выбрал получение заказа в брендированном пункте выдачи заказов Маркета (значение Пункт самовывоза, выбранный покупателем для получения заказа. Не возвращается в ответе, если покупатель выбрал получение заказа в брендированном пункте выдачи заказов Маркета (значение Example
|
|
price |
Type: number Не используйте этот параметр. |
|
region |
Type: ShopRegionDTO Регион доставки. Example
|
|
serviceName |
Type: string Название службы доставки. Example: |
|
shipments |
Type: ShopOrderShipmentDTO[] Информация о посылках. Для модели DBS: передается, если заказ был создан в пункт выдачи Маркета. Example
|
|
shopDeliveryId |
Type: string Только для модели DBS Идентификатор доставки, присвоенный магазином. Указывается, только если магазин передал данный идентификатор в ответе на запрос методом POST cart в параметре Example: |
|
subsidy |
Type: number Субсидия за доставку. |
|
type |
Type: OrderDeliveryType Способ доставки заказа. Способ доставки заказа:
Enum: |
|
vat |
Type: OrderVatType Только для модели DBS Налог на добавленную стоимость (НДС) на услугу доставки заказа. НДС на товар или доставку:
Enum: |
Example
{
"shopDeliveryId": "example",
"type": "DELIVERY",
"serviceName": "example",
"price": 0.5,
"subsidy": 0.5,
"deliveryPartnerType": "SHOP",
"dates": {
"fromDate": "23-09-2022",
"toDate": null,
"fromTime": "12:00:00",
"toTime": "12:00:00",
"realDeliveryDate": null
},
"region": {
"id": 0,
"name": "example",
"type": "OTHER",
"parent": null
},
"vat": "NO_VAT",
"deliveryServiceId": 0,
"liftType": "NOT_NEEDED",
"liftPrice": 0.5,
"outlet": {
"code": "example"
},
"dispatchType": "UNKNOWN",
"shipments": [
{
"id": 0,
"status": "NEW",
"shipmentDate": null,
"shipmentTime": "12:00:00",
"weight": 0,
"width": 0,
"height": 0,
"depth": 0,
"boxes": [
{
"id": 0,
"weight": 0,
"width": 0,
"height": 0,
"depth": 0,
"items": [
null
]
}
]
}
],
"estimated": true,
"eacType": "MERCHANT_TO_COURIER"
}
OrderCourierDTO
Информация о курьере.
|
Name |
Description |
|
fullName |
Type: string Полное имя. Example: |
|
phone |
Type: string Номер телефона. Example: |
|
phoneExtension |
Type: string Добавочный номер телефона. Example: |
|
vehicleDescription |
Type: string Описание транспортного средства. Например, модель и цвет. Example: |
|
vehicleNumber |
Type: string Номер транспортного средства. Example: |
Example
{
"fullName": "example",
"phone": "example",
"phoneExtension": "example",
"vehicleNumber": "example",
"vehicleDescription": "example"
}
AddressDTO
Адрес.
|
Name |
Description |
|
apartment |
Type: string Номер квартиры или офиса. Example: |
|
block |
Type: string Корпус или строение. Example: |
|
city |
Type: string Город или населенный пункт. Обязательный параметр. Example: |
|
country |
Type: string Страна. Необязательный параметр, если выбрана доставка заказа в пункт выдачи Маркета. Example: |
|
district |
Type: string Район. Example: |
|
entrance |
Type: string Номер подъезда. Example: |
|
entryphone |
Type: string Код домофона. Example: |
|
floor |
Type: string Этаж. Example: |
|
house |
Type: string Номер дома или владения. Обязательный параметр. Example: |
|
postcode |
Type: string Почтовый индекс. Указывается, если выбрана доставка почтой ( Example: |
|
street |
Type: string Улица. Example: |
|
subway |
Type: string Станция метро. Example: |
Example
{
"country": "example",
"postcode": "example",
"city": "example",
"district": "example",
"subway": "example",
"street": "example",
"house": "example",
"block": "example",
"entrance": "example",
"entryphone": "example",
"floor": "example",
"apartment": "example"
}
DayOfWeekType
День недели:
MONDAY— понедельник.TUESDAY— вторник.WEDNESDAY— среда.THURSDAY— четверг.FRIDAY— пятница.SATURDAY— суббота.SUNDAY— воскресенье.
Type: string
Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
ShopOutletScheduleItemDTO
Расписание работы точки продаж.
|
Name |
Description |
|
fromDay |
Type: DayOfWeekType День недели, в который пункт выдачи начинает работать:
Обязательный параметр. День недели:
Enum: |
|
fromTime |
Type: string Время начала работы пункта выдачи. Формат времени: 24-часовой, Обязательный параметр. Min length: Example: |
|
toDay |
Type: DayOfWeekType День недели, в который пункт выдачи заканчивает работать:
Обязательный параметр. День недели:
Enum: |
|
toTime |
Type: string Время окончания работы пункта выдачи. Формат времени: 24-часовой, Обязательный параметр. Min length: Example: |
Example
{
"fromDay": "MONDAY",
"toDay": null,
"fromTime": "example",
"toTime": "example"
}
DeliveryAddressWithoutPersonalDataDTO
Адрес доставки. Передается, если параметр type имеет значение DELIVERY.
All of 2 types
-
Type: AddressDTO
Адрес.
Example
{ "country": "example", "postcode": "example", "city": "example", "district": "example", "subway": "example", "street": "example", "house": "example", "block": "example", "entrance": "example", "entryphone": "example", "floor": "example", "apartment": "example" } -
Type: object
lat
Type: number
Широта.
Параметр указывается, если покупатель выбрал доставку заказа в брендированный пункт выдачи Маркета.
Не гарантируем заполнение, так как это опциональное поле.
lon
Type: number
Долгота.
Параметр указывается, если покупатель выбрал доставку заказа в брендированный пункт выдачи Маркета.
Не гарантируем заполнение, так как это опциональное поле.
notes
Type: string
Примечание к адресу. Например,
Вход со двора.Параметр указывается, если покупатель выбрал доставку заказа в брендированный пункт выдачи Маркета.
Example:
exampleoutletPhones
Type: string[]
Телефоны пункта выдачи в формате
8 812 123-45-67 890(890— добавочный).Параметр указывается, если покупатель выбрал доставку заказа в брендированный пункт выдачи Маркета.
Example
[ "example" ]schedule
Type: ShopOutletScheduleItemDTO[]
Расписание работы пункта выдачи.
Параметр указывается, если покупатель выбрал доставку заказа в брендированный пункт выдачи Маркета.
Example
[ { "fromDay": "MONDAY", "toDay": null, "fromTime": "example", "toTime": "example" } ]Example
{ "lat": 0.5, "lon": 0.5, "notes": "example", "outletPhones": [ "example" ], "schedule": [ { "fromDay": "MONDAY", "toDay": null, "fromTime": "example", "toTime": "example" } ] }
Example
{
"country": "example",
"postcode": "example",
"city": "example",
"district": "example",
"subway": "example",
"street": "example",
"house": "example",
"block": "example",
"entrance": "example",
"entryphone": "example",
"floor": "example",
"apartment": "example",
"lat": 0.5,
"lon": 0.5,
"notes": "example",
"outletPhones": [
"example"
],
"schedule": [
{
"fromDay": "MONDAY",
"toDay": null,
"fromTime": "example",
"toTime": "example"
}
]
}
ShopOrderDeliveryAddressDTO
Type: object
All of 2 types
-
Type: DeliveryAddressWithoutPersonalDataDTO
Адрес доставки. Передается, если параметр
typeимеет значениеDELIVERY.Example
{ "country": "example", "postcode": "example", "city": "example", "district": "example", "subway": "example", "street": "example", "house": "example", "block": "example", "entrance": "example", "entryphone": "example", "floor": "example", "apartment": "example", "lat": 0.5, "lon": 0.5, "phone": "example", "recipient": "example", "notes": "example", "outletPhones": [ "example" ], "schedule": [ { "fromDay": "MONDAY", "toDay": null, "fromTime": "example", "toTime": "example" } ] } -
Type: object
phone
Type: string
Телефон получателя заказа.
Обязательный параметр.
Example:
examplerecipient
Type: string
Фамилия, имя и отчество получателя заказа.
Обязательный параметр.
Example:
exampleExample
{ "phone": "example", "recipient": "example" }
Example
{
"country": "example",
"postcode": "example",
"city": "example",
"district": "example",
"subway": "example",
"street": "example",
"house": "example",
"block": "example",
"entrance": "example",
"entryphone": "example",
"floor": "example",
"apartment": "example",
"lat": 0.5,
"lon": 0.5,
"phone": "example",
"recipient": "example",
"notes": "example",
"outletPhones": [
"example"
],
"schedule": [
{
"fromDay": "MONDAY",
"toDay": null,
"fromTime": "example",
"toTime": "example"
}
]
}
OrderStatusDeliveryDTO
Type: object
All of 2 types
-
Type: BaseDeliveryDTO
Информация о доставке.
Example
{ "id": "example", "shopDeliveryId": "example", "type": "DELIVERY", "serviceName": "example", "price": 0.5, "subsidy": 0.5, "deliveryOptionId": "example", "deliveryPartnerType": "SHOP", "dates": { "fromDate": "23-09-2022", "toDate": null, "fromTime": "12:00:00", "toTime": "12:00:00", "realDeliveryDate": null }, "region": { "id": 0, "name": "example", "type": "OTHER", "parent": null }, "vat": "NO_VAT", "deliveryServiceId": 0, "liftType": "NOT_NEEDED", "liftPrice": 0.5, "outlet": { "code": "example" }, "dispatchType": "UNKNOWN", "shipments": [ { "id": 0, "status": "NEW", "shipmentDate": null, "shipmentTime": "12:00:00", "weight": 0, "width": 0, "height": 0, "depth": 0, "boxes": [ { "id": 0, "weight": 0, "width": 0, "height": 0, "depth": 0, "items": [ null ] } ] } ], "estimated": true, "eacType": "MERCHANT_TO_COURIER" } -
Type: object
address
Type: ShopOrderDeliveryAddressDTO
Только для модели DBS
Адрес доставки. Передается, если параметр
typeимеет значениеDELIVERY.Example
{ "country": "example", "postcode": "example", "city": "example", "district": "example", "subway": "example", "street": "example", "house": "example", "block": "example", "entrance": "example", "entryphone": "example", "floor": "example", "apartment": "example", "lat": 0.5, "lon": 0.5, "phone": "example", "recipient": "example", "notes": "example", "outletPhones": [ "example" ], "schedule": [ { "fromDay": "MONDAY", "toDay": null, "fromTime": "example", "toTime": "example" } ] }courier
Type: OrderCourierDTO
Только для модели Экспресс
Информация о курьере.
Информация о курьере.
Example
{ "fullName": "example", "phone": "example", "phoneExtension": "example", "vehicleNumber": "example", "vehicleDescription": "example" }Example
{ "courier": { "fullName": "example", "phone": "example", "phoneExtension": "example", "vehicleNumber": "example", "vehicleDescription": "example" }, "address": { "country": "example", "postcode": "example", "city": "example", "district": "example", "subway": "example", "street": "example", "house": "example", "block": "example", "entrance": "example", "entryphone": "example", "floor": "example", "apartment": "example", "lat": 0.5, "lon": 0.5, "phone": "example", "recipient": "example", "notes": "example", "outletPhones": [ "example" ], "schedule": [ {} ] } }
Example
{
"id": "example",
"shopDeliveryId": "example",
"type": "DELIVERY",
"serviceName": "example",
"price": 0.5,
"subsidy": 0.5,
"deliveryOptionId": "example",
"deliveryPartnerType": "SHOP",
"dates": {
"fromDate": "23-09-2022",
"toDate": null,
"fromTime": "12:00:00",
"toTime": "12:00:00",
"realDeliveryDate": null
},
"region": {
"id": 0,
"name": "example",
"type": "OTHER",
"parent": null
},
"vat": "NO_VAT",
"deliveryServiceId": 0,
"liftType": "NOT_NEEDED",
"liftPrice": 0.5,
"outlet": {
"code": "example"
},
"dispatchType": "UNKNOWN",
"shipments": [
{
"id": 0,
"status": "NEW",
"shipmentDate": null,
"shipmentTime": "12:00:00",
"weight": 0,
"width": 0,
"height": 0,
"depth": 0,
"boxes": [
{}
]
}
],
"estimated": true,
"eacType": "MERCHANT_TO_COURIER",
"courier": {
"fullName": "example",
"phone": "example",
"phoneExtension": "example",
"vehicleNumber": "example",
"vehicleDescription": "example"
},
"address": {
"country": "example",
"postcode": "example",
"city": "example",
"district": "example",
"subway": "example",
"street": "example",
"house": "example",
"block": "example",
"entrance": "example",
"entryphone": "example",
"floor": "example",
"apartment": "example",
"lat": 0.5,
"lon": 0.5,
"phone": "example",
"recipient": "example",
"notes": "example",
"outletPhones": [
null
],
"schedule": [
null
]
}
}
OrderStatusShopOrderDTO
Type: object
All of 2 types
-
Type: BaseShopOrderDTO
Заказ.
Example
{ "businessId": 0, "id": 0, "status": "PLACING", "substatus": "RESERVATION_EXPIRED", "creationDate": "23-09-2022 09:12:41", "currency": "RUR", "itemsTotal": 0.5, "total": 0.5, "deliveryTotal": 0.5, "subsidyTotal": 0.5, "totalWithSubsidy": 0.5, "subsidies": [ { "type": "YANDEX_CASHBACK", "amount": 0.5 } ], "buyerItemsTotal": 0.5, "buyerTotal": 0.5, "buyerItemsTotalBeforeDiscount": 0.5, "buyerTotalBeforeDiscount": 0.5, "paymentType": "PREPAID", "paymentMethod": "SHOP_PREPAID", "fake": true, "shopOrderId": "example", "items": [ { "id": 0, "feedId": 0, "offerId": "example", "feedCategoryId": "example", "offerName": "example", "fulfilmentShopId": 0, "price": 0.5, "buyerPrice": 0.5, "buyerPriceBeforeDiscount": 0.5, "priceBeforeDiscount": 0.5, "count": 0, "delivery": true, "vat": "NO_VAT", "shopSku": null, "sku": "example", "subsidy": 0.5, "subsidies": [ { "type": "YANDEX_CASHBACK", "amount": 0.5 } ], "warehouseId": 0, "partnerWarehouseId": "example", "params": "example", "promos": [ { "type": "DIRECT_DISCOUNT", "subsidy": 0.5, "marketPromoId": "example" } ], "instances": [ { "cis": "example", "cisFull": "example", "uin": "example", "rnpt": "example", "gtd": "example", "countryCode": "RU" } ], "tags": [ "ULTIMA" ] } ], "notes": "example", "taxSystem": "OSN", "expiryDate": "23-09-2022", "electronicAcceptanceCertificateCode": "example", "tags": [ "ULTIMA" ] } -
Type: object
buyer
Type: OrderBuyerDTO
Информация о покупателе.
Параметры
id,lastName,firstNameиmiddleNameвозвращаются, только если вы работаете по модели DBS.Example
{ "id": "example", "lastName": "example", "firstName": "example", "middleName": "example", "email": "example", "type": "PERSON", "phone": "example" }delivery
Type: OrderStatusDeliveryDTO
Example
{ "id": "example", "shopDeliveryId": "example", "type": "DELIVERY", "serviceName": "example", "price": 0.5, "subsidy": 0.5, "deliveryOptionId": "example", "deliveryPartnerType": "SHOP", "dates": { "fromDate": "23-09-2022", "toDate": null, "fromTime": "12:00:00", "toTime": "12:00:00", "realDeliveryDate": null }, "region": { "id": 0, "name": "example", "type": "OTHER", "parent": null }, "vat": "NO_VAT", "deliveryServiceId": 0, "liftType": "NOT_NEEDED", "liftPrice": 0.5, "outlet": { "code": "example" }, "dispatchType": "UNKNOWN", "shipments": [ { "id": 0, "status": "NEW", "shipmentDate": null, "shipmentTime": "12:00:00", "weight": 0, "width": 0, "height": 0, "depth": 0, "boxes": [ {} ] } ], "estimated": true, "eacType": "MERCHANT_TO_COURIER", "courier": { "fullName": "example", "phone": "example", "phoneExtension": "example", "vehicleNumber": "example", "vehicleDescription": "example" }, "address": { "country": "example", "postcode": "example", "city": "example", "district": "example", "subway": "example", "street": "example", "house": "example", "block": "example", "entrance": "example", "entryphone": "example", "floor": "example", "apartment": "example", "lat": 0.5, "lon": 0.5, "phone": "example", "recipient": "example", "notes": "example", "outletPhones": [ null ], "schedule": [ null ] } }Example
{ "buyer": { "id": "example", "lastName": "example", "firstName": "example", "middleName": "example", "email": "example", "type": "PERSON", "phone": "example" }, "delivery": { "id": "example", "shopDeliveryId": "example", "type": "DELIVERY", "serviceName": "example", "price": 0.5, "subsidy": 0.5, "deliveryOptionId": "example", "deliveryPartnerType": "SHOP", "dates": { "fromDate": "23-09-2022", "toDate": null, "fromTime": "12:00:00", "toTime": "12:00:00", "realDeliveryDate": null }, "region": { "id": 0, "name": "example", "type": "OTHER", "parent": null }, "vat": "NO_VAT", "deliveryServiceId": 0, "liftType": "NOT_NEEDED", "liftPrice": 0.5, "outlet": { "code": "example" }, "dispatchType": "UNKNOWN", "shipments": [ { "id": 0, "status": "NEW", "shipmentDate": null, "shipmentTime": "12:00:00", "weight": 0, "width": 0, "height": 0, "depth": 0, "boxes": [ null ] } ], "estimated": true, "eacType": "MERCHANT_TO_COURIER", "courier": { "fullName": "example", "phone": "example", "phoneExtension": "example", "vehicleNumber": "example", "vehicleDescription": "example" }, "address": null } }
Example
{
"businessId": 0,
"id": 0,
"status": "PLACING",
"substatus": "RESERVATION_EXPIRED",
"creationDate": "23-09-2022 09:12:41",
"currency": "RUR",
"itemsTotal": 0.5,
"total": 0.5,
"deliveryTotal": 0.5,
"subsidyTotal": 0.5,
"totalWithSubsidy": 0.5,
"subsidies": [
{
"type": "YANDEX_CASHBACK",
"amount": 0.5
}
],
"buyerItemsTotal": 0.5,
"buyerTotal": 0.5,
"buyerItemsTotalBeforeDiscount": 0.5,
"buyerTotalBeforeDiscount": 0.5,
"paymentType": "PREPAID",
"paymentMethod": "SHOP_PREPAID",
"fake": true,
"shopOrderId": "example",
"items": [
{
"id": 0,
"feedId": 0,
"offerId": "example",
"feedCategoryId": "example",
"offerName": "example",
"fulfilmentShopId": 0,
"price": 0.5,
"buyerPrice": 0.5,
"buyerPriceBeforeDiscount": 0.5,
"priceBeforeDiscount": 0.5,
"count": 0,
"delivery": true,
"vat": "NO_VAT",
"shopSku": null,
"sku": "example",
"subsidy": 0.5,
"subsidies": [
{}
],
"warehouseId": 0,
"partnerWarehouseId": "example",
"params": "example",
"promos": [
{}
],
"instances": [
{}
],
"tags": [
"ULTIMA"
]
}
],
"notes": "example",
"taxSystem": "OSN",
"expiryDate": "23-09-2022",
"electronicAcceptanceCertificateCode": "example",
"tags": [
"ULTIMA"
],
"buyer": {
"id": "example",
"lastName": "example",
"firstName": "example",
"middleName": "example",
"email": "example",
"type": "PERSON",
"phone": "example"
},
"delivery": {
"id": "example",
"shopDeliveryId": "example",
"type": "DELIVERY",
"serviceName": "example",
"price": 0.5,
"subsidy": 0.5,
"deliveryOptionId": "example",
"deliveryPartnerType": "SHOP",
"dates": {
"fromDate": null,
"toDate": null,
"fromTime": "12:00:00",
"toTime": "12:00:00",
"realDeliveryDate": null
},
"region": {
"id": 0,
"name": "example",
"type": "OTHER",
"parent": null
},
"vat": null,
"deliveryServiceId": 0,
"liftType": "NOT_NEEDED",
"liftPrice": 0.5,
"outlet": {
"code": "example"
},
"dispatchType": "UNKNOWN",
"shipments": [
{}
],
"estimated": true,
"eacType": "MERCHANT_TO_COURIER",
"courier": {
"fullName": "example",
"phone": "example",
"phoneExtension": "example",
"vehicleNumber": "example",
"vehicleDescription": "example"
},
"address": null
}
}
Responses
200 OK
Пустой ответ.
Если запрос от Маркета вернется повторно, на него необходимо ответить со статусом 200, поскольку Маркет не ожидает ответ от магазина.
400 Bad Request
Если магазин считает запрос, поступающий от Маркета, некорректным, магазин должен вернуть статус ответа 400 с описанием причины ошибки в теле ответа. Такие ответы будут анализироваться на предмет нарушений и недоработок API со стороны Маркета.
500 Internal Server Error
В случае технической ошибки на стороне магазина он должен вернуть статус ответа 500. Магазины с большим количеством таких ответов могут быть отключены от Маркета.
No longer supported, please use an alternative and newer version.