从12月31日开始,push API方法将不可用。 从10月1日起,它们可能不稳定。

用于传输信息的请求:

要接收有关订单的信息,请启用API通知。 怎么做

索取有关产品的资料

市场验证客户放入篮子的商品是否在商店中可用。 在 DBS-商店也被要求提供有关交货可能性和可用付款方式的信息。

响应时间:5.5秒。

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>

内阁ID。

buyer

Type: object

firstName

Type: string

姓名。

id

Type: string

买方的ID。

lastName

Type: string

姓。

middleName

Type: string

中间名。

type

Type: string

买方类型:

  • PERSON — 一个自然人。

  • BUSINESS — 组织。

Enum: PERSON, BUSINESS

有关买方的信息。

参数 id, lastName, firstNamemiddleName 只有当您根据模型工作时,才会返回它们。 DBS.

currency

Type: string

货币代码:

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

address

Type: object

apartment

Type: string

公寓或办公室号码。

block

Type: string

建筑物或建筑物。

city

Type: string

一个城市或地方。

所需参数。

country

Type: string

一个国家。

如果选择了将订单交付到市场提货点,则可选参数。

district

Type: string

区。

entrance

Type: string

入口号码。

entryphone

Type: string

的对讲代码。

floor

Type: string

地板。

house

Type: string

房屋或财产的编号。

所需参数。

lat

Type: number<decimal>

宽度。

如果客户选择将订单交付到品牌市场提货点,则指定此参数。

我们不保证它会被填写,因为这是一个可选字段。

lon

Type: number<decimal>

经度。

如果客户选择将订单交付到品牌市场提货点,则指定此参数。

我们不保证它会被填写,因为这是一个可选字段。

notes

Type: string

地址的注释。 例如, 从庭院入口.

如果客户选择将订单交付到品牌市场提货点,则指定此参数。

outletPhones

Type: string[]

接机点的电话号码格式 8 812 123-45-67 890 (890 — 延伸)。

如果客户选择将订单交付到品牌市场提货点,则指定此参数。

postcode

Type: string

邮政编码。

如果选择了邮件传递,则表示(交货类型=POST).

schedule

Type: object[]

接送点的开放时间。

如果客户选择将订单交付到品牌市场提货点,则指定此参数。
销售点的开放时间。

street

Type: string

街道。

subway

Type: string

地铁站。

送货地址。 如果参数传递 type 这很重要 DELIVERY.
地址。

estimated

Type: boolean

只适用于型号 DBS

指示订单的交货日期尚未确认的标志。 它是根据订单发送的产品,交货时间很长(31-60天)。 最终交货日期必须发送给Yandex。自订单提交请求之日起7天内上市。 PUT v2/campaigns/{campaignId}/orders/{orderId}/delivery/date.

outlet

Type: object

code

Type: string

店分配的取件点ID。

买方为接收订单而选择的提货点。 如果客户选择在品牌市场订单提货点(价值)接收订单,则不会在响应中返回 MARKET_BRANDED_OUTLET 参数 dispatchType).

region

Type: any

的输送区域。

交付信息。

deliveryCurrency

Type: string

货币代码:

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

购物车中的物品。

篮子。

Responses

200 OK

关于转移的篮子和指定的交货区域的货物可用性的最新信息。

如何在不同情况下传输产品数据
商店不将订单交付到转移的地区或买方的地址(DBS)

指定空传递选项: "deliveryOptions":[]. 在参数中 items 对于每个产品,参数 delivery 你不必传送它。

篮子里有商店没有送到转移地区或买家地址的物品(DBS)

对于此类产品,请指定 "delivery": false 在参数中 items.

该产品不可出售(DBS)

指定产品的参数 "count": 0. 如果篮子中的所有物品都没有出售,请传递参数 items 空的。

您已收到产品缺货的信息

10-15分钟后,此优惠停止按型号在市场上显示。 DBS 直到服务上的数据的下一次更新(索引每4小时进行一次)。

该产品目前缺货

指定参数 计数="0",嵌套在参数中 items. 如果篮子中的所有物品都没有出售,请传递参数 items 空的。

例子:

为便于阅读,示例代码以缩写格式提供。

{
  "cart":
  {
    "items":
    [
      {
        "feedId": {int64},
        "offerId": "{string}",
        "count": {int32},
        "delivery": {boolean}
      },
      ...
    ]
  }
}
如何将派递资料传送至提货点(DBS)

在参数中指定 outlets 产品已有库存的所有提货点的id,如果产品尚未存在,您可以将产品交付给该提货点。 您需要在参数中指定请求中指定的区域中的所有合适的拾取点 region (即使参数包含一个不完整的地址:例如,只有一个城市或地区)。

如果不同的提货点的交货条件不同(例如,订单将在明天交付到某些点,而其他点 — 后天),在参数 deliveryOptions 为具有相同条件的每组点指定一个嵌套参数,并在每组点中列出适当的点。

如何传输有关数字商品的数据(DBS)

如果您已禁用使用该方法 POST cart,则不需要传输数据。

使用数字商品的说明

寄什么作为运费(DBS)

市场对客户有单一的交货率。 交付成本自动从统一的关税表中取代. 您可以传输任何数字。 — 不考虑通过API传输的运费数据。 提供了有关统一关税的详细信息 在市场对卖家的帮助.

日期范围和交货间隔(DBS)

在参数中指定 fromDatetoDate,嵌套在 dates,最早和最晚的可能交货日期,分别,并在参数 intervals — 日期和(如果可能的话,为快递递送)递送间隔, 用户可以选择.

一组嵌套在 dates,取决于订单交付方式:

  • 以速递派递方式订购("type": "DELIVERY")要么所有三个参数都应该传递(fromDate, toDate, intervals),或只有提前交货日期(fromDate).
  • 对于具有提货送货方式的订单("type": "PICKUP")只应传递参数 fromDatetoDate. 参数 intervals 你不能为这样的订单转移它。
例子:

为便于阅读,示例代码以缩写格式提供。

你会在你的回应传达什么 POST cart

用户可以选择什么

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

3月10日00:00-23:59

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

3月1日00:00 — 3月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

货币代码:

  • 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

deliveryOptions

Type: object[]

只适用于型号 DBS

送货选项可用于购物车.

items

Type: object[]

购物车中的物品。

paymentMethods

Type: string[]

订购付款方法:

  • 如果在结账时选择付款,则值("paymentType": "PREPAID"):

    • YANDEX — 通过银行卡。

    • APPLE_PAY — Apple Pay(未使用)。

    • GOOGLE_PAY — Google Pay(未使用)。

    • CREDIT — 信贷。

    • TINKOFF_CREDIT — 从廷科夫银行贷到的。

    • TINKOFF_INSTALLMENTS — 分期付款在廷科夫银行。

    • EXTERNAL_CERTIFICATE — 与礼券(例如,从Sberbank在线应用程序)。

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

如果商店考虑从Yandex收到的请求。 如果不正确,商店必须返回响应状态400,其中包含响应正文中错误原因的描述。 这些回应将被分析为API违规和市场上的缺陷。

500 Internal Server Error

如果商店一侧出现技术错误,它应该返回响应状态500。 具有大量此类响应的商店可能与市场脱节。

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