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

Name

Description

order*

Type: OrderStatusShopOrderDTO

Заказ.

Name

Description

businessId

Type: integer<int64>

Идентификатор бизнеса-аккаунта.

buyer

Type: OrderBuyerDTO

Информация о покупателе.

Параметры id, lastName, firstName и middleName возвращаются, только если вы работаете по модели DBS.
Информация о покупателе с базовыми полями.

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>

Дата и время оформления заказа.

Формат даты и времени: ДД-ММ-ГГГГ ЧЧ:ММ:СС. Часовой пояс — UTC+03:00 (Москва).

Example: 23-09-2022 09:12:41

currency

Type: CurrencyType

Валюта, в которой указаны цены на товары в заказе.

Принимает значение RUR — российский рубль.

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

delivery

Type: OrderStatusDeliveryDTO

Информация о доставке.

deliveryTotal

Type: number<decimal>

Стоимость доставки в валюте заказа.

electronicAcceptanceCertificateCode

Type: string

Только для модели FBS

Шестизначный код подтверждения для:

• передачи экспресс-заказа курьеру;
• получения невыкупленного экспресс-заказа от курьера.

Подробно о работе с кодами рассказано в Справке для продавцов.

expiryDate

Type: string<date-dd-MM-yyyy>

Дата, после которой заказ будет отменен, если не сменит статус.

Формат даты: ДД-ММ-ГГГГ.

Example: 23-09-2022

fake

Type: boolean

Тип заказа:

• false — настоящий заказ покупателя.

• true — тестовый заказ Маркета.

id

Type: integer<int64>

Идентификатор заказа.

items

Type: ShopOrderItemDTO[]

Список товаров в заказе.
Список товаров в заказе.

itemsTotal

Type: number<decimal>

Общая сумма заказа в валюте заказа без учета стоимости доставки и вознаграждения партнеру за скидки по промокодам, купонам и акциям (параметр subsidyTotal).

notes

Type: string

Комментарий к заказу.

paymentMethod

Type: 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.

Enum: SHOP_PREPAID, BANK_CARD, YANDEX_MONEY, CASH_ON_DELIVERY, CARD_ON_DELIVERY, YANDEX, APPLE_PAY, EXTERNAL_CERTIFICATE, CREDIT, INSTALLMENT, GOOGLE_PAY, TINKOFF_CREDIT, SBP, TINKOFF_INSTALLMENTS, B2B_ACCOUNT_PREPAYMENT, B2B_ACCOUNT_POSTPAYMENT, UNKNOWN

paymentType

Type: OrderPaymentType

Тип оплаты заказа:

• PREPAID — оплата при оформлении заказа.

• POSTPAID — оплата при получении заказа.

• UNKNOWN — неизвестный тип.

Если параметр отсутствует, заказ будет оплачен при получении.

Enum: PREPAID, POSTPAID, UNKNOWN

shopOrderId

Type: string

Идентификатор заказа в магазине.

status

Type: OrderStatusType

Статус заказа:

• CANCELLED — отменен.

• DELIVERED — получен покупателем.

• DELIVERY — передан в службу доставки.

• PICKUP — доставлен в пункт самовывоза.

• PROCESSING — находится в обработке.

• PENDING — ожидает обработки со стороны продавца.

• UNPAID — оформлен, но еще не оплачен (если выбрана оплата при оформлении).

• PLACING — оформляется, подготовка к резервированию.

• RESERVED — зарезервирован, но недооформлен.

• PARTIALLY_RETURNED — возвращен частично.

• RETURNED — возвращен полностью.

• UNKNOWN — неизвестный статус.

Также могут возвращаться другие значения. Обрабатывать их не требуется.

Enum: PLACING, RESERVED, UNPAID, PROCESSING, DELIVERY, PICKUP, DELIVERED, CANCELLED, PENDING, PARTIALLY_RETURNED, RETURNED, UNKNOWN

subsidies

Type: OrderSubsidyDTO[]

Список субсидий по типам.
Общее вознаграждение партнеру за DBS-доставку и все скидки на товар:

• по промокодам, купонам и акциям;
• по баллам Плюса;
• по доставке (DBS).

Передается в валюте заказа.

subsidyTotal

Type: number<decimal>

Общее вознаграждение партнеру за скидки:

• по промокодам;
• по купонам;
• по баллам Плюса;
• по акциям.

Передается в валюте, указанной в параметре currency.

substatus

Type: 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 — техническая ошибка на стороне Маркета. Обратитесь в поддержку.

Также могут возвращаться другие значения. Обрабатывать их не требуется.

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_SERIVCE_UNDELIVERED, DELIVERY_SERVICE_UNDELIVERED, PREORDER, AWAIT_CONFIRMATION, STARTED, PACKAGING, READY_TO_SHIP, SHIPPED, ASYNC_PROCESSING, USER_REFUSED_TO_PROVIDE_PERSONAL_DATA, 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, RECEIVED_ON_DISTRIBUTION_CENTER, 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, UNKNOWN

taxSystem

Type: OrderTaxSystemType

Система налогообложения (СНО) магазина на момент оформления заказа:

• ECHN — единый сельскохозяйственный налог (ЕСХН).

• ENVD — единый налог на вмененный доход (ЕНВД).

• OSN — общая система налогообложения (ОСН).

• PSN — патентная система налогообложения (ПСН).

• USN — упрощенная система налогообложения (УСН).

• USN_MINUS_COST — упрощенная система налогообложения, доходы, уменьшенные на величину расходов (УСН «Доходы минус расходы»).

• NPD — налог на профессиональный доход (НПД).

• UNKNOWN_VALUE — неизвестное значение. Используется только совместно с параметром payment-method=YANDEX.

Enum: OSN, USN, USN_MINUS_COST, ENVD, ECHN, PSN, NPD, UNKNOWN_VALUE

total

Type: number<decimal>

Общая сумма заказа в валюте заказа с учетом стоимости доставки, но без учета вознаграждения партнеру за скидки по промокодам, купонам, кешбэку и акциям (параметр subsidyTotal).

totalWithSubsidy

Type: number<decimal>

Сумма стоимости всех товаров в заказе и вознаграждения за них в валюте магазина (сумма параметров total и subsidyTotal).

Name

Description

firstName

Type: string

Имя покупателя.

id

Type: string

Идентификатор покупателя.

lastName

Type: string

Фамилия покупателя.

middleName

Type: string

Отчество покупателя.

type

Type: OrderBuyerType

Тип покупателя: физическое лицо или организация. Этот параметр используется FBS- и FBY-магазинами, размещающими товары на витрине business.market.yandex.ru.

Enum: PERSON, BUSINESS

Type

Description

CurrencyType

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

Name

Description

address

Type: ShopOrderDeliveryAddressDTO

Только для модели DBS

Адрес доставки. Передается, если параметр type имеет значение DELIVERY.
Адрес доставки. Передается, если параметр type имеет значение DELIVERY.

courier

Type: OrderCourierDTO

Только для модели Экспресс

Информация о курьере.

dates

Type: OrderDeliveryDatesDTO

Только для модели DBS

Диапазон дат доставки.

deliveryOptionId

Type: string

Идентификатор опции доставки, переданный магазином.

deliveryPartnerType

Type: OrderDeliveryPartnerType

Тип сотрудничества со службой доставки в рамках конкретного заказа.

Enum: SHOP, YANDEX_MARKET, UNKNOWN

deliveryServiceId

Type: integer<int64>

Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса GET delivery/services.

dispatchType

Type: OrderDeliveryDispatchType

Только для модели DBS

Способ отгрузки.

Enum: UNKNOWN, BUYER, MARKET_PARTNER_OUTLET, MARKET_BRANDED_OUTLET, SHOP_OUTLET, DROPOFF

eacType

Type: OrderDeliveryEacType

Только для модели Экспресс

Тип кода подтверждения ЭАПП.

Enum: MERCHANT_TO_COURIER, COURIER_TO_MERCHANT, CHECKING_BY_MERCHANT

estimated

Type: boolean

Только для модели DBS

Признак, который показывает, что дата доставки по заказу не подтверждена. Передается для товаров на заказ с долгим сроком доставки (31–60 дней). Окончательную дату доставки нужно передать Маркету в течение 7 дней с даты оформления заказа в запросе PUT campaigns/{campaignId}/orders/{orderId}/delivery/date.

liftPrice

Type: number<decimal>

Только для модели DBS

Стоимость подъема на этаж.

liftType

Type: OrderLiftType

Только для модели DBS

Тип подъема заказа на этаж.

Enum: NOT_NEEDED, MANUAL, ELEVATOR, CARGO_ELEVATOR, FREE, UNKNOWN

outlet

Type: ShopOutletDTO

Только для модели DBS

Пункт самовывоза, выбранный покупателем для получения заказа. Не возвращается в ответе, если покупатель выбрал получение заказа в брендированном пункте выдачи заказов Маркета (значение MARKET_BRANDED_OUTLET параметра dispatchType).

price

Type: number<decimal>

До 1 июля 2021 в нем возвращалась ваша стоимость доставки заказа. Сейчас Маркет всегда передает в этом поле 0, так как поле устарело и не используется, а стоимость доставки заказа рассчитывает автоматически, по единому тарифу на доставку.

Подробнее о тарифе на доставку

region

Type: ShopRegionDTO

Регион доставки.

serviceName

Type: string

Наименование службы доставки.

shipments

Type: ShopOrderShipmentDTO[]

Информация о посылках.

Для модели DBS: передается, если заказ был создан в пункт выдачи Маркета.
Список посылок.

shopDeliveryId

Type: string

Только для модели DBS

Идентификатор доставки, присвоенный магазином.

Указывается, только если магазин передал данный идентификатор в ответе на запрос методом POST cart в параметре id, вложенном в deliveryOptions.

subsidy

Type: number<decimal>

Субсидия за доставку в валюте заказа.

type

Type: OrderDeliveryType

Способ доставки заказа.

Enum: DELIVERY, PICKUP, POST, DIGITAL, UNKNOWN

vat

Type: OrderVatType

Только для модели DBS

Ставка налога на добавленную стоимость (НДС) на услугу доставки заказа.

Enum: NO_VAT, VAT_0, VAT_10, VAT_10_110, VAT_20, VAT_20_120, VAT_18, VAT_18_118, UNKNOWN_VALUE

Name

Description

buyerPrice

Type: number<decimal>

Цена на товар в валюте покупателя. В цене уже учтены скидки по:

• акциям;
• купонам;
• промокодам.

buyerPriceBeforeDiscount

Type: number<decimal>

Стоимость товара в валюте покупателя до применения скидок.

count

Type: integer

Количество единиц товара.

delivery

Type: boolean

Только для модели FBS

Доставка товара в указанный в запросе регион:

• false — товар не доставляется в указанный регион.
• true — значение по умолчанию, товар доставляется в указанный регион.

Принимает значение, которое вы передали в параметре delivery, вложенном в items, в ответе на запрос POST cart.

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.

Если магазин еще не передавал коды для этого заказа, instances отсутствует.
Переданные вами для данной позиции коды маркировки или УИНы. Коды «Честного знака» возвращаются в двух вариантах — с криптохвостом и без.

offerId

Type: string

Идентификатор вашего товарного предложения для определенного товара. Описание поля в Справке Маркета для продавцов

Min length: 1

Max length: 255

Pattern: ^[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

offerName

Type: string

Только для модели DBS

Название товара.

params

Type: string

Характеристики товара (например, его цвет).

partnerWarehouseId

Type: string

Только для модели FBS

Идентификатор склада в системе партнера, на который сформирован заказ.

price

Type: number<decimal>

Цена на товар в валюте заказа без учета вознаграждения партнеру за скидки по промокодам, купонам и акциям (параметр subsidy).

priceBeforeDiscount

Type: number<decimal>

Стоимость товара в валюте магазина до применения скидок.

promos

Type: OrderItemPromoDTO[]

Информация о вознаграждениях партнеру за скидки на товар по промокодам, купонам и акциям.
Информация о вознаграждениях партнеру за скидки на товар по промокодам, купонам и акциям.

shopSku

Type: string

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

• У каждого товара SKU должен быть свой.

• SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

• Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

Min length: 1

Max length: 255

Pattern: ^[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

sku

Type: string

SKU на Маркете — идентификатор текущей карточки товара на Маркете.

subsidies

Type: OrderItemSubsidyDTO[]

Список субсидий по типам.
Общее вознаграждение партнеру за все скидки на товар:

• по промокодам, купонам и акциям;
• по баллам Плюса.

Передается в валюте заказа.

subsidy

Type: number<decimal>

Общее вознаграждение партнеру за все скидки на товар:

• по промокодам;
• по купонам;
• по баллам Плюса;
• по акциям.

Передается в валюте заказа.

vat

Type: OrderVatType

Ставка налога на добавленную стоимость (НДС) на товар.

Используется только совместно с параметром "paymentMethod": "YANDEX".

Enum: NO_VAT, VAT_0, VAT_10, VAT_10_110, VAT_20, VAT_20_120, VAT_18, VAT_18_118, UNKNOWN_VALUE

warehouseId

Type: integer<int64>

Только для модели FBS

Идентификатор склада на Маркете.

Type

Description

OrderPaymentMethodType

Enum: SHOP_PREPAID, BANK_CARD, YANDEX_MONEY, CASH_ON_DELIVERY, CARD_ON_DELIVERY, YANDEX, APPLE_PAY, EXTERNAL_CERTIFICATE, CREDIT, INSTALLMENT, GOOGLE_PAY, TINKOFF_CREDIT, SBP, TINKOFF_INSTALLMENTS, B2B_ACCOUNT_PREPAYMENT, B2B_ACCOUNT_POSTPAYMENT, UNKNOWN

Type

Description

OrderPaymentType

Enum: PREPAID, POSTPAID, UNKNOWN

Type

Description

OrderStatusType

Enum: PLACING, RESERVED, UNPAID, PROCESSING, DELIVERY, PICKUP, DELIVERED, CANCELLED, PENDING, PARTIALLY_RETURNED, RETURNED, UNKNOWN

Name

Description

amount

Type: number<decimal>

Сумма субсидии.

type

Type: OrderSubsidyType

Тип субсидии:

• YANDEX_CASHBACK — скидка по подписке Яндекс Плюс.

• SUBSIDY — скидка Маркета (по акциям, промокодам, купонам и т. д.)

• DELIVERY — скидка за доставку (DBS).

Enum: YANDEX_CASHBACK, SUBSIDY, DELIVERY

Type

Description

OrderSubstatusType

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_SERIVCE_UNDELIVERED, DELIVERY_SERVICE_UNDELIVERED, PREORDER, AWAIT_CONFIRMATION, STARTED, PACKAGING, READY_TO_SHIP, SHIPPED, ASYNC_PROCESSING, USER_REFUSED_TO_PROVIDE_PERSONAL_DATA, 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, RECEIVED_ON_DISTRIBUTION_CENTER, 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, UNKNOWN

Type

Description

OrderTaxSystemType

Enum: OSN, USN, USN_MINUS_COST, ENVD, ECHN, PSN, NPD, UNKNOWN_VALUE

Type

Description

OrderBuyerType

Enum: PERSON, BUSINESS

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[]

Телефоны пункта выдачи в формате 8 812 123-45-67 890 (890 — добавочный).

Параметр указывается, если покупатель выбрал доставку заказа в брендированный пункт выдачи Маркета.

phone

Type: string

Телефон получателя заказа.

Обязательный параметр.

postcode

Type: string

Почтовый индекс.

Указывается, если выбрана доставка почтой (delivery type=POST).

recipient

Type: string

Фамилия, имя и отчество получателя заказа.

Обязательный параметр.

schedule

Type: ShopOutletScheduleItemDTO[]

Расписание работы пункта выдачи.

Параметр указывается, если покупатель выбрал доставку заказа в брендированный пункт выдачи Маркета.
Расписание работы точки продаж.

street

Type: string

Улица.

subway

Type: string

Станция метро.

Name

Description

fullName

Type: string

Полное имя курьера.

phone

Type: string

Номер телефона курьера.

phoneExtension

Type: string

Добавочный номер телефона.

vehicleDescription

Type: string

Описание машины. Например, модель и цвет.

vehicleNumber

Type: string

Номер транспортного средства.

Name

Description

fromDate

Type: string<date-dd-MM-yyyy>

Ближайшая дата доставки.

Формат даты: ДД-ММ-ГГГГ.

Example: 23-09-2022

fromTime

Type: string<time>

Начало интервала времени доставки.

Передается только совместно с параметром type=DELIVERY.

Формат времени: 24-часовой, ЧЧ:ММ. В качестве минут всегда должно быть указано 00 (исключение — 23:59).

Минимальное значение: 00:00.

realDeliveryDate

Type: string<date-dd-MM-yyyy>

Дата, когда товар доставлен до пункта выдачи заказа (в случае самовывоза) или до покупателя (если заказ доставляет курьер).

Example: 23-09-2022

toDate

Type: string<date-dd-MM-yyyy>

Самая поздняя дата доставки.

Если параметр toDate не указан, единственно возможной датой доставки считается дата, указанная в параметре fromDate.

Формат даты: ДД-ММ-ГГГГ.

Example: 23-09-2022

toTime

Type: string<time>

Конец интервала времени доставки.

Передается только совместно с параметром type=DELIVERY.

Формат времени: 24-часовой, ЧЧ:ММ. В качестве минут всегда должно быть указано 00 (исключение — 23:59).

Максимальное значение: 23:59.

Type

Description

OrderDeliveryPartnerType

Enum: SHOP, YANDEX_MARKET, UNKNOWN

Type

Description

OrderDeliveryDispatchType

Enum: UNKNOWN, BUYER, MARKET_PARTNER_OUTLET, MARKET_BRANDED_OUTLET, SHOP_OUTLET, DROPOFF

Type

Description

OrderDeliveryEacType

Enum: MERCHANT_TO_COURIER, COURIER_TO_MERCHANT, CHECKING_BY_MERCHANT

Type

Description

OrderLiftType

Enum: NOT_NEEDED, MANUAL, ELEVATOR, CARGO_ELEVATOR, FREE, UNKNOWN

Name

Description

code

Type: string

Идентификатор пункта самовывоза, присвоенный магазином.

Name

Description

name*

Type: string

Название региона.

type*

Type: ShopRegionType

Тип региона.

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

id

Type: integer<int64>

Идентификатор региона.

parent

Type: ShopRegionDTO

Информация о родительском регионе.

Указываются родительские регионы до уровня страны.

Name

Description

boxes

Type: ShopOrderParcelBoxDTO[]

Список грузовых мест.
Информация о грузоместе.

depth

Type: integer<int64>

Глубина упакованного заказа в сантиметрах.

Указывается, если заказ доставляет служба-партнер Маркета (deliveryPartnerType=YANDEX_MARKET).

height

Type: integer<int64>

Высота упакованного заказа в сантиметрах.

Указывается, если заказ доставляет служба-партнер Маркета (deliveryPartnerType=YANDEX_MARKET).

id

Type: integer<int64>

Идентификатор посылки, присвоенный Маркетом.

shipmentDate

Type: string<date-dd-MM-yyyy>

День, в который нужно отгрузить заказ службе доставки.

Формат даты: ДД-ММ-ГГГГ.

Для модели FBS: если заказ сделан организацией, параметр не возвращается до согласования даты доставки.

Для модели DBS: если вы не передали параметр shipmentDate, то датой отгрузки будет считаться дата доставки fromDate.

Example: 23-09-2022

shipmentTime

Type: string<time>

Только для модели Экспресс

Время, к которому магазин должен упаковать заказ и перевести его в статус READY_TO_SHIP. После смены статуса за заказом приедет курьер.

Формат времени: 24-часовой, ЧЧ:ММ.

Если заказ сделан организацией, параметр не возвращается до согласования даты доставки.

status

Type: OrderParcelStatusType

Статус заказа в партнерской службе доставки:

• NEW — новый.

• CREATED — создан в службе доставки.

• READY_TO_SHIP — готов к передаче в службу доставки.

• ERROR — ошибка создания заказа.

• UNKNOWN — неизвестный статус.

Enum: NEW, CREATED, READY_TO_SHIP, ERROR, UNKNOWN

weight

Type: integer<int64>

Вес упакованного заказа в граммах.

Указывается, если заказ доставляет служба-партнер Маркета (deliveryPartnerType=YANDEX_MARKET).

width

Type: integer<int64>

Ширина упакованного заказа в сантиметрах.

Указывается, если заказ доставляет служба-партнер Маркета (deliveryPartnerType=YANDEX_MARKET).

Type

Description

OrderDeliveryType

Enum: DELIVERY, PICKUP, POST, DIGITAL, UNKNOWN

Type

Description

OrderVatType

Enum: NO_VAT, VAT_0, VAT_10, VAT_10_110, VAT_20, VAT_20_120, VAT_18, VAT_18_118, UNKNOWN_VALUE

Name

Description

cis

Type: string

Код идентификации единицы товара в системе «Честный ЗНАК» без криптохвоста.

cisFull

Type: string

Код идентификации единицы товара в системе «Честный ЗНАК» с криптохвостом.

gtd

Type: string

Грузовая таможенная декларация.

Представляет собой строку из трех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ.

Первая часть — код таможни, которая зарегистрировала декларацию на ввезенные товары. Далее — дата и номер декларации.

rnpt

Type: string

Регистрационный номер партии товара.

Представляет собой строку из четырех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ/ХХХ.

Первая часть — код таможни, которая зарегистрировала декларацию на партию товара. Далее — дата, номер декларации и номер маркированного товара в декларации.

uin

Type: string

УИН ювелирного изделия (16-значный код) Производитель получает УИН, когда регистрирует изделие в системе контроля за оборотом драгоценных металлов и камней — ГИИС ДМДК.

Name

Description

type*

Type: OrderPromoType

Тип скидки.

Enum: DIRECT_DISCOUNT, BLUE_SET, BLUE_FLASH, GENERIC_BUNDLE, MARKET_COUPON, MARKET_PROMOCODE, MARKET_DEAL, MARKET_BLUE, MARKET_PRIME, YANDEX_PLUS, BERU_PLUS, MARKET_COIN, YANDEX_EMPLOYEE, LIMITED_FREE_DELIVERY_PROMO, FREE_DELIVERY_THRESHOLD, MULTICART_DISCOUNT, PRICE_DROP_AS_YOU_SHOP, FREE_DELIVERY_FOR_LDI, FREE_DELIVERY_FOR_LSC, SECRET_SALE, 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

marketPromoId

Type: string

Идентификатор акции в рамках соглашения на оказание услуг по продвижению сервиса между Маркетом и партнером.

Параметр передается, только если параметр type=MARKET_DEAL.

subsidy

Type: number<decimal>

Вознаграждение партнеру от Маркета за товар, проданный в рамках акции.

Передается в валюте заказа.

Name

Description

amount

Type: number<decimal>

Сумма субсидии.

type

Type: OrderItemSubsidyType

Тип субсидии:

• YANDEX_CASHBACK — скидка по подписке Яндекс Плюс.

• SUBSIDY — скидка Маркета (по акциям, промокодам, купонам и т. д.).

Enum: YANDEX_CASHBACK, SUBSIDY

Type

Description

OrderSubsidyType

Enum: YANDEX_CASHBACK, SUBSIDY, DELIVERY

Name

Description

fromDay*

Type: DayOfWeekType

День недели, в который пункт выдачи начинает работать:

• MONDAY — понедельник.
• TUESDAY — вторник.
• WEDNESDAY — среда.
• THURSDAY — четверг.
• FRIDAY — пятница.
• SATURDAY — суббота.
• SUNDAY — воскресенье.

Обязательный параметр.

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

fromTime*

Type: string

Время начала работы пункта выдачи. Формат времени: 24-часовой, ЧЧ:ММ.

Обязательный параметр.

Min length: 1

toDay*

Type: DayOfWeekType

День недели, в который пункт выдачи заканчивает работать:

• MONDAY — понедельник.
• TUESDAY — вторник.
• WEDNESDAY — среда.
• THURSDAY — четверг.
• FRIDAY — пятница.
• SATURDAY — суббота.
• SUNDAY — воскресенье.

Обязательный параметр.

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

toTime*

Type: string

Время окончания работы пункта выдачи. Формат времени: 24-часовой, ЧЧ:ММ.

Обязательный параметр.

Min length: 1

Type

Description

ShopRegionType

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

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>

Ширина грузового места в сантиметрах.

Type

Description

OrderParcelStatusType

Enum: NEW, CREATED, READY_TO_SHIP, ERROR, UNKNOWN

Type

Description

OrderPromoType

Enum: DIRECT_DISCOUNT, BLUE_SET, BLUE_FLASH, GENERIC_BUNDLE, MARKET_COUPON, MARKET_PROMOCODE, MARKET_DEAL, MARKET_BLUE, MARKET_PRIME, YANDEX_PLUS, BERU_PLUS, MARKET_COIN, YANDEX_EMPLOYEE, LIMITED_FREE_DELIVERY_PROMO, FREE_DELIVERY_THRESHOLD, MULTICART_DISCOUNT, PRICE_DROP_AS_YOU_SHOP, FREE_DELIVERY_FOR_LDI, FREE_DELIVERY_FOR_LSC, SECRET_SALE, 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

Type

Description

OrderItemSubsidyType

Enum: YANDEX_CASHBACK, SUBSIDY

Type

Description

DayOfWeekType

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

Name

Description

count

Type: integer

Количество товара в коробке.

id

Type: integer<int64>

Идентификатор коробки.