Starting from December 31, push API methods will be unavailable. From October 1, they may be unstable.

Requests to use to transmit information:

To receive information about orders, enable API notifications. How to do it

Requesting information about products

The market verifies that the goods that the customer has put in the basket are available in the store. At DBS-stores are also asked for information about the possibility of delivery and available payment methods.

Response time: 5.5 seconds.

Request

POST

/cart

Body

application/json
{
  "cart": {
    "businessId": 0,
    "currency": "RUR",
    "deliveryCurrency": "RUR",
    "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": [
          null
        ],
        "schedule": [
          null
        ]
      },
      "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": "example",
        "warehouseId": 0,
        "partnerWarehouseId": "example",
        "fulfilmentShopId": 0,
        "priceBeforeDiscount": 0.5,
        "promos": [
          {}
        ]
      }
    ]
  }
}

Name

Description

cart

Type: object

businessId

Type: integer

Cabinet ID.

buyer

All of 2 types
  • Type: object

    All of 2 types
    • Type: object

      type

      Type: string

      Type of buyer:

      • PERSON — a natural person.

      • BUSINESS — organization.

      Enum: PERSON, BUSINESS

      firstName

      Type: string

      Name.

      Example: example

      id

      Type: string

      The buyer's ID.

      Example: example

      lastName

      Type: string

      Surname.

      Example: example

      middleName

      Type: string

      Middle name.

      Example: example

      Information about the buyer with basic fields.

      Example
      {
        "id": "example",
        "lastName": "example",
        "firstName": "example",
        "middleName": "example",
        "type": "PERSON"
      }
      
    • Type: object

      phone

      Type: string

      The buyer's phone number.

      Number format: +<country code><region_code><phone number>.

      Example: example

      Example
      {
        "phone": "example"
      }
      

    Information about the buyer.

    Parameters id, lastName, firstName and middleName They are returned only if you work according to the model. DBS.

    Example
    {
      "id": "example",
      "lastName": "example",
      "firstName": "example",
      "middleName": "example",
      "type": "PERSON",
      "phone": "example"
    }
    
  • Type: object

    uid

    Type: integer

    user's UID

    Example
    {
      "uid": 0
    }
    
Example
{
  "id": "example",
  "lastName": "example",
  "firstName": "example",
  "middleName": "example",
  "type": "PERSON",
  "phone": "example",
  "uid": 0
}

currency

Type: string

Currency codes:

  • RUR — the Russian ruble.
  • UAH — the Ukrainian hryvnia.
  • BYR — the Belarusian ruble.
  • KZT — Kazakhstani tenge.
  • UZS — Uzbek sum.

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

address

All of 2 types
  • Type: object

    apartment

    Type: string

    Apartment or office number.

    Example: example

    block

    Type: string

    A building or building.

    Example: example

    city

    Type: string

    A city or locality.

    Required parameter.

    Example: example

    country

    Type: string

    A country.

    Optional parameter if order delivery to the pick-up point is selected.

    Example: example

    district

    Type: string

    District.

    Example: example

    entrance

    Type: string

    Entrance number.

    Example: example

    entryphone

    Type: string

    The intercom code.

    Example: example

    floor

    Type: string

    Floor.

    Example: example

    house

    Type: string

    The number of the house or property.

    Required parameter.

    Example: example

    postcode

    Type: string

    Postal code.

    Indicated if mail delivery is selected (delivery type=POST).

    Example: example

    street

    Type: string

    Street.

    Example: example

    subway

    Type: string

    The metro station.

    Example: example

    Address.

    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

    Width.

    This parameter is specified if the customer has chosen to deliver the order to a branded Market pick-up point.

    We do not guarantee that it will be filled in, as this is an optional field.

    lon

    Type: number

    Longitude.

    This parameter is specified if the customer has chosen to deliver the order to a branded Market pick-up point.

    We do not guarantee that it will be filled in, as this is an optional field.

    notes

    Type: string

    A note to the address. For example, Entrance from the courtyard.

    This parameter is specified if the customer has chosen to deliver the order to a branded Market pick-up point.

    Example: example

    outletPhones

    Type: string[]

    Phone numbers of the pick-up point in the format 8 812 123-45-67 890 (890 — extension).

    This parameter is specified if the customer has chosen to deliver the order to a branded Market pick-up point.

    Example
    [
      "example"
    ]
    

    schedule

    Type: object[]

    fromDay

    Type: string

    Day of the week:

    • MONDAY — Monday.
    • TUESDAY — Tuesday.
    • WEDNESDAY — wednesday.
    • THURSDAY — Thursday.
    • FRIDAY — Friday.
    • SATURDAY — Saturday.
    • SUNDAY — Sunday.

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

    fromTime

    Type: string

    The start time of the pick-up point. Time format: 24-hour, HH:MM.

    Required parameter.

    Min length: 1

    Example: example

    toDay

    Type: string

    Day of the week:

    • MONDAY — Monday.
    • TUESDAY — Tuesday.
    • WEDNESDAY — wednesday.
    • THURSDAY — Thursday.
    • FRIDAY — Friday.
    • SATURDAY — Saturday.
    • SUNDAY — Sunday.

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

    toTime

    Type: string

    The end time of the pick-up point. Time format: 24-hour, HH:MM.

    Required parameter.

    Min length: 1

    Example: example

    The opening hours of the pick-up point.

    This parameter is specified if the customer has chosen to deliver the order to a branded Market pick-up point.

    Example
    [
      {
        "fromDay": "MONDAY",
        "toDay": "MONDAY",
        "fromTime": "example",
        "toTime": "example"
      }
    ]
    
    Example
    {
      "lat": 0.5,
      "lon": 0.5,
      "notes": "example",
      "outletPhones": [
        "example"
      ],
      "schedule": [
        {
          "fromDay": "MONDAY",
          "toDay": "MONDAY",
          "fromTime": "example",
          "toTime": "example"
        }
      ]
    }
    

The delivery address. Passed if the parameter type it matters 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,
  "notes": "example",
  "outletPhones": [
    "example"
  ],
  "schedule": [
    {
      "fromDay": "MONDAY",
      "toDay": "MONDAY",
      "fromTime": "example",
      "toTime": "example"
    }
  ]
}

estimated

Type: boolean

For the model only DBS

A flag that indicates that the delivery date for the order has not been confirmed. It is transmitted for products on order with a long delivery time (31-60 days). The final delivery date must be sent to Yandex.Market within 7 days from the date the order was placed in the request. PUT v2/campaigns/{campaignId}/orders/{orderId}/delivery/date.

outlet

Type: object

code

Type: string

The pick-up point ID assigned by the store.

Example: example

The pick-up point selected by the buyer to receive the order. It is not returned in the response if the customer has chosen to receive the order at a branded Market order pick-up point (value MARKET_BRANDED_OUTLET the parameter dispatchType).

Example
{
  "code": "example"
}

region

Type: object

name

Type: string

The name of the region.

Example: example

type

Type: string

Type of region:

  • CITY_DISTRICT — the area of the city.

  • CITY — a large city.

  • CONTINENT — the continent.

  • COUNTRY_DISTRICT — the federal district.

  • COUNTRY — country.

  • REGION — region.

  • METRO_STATION — the metro station.

  • MONORAIL_STATION — monorail station.

  • OVERSEAS_TERRITORY — a separate territory of a state located in another part of the world (for example, Anguilla, Greenland, Bermuda, etc.).

  • SECONDARY_DISTRICT — the second-level city district (for example, for the Moscow Autonomous District, the second-level districts are Izmailovo, Novokosino, Perovo, etc.).

  • SETTLEMENT — settlement.

  • SUBJECT_FEDERATION — the subject of the Federation.

  • SUBJECT_FEDERATION_DISTRICT — the district of the subject of the federation.

  • VILLAGE — city.

  • SUBURB — suburb.

  • OTHER — unknown region.

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

ID of the region.

parent

Type: unknown

Information about the parent region.

Parent regions are specified up to the country level.

Example: null

The delivery region.

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

Delivery information.

Example
{
  "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,
    "notes": "example",
    "outletPhones": [
      "example"
    ],
    "schedule": [
      {
        "fromDay": "MONDAY",
        "toDay": "MONDAY",
        "fromTime": "example",
        "toTime": "example"
      }
    ]
  },
  "estimated": true,
  "outlet": {
    "code": "example"
  }
}

deliveryCurrency

Type: string

Currency codes:

  • RUR — the Russian ruble.
  • UAH — the Ukrainian hryvnia.
  • BYR — the Belarusian ruble.
  • KZT — Kazakhstani tenge.
  • UZS — Uzbek sum.

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

count

Type: integer

The number of product units.

feedCategoryId

Type: string

The ID of the category specified in the folder.

The store should not transmit this identifier in the response. Leave it empty.

Example: example

feedId

Type: integer

ID of the product catalog.

The store must specify the same identifier in the response.

fulfilmentShopId

Type: integer

For the model only DBS

The product supplier's ID.

To find out, log in to the seller's account on the Market and click on its name. The ID is specified in the field Store ID in the row of the desired warehouse.

id

Type: integer

The ID of the product in the shopping cart.

offerId

Type: string

Your SKU — the product ID in your system.

Usage rules SKU:

  • For each product SKU there must be one.

  • Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.

SKU The product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers.

Warning

Spaces at the beginning and end of the value are automatically deleted. For example, " SKU123 " and "SKU123" they will be treated as identical values.

What is SKU and how to assign it

Min length: 1

Max length: 255

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

Example: example

offerName

Type: string

For the model only DBS

Product name.

Example: example

partnerWarehouseId

Type: string

For the model only FBS

The ID of the warehouse in the store's system that the order was placed for.

Example: example

price

Type: number

The price of the product in the order currency, excluding remuneration to the seller for discounts on promo codes, coupons and promotions (parameter subsidy).

promos

Type: object[]

type

Type: string

Discount type:

  • DIRECT_DISCOUNT — direct discount, which is set by the seller or the Market.

  • BLUE_SET — kits.

  • BLUE_FLASH — a flash promotion.

  • MARKET_COUPON — discount using the Yandex.Market promo code.

  • MARKET_PROMOCODE — discount on the store's promo code.

  • MARKET_BLUE — discount on Yandex. Market.

  • CHEAPEST_AS_GIFT — the cheapest item as a gift.

  • CASHBACK — cashback.

  • SPREAD_DISCOUNT_COUNT — discount for the number of identical items.

  • SPREAD_DISCOUNT_RECEIPT — discount on the receipt amount.

  • DISCOUNT_BY_PAYMENT_TYPE — direct discount when paying with a Plus card.

  • PERCENT_DISCOUNT — direct percentage discount.

  • DCO_EXTRA_DISCOUNT — an additional discount required to calculate the subsidy from the Market.

  • UNKNOWN — unknown type.

Obsolete types:

  • 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

The identifier of the promotion within the framework of the agreement for the provision of services for the promotion of the service between the Market and the seller.

Example: example

subsidy

Type: number

Remuneration to the seller from the Market for the product sold as part of the promotion.

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

shopSku

Type: string

Your SKU — the product ID in your system.

Usage rules SKU:

  • For each product SKU there must be one.

  • Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.

SKU The product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers.

Warning

Spaces at the beginning and end of the value are automatically deleted. For example, " SKU123 " and "SKU123" they will be treated as identical values.

What is SKU and how to assign it

Min length: 1

Max length: 255

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

Example: example

subsidy

Type: number

Total remuneration to the seller for all discounts on the product:

  • by promo codes;
  • by coupons;
  • by Plus points;
  • on shares.

warehouseId

Type: integer

For the model only FBS

The ID of the warehouse on the Market.

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

Basket.

Example
{
  "businessId": 0,
  "currency": "RUR",
  "deliveryCurrency": "RUR",
  "buyer": {
    "id": "example",
    "lastName": "example",
    "firstName": "example",
    "middleName": "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,
      "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": "example",
      "warehouseId": 0,
      "partnerWarehouseId": "example",
      "fulfilmentShopId": 0,
      "promos": [
        {
          "type": "DIRECT_DISCOUNT",
          "subsidy": 0.5,
          "marketPromoId": "example"
        }
      ]
    }
  ]
}

Responses

200 OK

Up-to-date information about the availability of goods for the transferred basket and the specified delivery region.

How to transfer product data in different situations
The store does not deliver orders to the transferred region or to the buyer's address (DBS)

Specify empty delivery options: "deliveryOptions": []. In the parameter items for each product, the parameter delivery You don't have to transmit it.

There are items in the basket that the store does not deliver to the transferred region or to the buyer's address (DBS)

For such products, specify "delivery": false in the parameter items.

The product is not available for sale (DBS)

Specify the parameter for the product "count": 0. If all the items from the shopping cart are not on sale, pass the parameter items empty.

You have received information that the product is out of stock

After 10-15 minutes, this offer stops being displayed on the Market by model. DBS until the next update of the data on the service (indexing takes place every 4 hours).

The product is currently out of stock

Specify the parameter count="0", nested in the parameter items. If all the items from the shopping cart are not on sale, pass the parameter items empty.

Example

For ease of reading, the sample code is provided in an abbreviated format.

{
  "cart":
  {
    "items":
    [
      {
        "feedId": {int64},
        "offerId": "{string}",
        "count": {int32},
        "delivery": {boolean}
      },
      ...
    ]
  }
}
How to transfer delivery information to pick-up points (DBS)

Specify in the parameter outlets ids of all pick-up points where the product is already in stock and to which you can deliver the product if it is not there yet. You need to specify all the suitable pick-up points in the region specified in the request in the parameter region (even if the parameter contains an incomplete address: for example, only a city or a district in the region).

If the delivery conditions for different pick-up points differ (for example, the order will be delivered to some points tomorrow, and to others — the day after tomorrow), in the parameter deliveryOptions specify one nested parameter for each group of points with the same conditions and list the appropriate points in each of them.

How to transfer data about digital goods (DBS)

If you have disabled working with the method POST cart, you do not need to transfer data.

Instructions for working with digital goods

What to send as the shipping price (DBS)

The Market has a single delivery rate for customers. The cost of delivery is substituted automatically from the unified tariff schedule. You can transmit any number. — shipping cost data transmitted via the API is not taken into account. Detailed information about the unified tariff is provided in the Help of the Market for sellers.

Date ranges and delivery intervals (DBS)

Specify in the parameters fromDate and toDate, nested in dates, the earliest and latest possible delivery dates, respectively, and in the parameter intervals — dates and (for courier delivery, if possible) delivery intervals, which the user can choose between.

A set of parameters nested in dates, depends on the order delivery method:

  • For orders with the courier delivery method ("type": "DELIVERY") either all three parameters should be passed (fromDate, toDate, intervals), or only an early delivery date (fromDate).
  • For orders with a pickup delivery method ("type": "PICKUP") only the parameters should be passed fromDate and toDate. Parameter intervals You can't transfer it for such orders.
Example

For ease of reading, the sample code is provided in an abbreviated format.

What will you convey in your response to POST cart

What the user can choose

"type": "DELIVERY",
"dates":
{
  "fromDate": "10-03-2021"
}

March 10, 00:00-23:59

"type": "PICKUP",
"dates":
{
  "fromDate": "01-03-2021",
  "toDate": "03-03-2021"
}

March 1, 00:00 — March 3, 23:59

Body

application/json
{
  "cart": {
    "paymentMethods": [
      "SHOP_PREPAID"
    ],
    "deliveryCurrency": "RUR",
    "items": [
      {
        "feedId": 0,
        "offerId": "example",
        "count": 0,
        "delivery": true,
        "sellerInn": "example"
      }
    ],
    "deliveryOptions": [
      {
        "id": "example",
        "price": 0.5,
        "deliveryServiceId": 0,
        "serviceName": "example",
        "type": "DELIVERY",
        "dates": {
          "fromDate": "23-09-2022",
          "toDate": "23-09-2022",
          "intervals": [
            null
          ]
        },
        "outlets": [
          {}
        ],
        "paymentMethods": [
          "SHOP_PREPAID"
        ]
      }
    ]
  }
}

Name

Description

cart

Type: object

deliveryCurrency

Type: string

Currency codes:

  • RUR — the Russian ruble.
  • UAH — the Ukrainian hryvnia.
  • BYR — the Belarusian ruble.
  • KZT — Kazakhstani tenge.
  • UZS — Uzbek sum.

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

deliveryOptions

Type: object[]

serviceName

Type: string

The name of the delivery service. Required parameter. Maximum length: 50 characters.

Example: example

dates

Type: object

fromDate

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

Date format: DD-MM-YYYY.

Example: 23-09-2022

intervals

Type: object[]

fromTime

Type: string<time>

The beginning of the delivery time interval. Required parameter.

Time format: 24-hour, HH:MM. Instead of mm always specify 00 (exception — 23:59).

Maximum value: 21:00.

Example: 12:00:00

toTime

Type: string<time>

The end of the delivery time interval. Required parameter.

Time format: 24-hour, HH:MM. Instead of mm always specify 00 (exception — 23:59).

Maximum value: 23:59.

Example: 12:00:00

date

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

Date format: DD-MM-YYYY.

Example: 23-09-2022

A list of possible delivery dates and time intervals on the specified day. The parameter can specify up to 7 intervals for each date. This parameter is required for courier delivery ("type": "DELIVERY"). Must be specified along with the parameters toDate and fromDate.

Max items: 7

Example
[
  {
    "date": "23-09-2022",
    "fromTime": "12:00:00",
    "toTime": "12:00:00"
  }
]

toDate

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

Date format: DD-MM-YYYY.

Example: 23-09-2022

Example
{
  "fromDate": "23-09-2022",
  "toDate": "23-09-2022",
  "intervals": [
    {
      "date": "23-09-2022",
      "fromTime": "12:00:00",
      "toTime": "12:00:00"
    }
  ]
}

id

Type: string

The delivery option ID assigned by the store. If the ID is specified, it will be passed back to the store in the request. POST order/accept. Maximum length: 50 characters.

Example: example

outlets

Type: object[]

code

Type: string

The pick-up point ID assigned by the store.

If a non-existent identifier is specified, such a pick-up point is not displayed to the buyer when placing the order.

Example: example

Pick-up points. Indicated if pickup is selected ("type": "PICKUP"). Specify in the parameter outlets ids of all pick-up points. If you specify non-existent pick-up point IDs, the delivery option will be ignored and its ID will not be included in the request. POST order/accept.

Example
[
  {
    "code": "example"
  }
]

paymentMethods

Type: string[]

Example
[
  "SHOP_PREPAID"
]

price

Type: number

The cost of delivery in the currency of the order. Starting from July 1, 2021, uniform shipping tariffs will be introduced for customers. The shipping cost will be the same regardless it depends on who delivers the order: the Market or the seller himself. It will be substituted automatically from the unified tariff schedule. Shipping cost data transmitted via the API will not be taken into account. However, it is still necessary to provide the Market with information about the delivery time. For more information, see the Yandex.Market Help for Sellers

type

Type: string

Order delivery method:

  • DELIVERY — courier delivery.

  • PICKUP — pickup.

  • POST — mail.

  • DIGITAL — for digital goods.

  • UNKNOWN — unknown type.

Enum: DELIVERY, PICKUP, POST, DIGITAL, UNKNOWN

For the model only DBS

Delivery options available for the shopping cart.

Example
[
  {
    "id": "example",
    "price": 0.5,
    "serviceName": "example",
    "type": "DELIVERY",
    "dates": {
      "fromDate": "23-09-2022",
      "toDate": "23-09-2022",
      "intervals": [
        {
          "date": "23-09-2022",
          "fromTime": "12:00:00",
          "toTime": "12:00:00"
        }
      ]
    },
    "outlets": [
      {
        "code": "example"
      }
    ],
    "paymentMethods": [
      "SHOP_PREPAID"
    ]
  }
]

items

Type: object[]

count

Type: integer

The quantity of the product that is available for order.

What value should I send:

In the request in the parameter count The market sends the quantity of goods that the buyer needs.

Depending on availability, please return:

  • The quantity of goods required by the buyer or more — if there is an excess of goods.

  • Available quantity of goods — if it is less than necessary for the buyer. The information in the shopping cart will be updated, and the buyer will be able to place an order with only the quantity of goods that is available.

  • 0 — if the product is out of stock. You won't be able to buy it.

If you enabled the option to ignore balances through support, return any value, including 0. The buyer will place an order with the quantity of the product specified in the shopping cart.

delivery

Type: boolean

For the model only DBS

Delivery of the product to the region specified in the request:

  • false — The product is not being delivered to the specified region.
  • true — The default value is that the product is delivered to the specified region.

feedId

Type: integer

ID of the product catalog.

You need to specify the same identifier as in the request from Yandex.Market.

offerId

Type: string

Your SKU — the product ID in your system.

Usage rules SKU:

  • For each product SKU there must be one.

  • Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.

SKU The product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers.

Warning

Spaces at the beginning and end of the value are automatically deleted. For example, " SKU123 " and "SKU123" they will be treated as identical values.

What is SKU and how to assign it

Min length: 1

Max length: 255

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

Example: example

sellerInn

Type: string

For the model only DBS

INN of the seller of the product.

Example: example

Items in the shopping cart.

Example
[
  {
    "feedId": 0,
    "offerId": "example",
    "count": 0,
    "delivery": true,
    "sellerInn": "example"
  }
]

paymentMethods

Type: string[]

Example
[
  "SHOP_PREPAID"
]
Example
{
  "paymentMethods": [
    "SHOP_PREPAID"
  ],
  "deliveryCurrency": "RUR",
  "items": [
    {
      "feedId": 0,
      "offerId": "example",
      "count": 0,
      "delivery": true,
      "sellerInn": "example"
    }
  ],
  "deliveryOptions": [
    {
      "id": "example",
      "price": 0.5,
      "serviceName": "example",
      "type": "DELIVERY",
      "dates": {
        "fromDate": "23-09-2022",
        "toDate": "23-09-2022",
        "intervals": [
          {}
        ]
      },
      "outlets": [
        {
          "code": "example"
        }
      ],
      "paymentMethods": [
        "SHOP_PREPAID"
      ]
    }
  ]
}

400 Bad Request

If the store considers the request received from Yandex. Market to be incorrect, the store must return the response status 400 with a description of the reason for the error in the response body. Such responses will be analyzed for API violations and flaws on the part of the Market.

500 Internal Server Error

In case of a technical error on the store's side, it should return the response status 500. Stores with a large number of such responses may be disconnected from the Market.

No longer supported, please use an alternative and newer version.