Запрос информации о товарах

cart

Type: CartDTO

Корзина.

{
  "businessId": 0,
  "currency": "RUR",
  "deliveryCurrency": null,
  "buyer": {
    "id": "example",
    "lastName": "example",
    "firstName": "example",
    "middleName": "example",
    "email": "example",
    "type": "PERSON",
    "phone": "example",
    "uid": 0
  },
  "delivery": {
    "region": {
      "id": 0,
      "name": "example",
      "type": "OTHER",
      "parent": null
    },
    "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": [
        {}
      ]
    },
    "estimated": true,
    "outlet": {
      "code": "example"
    }
  },
  "items": [
    {
      "id": 0,
      "feedId": 0,
      "offerId": "example",
      "feedCategoryId": "example",
      "offerName": "example",
      "price": 0.5,
      "subsidy": 0.5,
      "count": 0,
      "shopSku": null,
      "warehouseId": 0,
      "partnerWarehouseId": "example",
      "fulfilmentShopId": 0,
      "priceBeforeDiscount": 0.5,
      "promos": [
        {
          "type": "DIRECT_DISCOUNT",
          "subsidy": 0.5,
          "marketPromoId": "example"
        }
      ]
    }
  ]
}

type

Type: OrderBuyerType

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

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

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

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

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

Enum: PERSON, BUSINESS

firstName

Type: string

Имя.

Example: example

id

Type: string

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

Example: example

lastName

Type: string

Фамилия.

Example: example

middleName

Type: string

Отчество.

Example: example

name

Type: string

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

Example: example

type

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

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

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

parent

Type: ShopRegionDTO

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

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

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

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

apartment

Type: string

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

Example: example

block

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

floor

Type: string

Этаж.

Example: example

house

Type: string

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

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

Example: example

postcode

Type: string

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

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

Example: example

street

Type: string

Улица.

Example: example

subway

Type: string

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

Example: example

fromDay

Type: DayOfWeekType

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

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

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

День недели:

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

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

fromTime

Type: string

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

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

Min length: 1

Example: example

toDay

Type: DayOfWeekType

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

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

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

День недели:

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

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

toTime

Type: string

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

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

Min length: 1

Example: example

address

Type: DeliveryAddressWithoutPersonalDataDTO

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

Адрес доставки. Передается, если покупатель уже указал адрес на Маркете.

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

{
  "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"
    }
  ]
}

estimated

Type: boolean

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

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

region

Type: ShopRegionDTO

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

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

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

marketPromoId

Type: string

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

Example: example

subsidy

Type: number

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

count

Type: integer

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

feedCategoryId

Type: string

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

В ответе магазин не должен передавать этот идентификатор. Оставьте его пустым.

Example: example

feedId

Type: integer

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

В ответе магазин должен указать тот же идентификатор.

fulfilmentShopId

Type: integer

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

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

Чтобы узнать его, войдите в кабинет продавца на Маркете и нажмите на его название. Идентификатор указан в поле ID магазина в строке нужного склада.

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

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

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

Example: example

partnerWarehouseId

Type: string

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

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

Example: example

price

Type: number

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

promos

Type: OrderItemPromoDTO[]

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

shopSku

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

subsidy

Type: number

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

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

warehouseId

Type: integer

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

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

code

Type: string

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

Example: example

businessId

Type: integer

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

buyer

currency

Type: CurrencyType

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

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

Коды валют:

• 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: CartDeliveryDTO

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

{
  "region": {
    "id": 0,
    "name": "example",
    "type": "OTHER",
    "parent": null
  },
  "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": [
      {
        "fromDay": "MONDAY",
        "toDay": null,
        "fromTime": "example",
        "toTime": "example"
      }
    ]
  },
  "estimated": true,
  "outlet": {
    "code": "example"
  }
}

deliveryCurrency

Type: CurrencyType

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

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

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

Коды валют:

• 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

items

Type: CartItemDTO[]

[
  {
    "id": 0,
    "feedId": 0,
    "offerId": "example",
    "feedCategoryId": "example",
    "offerName": "example",
    "price": 0.5,
    "subsidy": 0.5,
    "count": 0,
    "shopSku": null,
    "warehouseId": 0,
    "partnerWarehouseId": "example",
    "fulfilmentShopId": 0,
    "priceBeforeDiscount": 0.5,
    "promos": [
      {
        "type": "DIRECT_DISCOUNT",
        "subsidy": 0.5,
        "marketPromoId": "example"
      }
    ]
  }
]