Информация о заказах в магазине

orders

Type: OrderDTO[]

Модель заказа.

Max items: 50

[
  {
    "id": 0,
    "externalOrderId": "example",
    "status": "PLACING",
    "substatus": "RESERVATION_EXPIRED",
    "creationDate": "23-09-2022 09:12:41",
    "updatedAt": null,
    "currency": "RUR",
    "itemsTotal": 0.5,
    "deliveryTotal": 0.5,
    "buyerItemsTotal": 0.5,
    "buyerTotal": 0.5,
    "buyerItemsTotalBeforeDiscount": 0.5,
    "buyerTotalBeforeDiscount": 0.5,
    "paymentType": "PREPAID",
    "paymentMethod": "CASH_ON_DELIVERY",
    "fake": true,
    "items": [
      {
        "id": 0,
        "offerId": "example",
        "offerName": "example",
        "price": 0.5,
        "buyerPrice": 0.5,
        "buyerPriceBeforeDiscount": 0.5,
        "priceBeforeDiscount": 0.5,
        "count": 0,
        "vat": "NO_VAT",
        "shopSku": null,
        "subsidy": 0.5,
        "partnerWarehouseId": "example",
        "promos": [
          {}
        ],
        "instances": [
          {}
        ],
        "details": [
          {}
        ],
        "subsidies": [
          {}
        ],
        "requiredInstanceTypes": [
          "CIS"
        ],
        "tags": [
          "ULTIMA"
        ]
      }
    ],
    "subsidies": [
      {
        "type": "YANDEX_CASHBACK",
        "amount": 0.5
      }
    ],
    "delivery": {
      "id": "example",
      "type": "DELIVERY",
      "serviceName": "example",
      "price": 0.5,
      "deliveryPartnerType": "SHOP",
      "courier": {
        "fullName": "example",
        "phone": "example",
        "phoneExtension": "example",
        "vehicleNumber": "example",
        "vehicleDescription": "example"
      },
      "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
      },
      "address": {
        "country": "example",
        "postcode": "example",
        "city": "example",
        "district": "example",
        "subway": "example",
        "street": "example",
        "house": "example",
        "estate": "example",
        "block": "example",
        "building": "example",
        "entrance": "example",
        "entryphone": "example",
        "floor": "example",
        "apartment": "example",
        "phone": "example",
        "recipient": "example",
        "gps": {
          "latitude": 0.5,
          "longitude": 0.5
        }
      },
      "vat": null,
      "deliveryServiceId": 0,
      "logisticPointId": 1,
      "liftType": "NOT_NEEDED",
      "liftPrice": 0.5,
      "outletCode": "example",
      "outletStorageLimitDate": null,
      "dispatchType": "UNKNOWN",
      "tracks": [
        {
          "trackCode": "example",
          "deliveryServiceId": 0
        }
      ],
      "shipments": [
        {
          "id": 0,
          "shipmentDate": null,
          "shipmentTime": "example",
          "tracks": [
            null
          ],
          "boxes": [
            null
          ]
        }
      ],
      "estimated": true,
      "eacType": "MERCHANT_TO_COURIER",
      "eacCode": "example",
      "receiveCode": "example"
    },
    "buyer": {
      "id": "example",
      "lastName": "example",
      "firstName": "example",
      "middleName": "example",
      "email": "example",
      "type": "PERSON"
    },
    "notes": "example",
    "taxSystem": "OSN",
    "cancelRequested": true,
    "expiryDate": null,
    "sourcePlatform": "MARKET"
  }
]

pager

Type: FlippingPagerDTO

Модель для пагинации.

{
  "total": 0,
  "from": 0,
  "to": 0,
  "currentPage": 0,
  "pagesCount": 0,
  "pageSize": 0
}

paging

Type: ForwardScrollingPagerDTO

Информация о страницах с результатами.

Идентификатор следующей страницы.

{
  "nextPageToken": "example"
}

currentPage

Type: integer

Текущая страница.

from

Type: integer

Начальный номер найденного элемента на странице.

pagesCount

Type: integer

Общее количество страниц.

pageSize

Type: integer

Размер страницы.

to

Type: integer

Конечный номер найденного элемента на странице.

total

Type: integer

Сколько всего найдено элементов.

subsidy

Type: number

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

type

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

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

discount

Type: number

Размер пользовательской скидки в валюте покупателя.

marketPromoId

Type: string

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

Example: example

shopPromoId

Type: string

Идентификатор акции поставщика.

Example: example

cis

Type: string

Код идентификации единицы товара в системе «Честный ЗНАК» без криптохвоста или «ASL BELGISI» (для продавцов Market Yandex Go).

Example: example

cisFull

Type: string

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

Example: example

countryCode

Type: CountryCode

Страна производства в формате ISO 3166-1 alpha-2. Как получить

Min length: 2

Max length: 2

Pattern: ^[A-Z]{2}$

Example: RU

gtd

Type: string

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

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

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

Example: example

rnpt

Type: string

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

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

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

Example: example

uin

Type: string

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

Example: example

itemCount

Type: integer

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

itemStatus

Type: OrderItemStatusType

Невыкупленный или возвращенный товар:

• REJECTED — невыкупленный.

• RETURNED — возвращенный.

Enum: REJECTED, RETURNED

updateDate

Type: DateDdMmYyyy

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

Example: 23-09-2022

amount

Type: number

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

type

Type: OrderItemSubsidyType

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

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

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

Enum: YANDEX_CASHBACK, SUBSIDY

buyerPrice

Type: number

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

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

buyerPriceBeforeDiscount

Type: number

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

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

count

Type: integer

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

id

Type: integer

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

Позволяет идентифицировать товар в рамках заказа.

offerId

Type: ShopSku

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

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

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

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

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

SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.

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

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

Example: example

offerName

Type: string

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

Example: example

price

Type: number

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

Включает НДС.

details

Type: OrderItemDetailDTO[] | null

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

Min items: 1

[
  {
    "itemCount": 0,
    "itemStatus": "REJECTED",
    "updateDate": "23-09-2022"
  }
]

instances

Type: OrderItemInstanceDTO[] | null

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

Возвращаются данные для маркировки, переданные в запросе PUT v2/campaigns/{campaignId}/orders/{orderId}/identifiers.

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

Min items: 1

[
  {
    "cis": "example",
    "cisFull": "example",
    "uin": "example",
    "rnpt": "example",
    "gtd": "example",
    "countryCode": "RU"
  }
]

partnerWarehouseId

Type: string

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

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

Example: example

priceBeforeDiscount

Type: number

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

promos

Type: OrderItemPromoDTO[] | null

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

Min items: 1

[
  {
    "type": "DIRECT_DISCOUNT",
    "discount": 0.5,
    "subsidy": 0.5,
    "shopPromoId": "example",
    "marketPromoId": "example"
  }
]

requiredInstanceTypes

Type: OrderItemInstanceType[] | null

Список необходимых маркировок товара.

Min items: 1

Unique items: true

[
  "CIS"
]

shopSku

Type: ShopSku

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

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

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

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

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

SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.

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

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

Example: example

subsidies

Type: OrderItemSubsidyDTO[] | null

Список субсидий по типам.

Min items: 1

[
  {
    "type": "YANDEX_CASHBACK",
    "amount": 0.5
  }
]

subsidy

Type: number

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

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

tags

Type: OrderItemTagType[] | null

Признаки товара.

Min items: 1

Unique items: true

[
  "ULTIMA"
]

vat

Type: 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 — неизвестный тип.

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

amount

Type: number

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

type

Type: OrderSubsidyType

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

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

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

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

Enum: YANDEX_CASHBACK, SUBSIDY, DELIVERY

fullName

Type: string

Полное имя.

Example: example

phone

Type: string

Номер телефона.

Example: example

phoneExtension

Type: string

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

Example: example

vehicleDescription

Type: string

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

Example: example

vehicleNumber

Type: string

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

Example: example

fromDate

Type: DateDdMmYyyy

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

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

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

Example: 23-09-2022

fromTime

Type: string<time>

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

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

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

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

Example: 12:00:00

realDeliveryDate

Type: DateDdMmYyyy

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

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

Example: 23-09-2022

toDate

Type: DateDdMmYyyy

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

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

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

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

Example: 23-09-2022

toTime

Type: string<time>

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

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

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

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

Example: 12:00:00

id

Type: integer

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

name

Type: string

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

Example: example

type

Type: RegionType

Тип региона.

Тип региона.

Возможные значения:

• CITY_DISTRICT — район города.

• CITY — крупный город.

• CONTINENT — континент.

• COUNTRY_DISTRICT — область.

• COUNTRY — страна.

• REGION — регион.

• REPUBLIC_AREA — район субъекта федерации.

• REPUBLIC — субъект федерации.

• SUBWAY_STATION — станция метро.

• VILLAGE — город.

• OTHER — неизвестный регион.

Enum: OTHER, CONTINENT, REGION, COUNTRY, COUNTRY_DISTRICT, REPUBLIC, CITY, VILLAGE, CITY_DISTRICT, SUBWAY_STATION, REPUBLIC_AREA

parent

Type: RegionDTO

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

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

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

{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": null
}

latitude

Type: number

Широта.

longitude

Type: number

Долгота.

apartment

Type: string

Номер квартиры или офиса.

Example: example

block

Type: string

Корпус.

Example: example

building

Type: string

Строение.

Example: example

city

Type: string

Город или населенный пункт.

Example: example

country

Type: string

Страна.

Example: example

district

Type: string

Район.

Example: example

entrance

Type: string

Номер подъезда.

Example: example

entryphone

Type: string

Код домофона.

Example: example

estate

Type: string

Номер владения.

Example: example

floor

Type: string

Этаж.

Example: example

gps

Type: GpsDTO

GPS-координаты.

GPS-координаты широты и долготы.

{
  "latitude": 0.5,
  "longitude": 0.5
}

house

Type: string

Номер дома.

Example: example

phone

Type: string

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

Example: example

postcode

Type: string

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

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

Example: example

recipient

Type: string

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

Example: example

street

Type: string

Улица.

Example: example

subway

Type: string

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

Example: example

deliveryServiceId

Type: integer

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

trackCode

Type: string

Трек‑номер посылки.

Example: example

fulfilmentId

Type: string

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

Example: example

id

Type: integer

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

boxes

Type: OrderParcelBoxDTO[] | null

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

Min items: 1

[
  {
    "id": 0,
    "fulfilmentId": "example"
  }
]

id

Type: integer

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

shipmentDate

Type: DateDdMmYyyy

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

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

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

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

Example: 23-09-2022

shipmentTime

Type: string

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

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

Поле может появиться не сразу. Запрашивайте информацию о заказе в течении 5–10 минут, пока оно не вернется.

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

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

Example: example

tracks

Type: OrderTrackDTO[] | null

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

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

Min items: 1

[
  {
    "trackCode": "example",
    "deliveryServiceId": 0
  }
]

dates

Type: OrderDeliveryDatesDTO

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

{
  "fromDate": "23-09-2022",
  "toDate": null,
  "fromTime": "12:00:00",
  "toTime": "12:00:00",
  "realDeliveryDate": null
}

deliveryPartnerType

Type: OrderDeliveryPartnerType

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

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

• SHOP — магазин работает со службой доставки напрямую или доставляет заказы самостоятельно.

• YANDEX_MARKET — магазин работает со службой доставки через Маркет.

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

Enum: SHOP, YANDEX_MARKET, UNKNOWN

deliveryServiceId

Type: integer

Идентификатор службы доставки.

serviceName

Type: string

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

Example: example

type

Type: OrderDeliveryType

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

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

• DELIVERY — курьерская доставка.

• PICKUP — самовывоз.

• POST — почта.

• DIGITAL — для цифровых товаров.

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

Enum: DELIVERY, PICKUP, POST, DIGITAL, UNKNOWN

address

Type: OrderDeliveryAddressDTO

Адрес доставки.

Указывается, если параметр type принимает значение DELIVERY, POST или PICKUP (только для модели DBS). Если type=PICKUP, возвращается адрес пункта выдачи.

{
  "country": "example",
  "postcode": "example",
  "city": "example",
  "district": "example",
  "subway": "example",
  "street": "example",
  "house": "example",
  "estate": "example",
  "block": "example",
  "building": "example",
  "entrance": "example",
  "entryphone": "example",
  "floor": "example",
  "apartment": "example",
  "phone": "example",
  "recipient": "example",
  "gps": {
    "latitude": 0.5,
    "longitude": 0.5
  }
}

courier

Type: OrderCourierDTO

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

{
  "fullName": "example",
  "phone": "example",
  "phoneExtension": "example",
  "vehicleNumber": "example",
  "vehicleDescription": "example"
}

dispatchType

Type: OrderDeliveryDispatchType

Способ доставки:

• BUYER — курьерская доставка покупателю.

• MARKET_BRANDED_OUTLET — доставка в пункт выдачи заказов Маркета.

• SHOP_OUTLET — доставка в пункт выдачи заказов магазина.

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

Enum: UNKNOWN, BUYER, MARKET_BRANDED_OUTLET, SHOP_OUTLET

eacCode

Type: string

Код подтверждения ЭАПП (для типа MERCHANT_TO_COURIER).

Example: example

eacType

Type: OrderDeliveryEacType

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

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

• MERCHANT_TO_COURIER (временно не возвращается) — продавец передает код курьеру для получения невыкупа.

• COURIER_TO_MERCHANT — курьер передает код продавцу для получения заказа.

• CHECKING_BY_MERCHANT — продавец проверяет код на своей стороне.

Enum: MERCHANT_TO_COURIER, COURIER_TO_MERCHANT, CHECKING_BY_MERCHANT

estimated

Type: boolean

Приблизительная ли дата доставки.

id

Type: string

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

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

Example: example

liftPrice

Type: number

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

liftType

Type: OrderLiftType

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

• NOT_NEEDED — не требуется.

• MANUAL — ручной.

• ELEVATOR — лифт.

• CARGO_ELEVATOR — грузовой лифт.

• FREE — любой из перечисленных выше, если включена опция бесплатного подъема.

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

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

logisticPointId

Type: LogisticPointId

Идентификатор пункта выдачи.

Его можно узнать с помощью метода POST v1/businesses/{businessId}/logistics-points.

Min value: 1

Example: 1

outletCode

Type: string

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

Example: example

outletStorageLimitDate

Type: DateDdMmYyyy

Дата, до которой заказ будет храниться в пункте выдачи. Возвращается, когда заказ переходит в статус PICKUP.

Один раз дату можно поменять с помощью метода PUT v2/campaigns/{campaignId}/orders/{orderId}/delivery/storage-limit.

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

Example: 23-09-2022

price

Type: number

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

receiveCode

Type: string

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

Код получения заказа на ПВЗ.

Example: example

region

Type: RegionDTO

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

{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": null
}

shipments

Type: OrderShipmentDTO[] | null

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

Min items: 1

[
  {
    "id": 0,
    "shipmentDate": "23-09-2022",
    "shipmentTime": "example",
    "tracks": [
      {
        "trackCode": "example",
        "deliveryServiceId": 0
      }
    ],
    "boxes": [
      {
        "id": 0,
        "fulfilmentId": "example"
      }
    ]
  }
]

tracks

Type: OrderTrackDTO[] | null

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

Min items: 1

[
  {
    "trackCode": "example",
    "deliveryServiceId": 0
  }
]

vat

Type: 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 — неизвестный тип.

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

type

Type: OrderBuyerType

Тип покупателя: физическое лицо или организация.

Только для FBS- и FBY-магазинов, которые размещают товары на витрине business.market.yandex.ru.

Тип покупателя:

• PERSON — физическое лицо.

• BUSINESS — организация.

Enum: PERSON, BUSINESS

email

Type: string

Адрес электронной почты.

Допускается любой адрес электронной почты, соответствующий стандарту RFC 2822.

Example: example

firstName

Type: string

Имя.

Example: example

id

Type: string

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

Example: example

lastName

Type: string

Фамилия.

Example: example

middleName

Type: string

Отчество.

Example: example

buyer

Type: OrderBuyerDTO

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

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

{
  "id": "example",
  "lastName": "example",
  "firstName": "example",
  "middleName": "example",
  "email": "example",
  "type": "PERSON"
}

buyerItemsTotalBeforeDiscount

Type: number

Стоимость всех товаров в заказе в валюте покупателя без учета стоимости доставки и до применения скидок по:

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

creationDate

Type: DateDdMmYyyyHhMmSs

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

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

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

currency

Type: CurrencyType

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

Коды валют:

• RUR — российский рубль.
• UAH — украинская гривна.
• BYR — белорусский рубль.
• KZT — казахстанский тенге.
• UZS — узбекский сум.

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: OrderDeliveryDTO

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

{
  "id": "example",
  "type": "DELIVERY",
  "serviceName": "example",
  "price": 0.5,
  "deliveryPartnerType": "SHOP",
  "courier": {
    "fullName": "example",
    "phone": "example",
    "phoneExtension": "example",
    "vehicleNumber": "example",
    "vehicleDescription": "example"
  },
  "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
  },
  "address": {
    "country": "example",
    "postcode": "example",
    "city": "example",
    "district": "example",
    "subway": "example",
    "street": "example",
    "house": "example",
    "estate": "example",
    "block": "example",
    "building": "example",
    "entrance": "example",
    "entryphone": "example",
    "floor": "example",
    "apartment": "example",
    "phone": "example",
    "recipient": "example",
    "gps": {
      "latitude": 0.5,
      "longitude": 0.5
    }
  },
  "vat": "NO_VAT",
  "deliveryServiceId": 0,
  "logisticPointId": 1,
  "liftType": "NOT_NEEDED",
  "liftPrice": 0.5,
  "outletCode": "example",
  "outletStorageLimitDate": null,
  "dispatchType": "UNKNOWN",
  "tracks": [
    {
      "trackCode": "example",
      "deliveryServiceId": 0
    }
  ],
  "shipments": [
    {
      "id": 0,
      "shipmentDate": null,
      "shipmentTime": "example",
      "tracks": [
        null
      ],
      "boxes": [
        {
          "id": 0,
          "fulfilmentId": "example"
        }
      ]
    }
  ],
  "estimated": true,
  "eacType": "MERCHANT_TO_COURIER",
  "eacCode": "example",
  "receiveCode": "example"
}

deliveryTotal

Type: number

Стоимость доставки.

fake

Type: boolean

Тип заказа:

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

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

id

Type: integer

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

items

Type: OrderItemDTO[]

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

[
  {
    "id": 0,
    "offerId": "example",
    "offerName": "example",
    "price": 0.5,
    "buyerPrice": 0.5,
    "buyerPriceBeforeDiscount": 0.5,
    "priceBeforeDiscount": 0.5,
    "count": 0,
    "vat": "NO_VAT",
    "shopSku": null,
    "subsidy": 0.5,
    "partnerWarehouseId": "example",
    "promos": [
      {
        "type": "DIRECT_DISCOUNT",
        "discount": 0.5,
        "subsidy": 0.5,
        "shopPromoId": "example",
        "marketPromoId": "example"
      }
    ],
    "instances": [
      {
        "cis": "example",
        "cisFull": "example",
        "uin": "example",
        "rnpt": "example",
        "gtd": "example",
        "countryCode": "RU"
      }
    ],
    "details": [
      {
        "itemCount": 0,
        "itemStatus": "REJECTED",
        "updateDate": "23-09-2022"
      }
    ],
    "subsidies": [
      {
        "type": "YANDEX_CASHBACK",
        "amount": 0.5
      }
    ],
    "requiredInstanceTypes": [
      "CIS"
    ],
    "tags": [
      "ULTIMA"
    ]
  }
]

itemsTotal

Type: number

Платеж покупателя.

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 — банковской картой.

  • BOUND_CARD_ON_DELIVERY — привязанной картой при получении.

  • BNPL_BANK_ON_DELIVERY — супер Сплитом.

  • BNPL_ON_DELIVERY — Сплитом.

  • CASH_ON_DELIVERY — наличными.

  • B2B_ACCOUNT_POSTPAYMENT — заказ оплачивает организация после доставки.

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

Значение по умолчанию: CASH_ON_DELIVERY.

Enum: CASH_ON_DELIVERY, CARD_ON_DELIVERY, BOUND_CARD_ON_DELIVERY, BNPL_BANK_ON_DELIVERY, BNPL_ON_DELIVERY, YANDEX, APPLE_PAY, EXTERNAL_CERTIFICATE, CREDIT, GOOGLE_PAY, TINKOFF_CREDIT, SBP, TINKOFF_INSTALLMENTS, B2B_ACCOUNT_PREPAYMENT, B2B_ACCOUNT_POSTPAYMENT, UNKNOWN

paymentType

Type: OrderPaymentType

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

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

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

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

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

Enum: PREPAID, POSTPAID, UNKNOWN

status

Type: OrderStatusType

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

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

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

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

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

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

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

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

• CANCELLED — отменен.

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

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

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

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

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

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

substatus

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

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

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

taxSystem

Type: OrderTaxSystemType

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

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

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

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

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

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

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

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

• UNKNOWN_VALUE — неизвестное значение.

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

buyerItemsTotal

Type: number

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

buyerTotal

Type: number

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

buyerTotalBeforeDiscount

Type: number

Стоимость всех товаров в заказе в валюте покупателя до применения скидок и с учетом стоимости доставки (buyerItemsTotalBeforeDiscount + стоимость доставки).

cancelRequested

Type: boolean

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

Запрошена ли отмена.

expiryDate

Type: DateDdMmYyyyHhMmSs

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

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

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

externalOrderId

Type: ExternalOrderId

Внешний идентификатор заказа, который вы передали в POST v2/campaigns/{campaignId}/orders/{orderId}/external-id.

Min length: 1

Example: example

notes

Type: string

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

Example: example

sourcePlatform

Type: OrderSourcePlatformType

Площадка-источник заказа:

• MARKET — заказ, оформленный на Маркете.

• OZON — LaaS-заказ, оформленный на Ozon.

• WILDBERRIES — LaaS-заказ, оформленный на Wildberries.

• OTHER — LaaS-заказ, созданный продавцом.

Enum: MARKET, OZON, WILDBERRIES, OTHER

subsidies

Type: OrderSubsidyDTO[] | null

Список субсидий по типам.

Min items: 1

[
  {
    "type": "YANDEX_CASHBACK",
    "amount": 0.5
  }
]

updatedAt

Type: DateDdMmYyyyHhMmSs

Дата и время последнего обновления заказа.

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

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

nextPageToken

Type: string

Идентификатор следующей страницы результатов.

Example: example

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

• OK — ошибок нет.
• ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

code

Type: string

Код ошибки.

Example: example

message

Type: string

Описание ошибки.

Example: example