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": "string",
            "lastName": "string",
            "firstName": "string",
            "middleName": "string",
            "type": "PERSON"
        },
        "delivery": {
            "region": {
                "id": 0,
                "name": "string",
                "type": "OTHER"
            },
            "address": {
                "country": "string",
                "postcode": "string",
                "city": "string",
                "district": "string",
                "subway": "string",
                "street": "string",
                "house": "string",
                "block": "string",
                "entrance": "string",
                "entryphone": "string",
                "floor": "string",
                "apartment": "string",
                "lat": 0,
                "lon": 0,
                "notes": "string",
                "outletPhones": [
                    "string"
                ],
                "schedule": [
                    {
                        "fromDay": "MONDAY",
                        "toDay": "MONDAY",
                        "fromTime": "string",
                        "toTime": "string"
                    }
                ]
            },
            "estimated": false,
            "outlet": {
                "code": "string"
            }
        },
        "items": [
            {
                "id": 0,
                "feedId": 0,
                "offerId": "string",
                "feedCategoryId": "string",
                "offerName": "string",
                "price": 0,
                "subsidy": 0,
                "count": 0,
                "shopSku": "string",
                "warehouseId": 0,
                "partnerWarehouseId": "string",
                "fulfilmentShopId": 0,
                "promos": [
                    {
                        "type": "DIRECT_DISCOUNT",
                        "subsidy": 0,
                        "marketPromoId": "string"
                    }
                ]
            }
        ]
    }
}

Name

Description

cart*

Type: object

businessId

Type: integer<int64>

Cabinet ID.

buyer

Type: object

firstName

Type: string

Name.

id

Type: string

The buyer's ID.

lastName

Type: string

Surname.

middleName

Type: string

Middle name.

type

Type: string

Type of buyer:

  • PERSON — a natural person.

  • BUSINESS — organization.

Enum: PERSON, BUSINESS

Information about the buyer.

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

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

Type: object

apartment

Type: string

Apartment or office number.

block

Type: string

A building or building.

city

Type: string

A city or locality.

Required parameter.

country

Type: string

A country.

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

district

Type: string

District.

entrance

Type: string

Entrance number.

entryphone

Type: string

The intercom code.

floor

Type: string

Floor.

house

Type: string

The number of the house or property.

Required parameter.

lat

Type: number<decimal>

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<decimal>

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.

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.

postcode

Type: string

Postal code.

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

schedule

Type: object[]

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.
The opening hours of the point of sale.

street

Type: string

Street.

subway

Type: string

The metro station.

The delivery address. Passed if the parameter type it matters DELIVERY.
Address.

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.

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).

region

Type: any

The delivery region.

Delivery information.

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

Items in the shopping cart.

Basket.

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 basket 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": "string",
                "count": 0,
                "delivery": false,
                "sellerInn": "string"
            }
        ],
        "deliveryOptions": [
            {
                "id": "string",
                "price": 0,
                "serviceName": "string",
                "type": "DELIVERY",
                "dates": {
                    "fromDate": "23-09-2022",
                    "toDate": "23-09-2022",
                    "intervals": [
                        {
                            "date": "23-09-2022",
                            "fromTime": "string",
                            "toTime": "string"
                        }
                    ]
                },
                "outlets": [
                    {
                        "code": "string"
                    }
                ],
                "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[]

For the model only DBS

Delivery options available for the shopping cart.

items

Type: object[]

Items in the shopping cart.

paymentMethods

Type: string[]

Order payment method:

  • Values if payment is selected at checkout ("paymentType": "PREPAID"):

    • YANDEX — by bank card.

    • APPLE_PAY — Apple Pay (not in use).

    • GOOGLE_PAY — Google Pay (not in use).

    • CREDIT — on credit.

    • TINKOFF_CREDIT — on credit from Tinkoff Bank.

    • TINKOFF_INSTALLMENTS — installments at Tinkoff Bank.

    • EXTERNAL_CERTIFICATE — with a gift certificate (for example, from the Sberbank Online application).

    • SBP — through the fast payment system.

    • B2B_ACCOUNT_PREPAYMENT — The organization pays for the order.

  • Values if payment is selected upon receipt of the order ("paymentType": "POSTPAID"):

    • CARD_ON_DELIVERY — by bank card.

    • BOUND_CARD_ON_DELIVERY — with a linked bank card upon receipt.

    • BNPL_BANK_ON_DELIVERY — super Split.

    • BNPL_ON_DELIVERY — Split.

    • CASH_ON_DELIVERY — in cash.

    • B2B_ACCOUNT_POSTPAYMENT — the order is paid for by the organization after delivery.

  • UNKNOWN — unknown type.

Default value: CASH_ON_DELIVERY.

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

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.