从12月31日开始,push API方法将不可用。 从10月1日开始,它们可能不稳定。
用于传输信息的请求:
- 关于剩菜 — PUT v2/campaigns/{campaignId}/offers/stocks.
- 关于商店的销售点 — GET v2/campaigns/{campaignId}/outlets.
要接收有关订单的信息,请启用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
},
"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: CartDTO 篮子。 |
CartDTO
篮子。
|
Name |
Description |
|
businessId |
Type: integer<int64> 内阁ID。 |
|
buyer |
Type: object 有关买方的信息。 参数 |
|
currency |
Type: CurrencyType Валюта, в которой указаны цены на товары в заказе. Принимает значение Enum: |
|
delivery |
Type: CartDeliveryDTO 交付信息。 |
|
deliveryCurrency |
Type: CurrencyType Только для модели DBS Валюта, в которой указаны цены на товары в заказе. Принимает значение Enum: |
|
items |
Type: CartItemDTO[] 购物车中的物品。 |
CurrencyType
货币代码:
RUR— 俄罗斯卢布。UAH— 乌克兰格里夫纳。BYR— 白俄罗斯卢布。KZT— 哈萨克斯坦坚戈。UZS— 乌兹别克总和。
|
Type |
Description |
|
Enum: |
CartDeliveryDTO
交付信息。
|
Name |
Description |
|
address |
Type: DeliveryAddressWithoutPersonalDataDTO Только для модели DBS Адрес доставки. Передается, если покупатель уже указал адрес на Маркете.
|
|
estimated |
Type: boolean 只适用于型号 DBS 指示订单的交货日期尚未确认的标志。 它是根据订单发送的产品,交货时间很长(31-60天)。 最终交货日期必须发送给Yandex。自订单提交请求之日起7天内上市。 PUT v2/campaigns/{campaignId}/orders/{orderId}/delivery/date. |
|
region |
Type: ShopRegionDTO 的输送区域。 |
CartItemDTO
购物车中的物品。
|
Name |
Description |
|
count |
Type: integer 积单元的数量。 |
|
feedCategoryId |
Type: string 文件夹中指定的类别的ID。 商店不应在响应中传输此标识符。 让它空着。 |
|
feedId |
Type: integer<int64> 产品目录的ID。 存储必须在响应中指定相同的标识符。 |
|
fulfilmentShopId |
Type: integer<int64> 只适用于型号 DBS 产品供应商的ID。 要找到答案,请登录市场上的卖家帐户并点击其名称。 ID在字段中指定 商店ID 在所需仓库的行中。 |
|
id |
Type: integer<int64> 商品在购物车中的ID。 |
|
offerId |
Type: string Идентификатор вашего товарного предложения для определенного товара. Описание поля в Справке Маркета для продавцов Min length: Max length: Pattern: |
|
offerName |
Type: string 只适用于型号 DBS 产品名称。 |
|
partnerWarehouseId ⦸
|
Type: string 只适用于型号 FBS 为其下订单的商店系统中仓库的ID。 |
|
price ⦸
|
Type: number<decimal> 以订单货币计算的产品价格,不包括促销代码、优惠券和促销折扣给卖方的报酬(参数) |
|
promos |
Type: OrderItemPromoDTO[] 有关使用促销代码,优惠券和促销活动向卖家提供商品折扣的奖励的信息。 |
|
shopSku |
Type: string 你的 SKU — 系统中的产品ID。 使用规则 SKU:
SKU 产品可以在市场上的卖方帐户中更改。 阅读有关如何做到这一点。 在市场对卖家的帮助. Min length: Max length: Pattern: |
|
subsidy ⦸
|
Type: number<decimal> 对产品的所有折扣给卖方的总报酬:
|
|
warehouseId |
Type: integer<int64> 只适用于型号 FBS 市场上仓库的ID。 |
DeliveryAddressWithoutPersonalDataDTO
送货地址。 如果参数传递 type 这很重要 DELIVERY.
|
Name |
Description |
|
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[] 接机点的电话号码格式 如果客户选择将订单交付到品牌市场提货点,则指定此参数。
|
|
postcode |
Type: string 邮政编码。 如果选择了邮件传递,则表示( |
|
schedule |
Type: ShopOutletScheduleItemDTO[] 接送点的开放时间。 如果客户选择将订单交付到品牌市场提货点,则指定此参数。
|
|
street |
Type: string 街道。 |
|
subway |
Type: string 地铁站。 |
ShopRegionDTO
的输送区域。
|
Name |
Description |
|
name* |
Type: string 区域的名称。 |
|
type* |
Type: ShopRegionType Тип региона. Enum: |
|
id |
Type: integer<int64> 区域的ID。 |
|
parent |
Type: ShopRegionDTO 的输送区域。 |
OrderItemPromoDTO
有关使用促销代码,优惠券和促销活动向卖家提供商品折扣的奖励的信息。
|
Name |
Description |
|
type* |
Type: OrderPromoType Тип скидки. Enum: |
|
marketPromoId |
Type: string 在市场和卖方之间提供服务以促进服务的协议框架内的促销标识符。 |
|
subsidy |
Type: number<decimal> 作为促销活动的一部分销售的产品从市场上向卖方支付报酬。 |
ShopOutletScheduleItemDTO
销售点的开放时间。
|
Name |
Description |
|
fromDay* |
Type: DayOfWeekType День недели, в который пункт выдачи начинает работать:
Обязательный параметр. Enum: |
|
fromTime* |
Type: string 接点的开始时间。 时间格式:24小时, 所需参数。 Min length: |
|
toDay* |
Type: DayOfWeekType День недели, в который пункт выдачи заканчивает работать:
Обязательный параметр. Enum: |
|
toTime* |
Type: string 取点的结束时间。 时间格式:24小时, 所需参数。 Min length: |
ShopRegionType
地区类型:
-
CITY_DISTRICT— 城市的面积。 -
CITY— 一个大城市。 -
CONTINENT— 大陆。 -
COUNTRY_DISTRICT— 联邦区。 -
COUNTRY— 国家。 -
REGION— 地区。 -
METRO_STATION— 地铁站。 -
MONORAIL_STATION— 单轨铁路站。 -
OVERSEAS_TERRITORY— 位于世界另一地区的一个国家的一个单独领土(例如安圭拉、格陵兰、百慕大等)。). -
SECONDARY_DISTRICT— 二级市辖区(例如,对于莫斯科自治区,二级区是Izmailovo,Novokosino,Perovo等。). -
SETTLEMENT— 结算。 -
SUBJECT_FEDERATION— 联的主体。 -
SUBJECT_FEDERATION_DISTRICT— 联的主体的区。 -
VILLAGE— 城市。 -
SUBURB— 郊区。 -
OTHER— 未知区域。
|
Type |
Description |
|
Enum: |
OrderPromoType
折扣类型:
-
DIRECT_DISCOUNT— 直接折扣,这是由卖方或市场设置。 -
BLUE_SET— 工具包。 -
BLUE_FLASH— 一个闪光的促销。 -
MARKET_COUPON— 使用Yandex的折扣。市场促销代码. -
MARKET_PROMOCODE— 商店促销代码的折扣。 -
MARKET_BLUE— Yandex的折扣。 市场。 -
CHEAPEST_AS_GIFT— 作为礼物最便宜的项目。 -
CASHBACK— 现金返还。 -
SPREAD_DISCOUNT_COUNT— 相同商品数量的折扣。 -
SPREAD_DISCOUNT_RECEIPT— 收据金额的折扣. -
DISCOUNT_BY_PAYMENT_TYPE— 使用Plus卡付款时可享受直接折扣。 -
PERCENT_DISCOUNT— 直接百分比折扣。 -
DCO_EXTRA_DISCOUNT— 从市场计算补贴所需的额外折扣。 -
UNKNOWN— 未知类型。
过时的类型:
-
GENERIC_BUNDLE. -
MARKET_COIN. -
PRICE_DROP_AS_YOU_SHOP. -
SECRET_SALE.
|
Type |
Description |
|
Enum: |
DayOfWeekType
星期几:
MONDAY— 星期一。TUESDAY— 星期二。WEDNESDAY— 星期三。THURSDAY— 星期四。FRIDAY— 星期五。SATURDAY— 星期六。SUNDAY— 星期天。
|
Type |
Description |
|
Enum: |
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)
-
在参数中指定
fromDate和toDate,嵌套在dates,最早和最晚的可能交货日期,分别,并在参数intervals— 日期和(如果可能的话,为快递递送)递送间隔, 用户可以选择.一组嵌套在
dates,取决于订单交付方式:- 以速递派递方式订购(
"type": "DELIVERY")要么所有三个参数都应该传递(fromDate,toDate,intervals),或只有提前交货日期(fromDate). - 对于具有提货送货方式的订单(
"type": "PICKUP")只应传递参数fromDate和toDate. 参数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: CartResponseDTO 篮子。 |
CartResponseDTO
|
Name |
Description |
|
deliveryCurrency |
Type: CurrencyType Только для модели DBS Валюта, в которой указаны цены на товары в заказе. Принимает значение Enum: |
|
deliveryOptions |
Type: CartResponseDeliveryOptionDTO[] 只适用于型号 DBS 送货选项可用于购物车.
|
|
items |
Type: CartResponseItemDTO[] 购物车中的物品。 |
|
paymentMethods |
Type: OrderPaymentMethodType[] 订购付款方法:
默认值: Enum: |
CartResponseDeliveryOptionDTO
|
Name |
Description |
|
serviceName* |
Type: string 送货服务的名称。 所需参数。 最大长度:50个字符。 |
|
dates |
Type: CartResponseDeliveryDatesDTO 交货日期的范围。 最大日期数 — 7. Max items: |
|
id |
Type: string 商店分配的交付选项ID。 如果指定了ID,它将在请求中传递回存储。 POST order/accept. 最大长度:50个字符。 |
|
outlets |
Type: CartResponseOutletDTO[] 接送点。 如果选择了拾音器,则表示( |
|
paymentMethods |
Type: OrderPaymentMethodType[] 订购付款方法:
默认值: Enum: |
|
price |
Type: number<decimal> 以订单货币交付的成本。 从2021年7月1日起,将为客户推出统一的运费。 无论如何,运费都是一样的 这取决于谁交付订单:市场或卖家自己。 它将自动从统一的关税表中取代. 通过API传输的运费数据将不被考虑在内。 但是,仍然需要向市场提供有关交货时间的信息。 有关更多信息,请参阅Yandex。对卖家的市场帮助 |
|
type |
Type: OrderDeliveryType 订单交付方法:
Enum: |
CartResponseItemDTO
|
Name |
Description |
|
count |
Type: integer 可供订购的产品数量。 我应该发送什么值: 在参数中的请求中 根据可用性,请返回:
如果您启用了通过支持忽略余额的选项,则返回任何值,包括 |
|
delivery |
Type: boolean 只适用于型号 DBS 将产品交付到请求中指定的区域:
|
|
feedId |
Type: integer<int64> 产品目录的ID。 您需要指定与Yandex请求中相同的标识符。市场。 |
|
offerId |
Type: string 你的 SKU — 系统中的产品ID。 使用规则 SKU:
SKU 产品可以在市场上的卖方帐户中更改。 阅读有关如何做到这一点。 在市场对卖家的帮助. Min length: Max length: Pattern: |
|
sellerInn |
Type: string 只适用于型号 DBS 品的卖方的INN。 |
OrderPaymentMethodType
订购付款方法:
-
如果在结账时选择付款,则值(
"paymentType": "PREPAID"):-
YANDEX— 通过银行卡。 -
APPLE_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.
|
Type |
Description |
|
Enum: |
CartResponseDeliveryDatesDTO
|
Name |
Description |
|
fromDate |
Type: string<date-dd-MM-yyyy> Ближайшая возможная дата доставки. Формат даты: Дата должна быть не ранее текущей даты и не позднее 31 календарного дня от текущей даты. Example: |
|
intervals |
Type: CartResponseDeliveryIntervalDTO[] 指定日期可能的交货日期和时间间隔的列表。 该参数最多可为每个日期指定7个间隔。 此参数是快递递送所必需的( Max items: |
|
toDate |
Type: string<date-dd-MM-yyyy> Самая поздняя дата доставки. Формат: Example: |
CartResponseOutletDTO
|
Name |
Description |
|
code* |
Type: string 店分配的取件点ID。 如果指定了不存在的标识符,则在下订单时不会向买方显示这样的提货点。 |
OrderDeliveryType
订单交付方法:
-
DELIVERY— 快递送货。 -
PICKUP— 皮卡。 -
POST— 邮件。 -
DIGITAL— 用于数字商品。 -
UNKNOWN— 未知类型。
|
Type |
Description |
|
Enum: |
CartResponseDeliveryIntervalDTO
|
Name |
Description |
|
fromTime* |
Type: string<time> 送时间间隔的开始。 所需参数。
时间格式:24小时, |
|
toTime* |
Type: string<time> 送时间间隔的结束。 所需参数。
时间格式:24小时, |
|
date |
Type: string<date-dd-MM-yyyy> Возможная дата доставки. Формат даты: Example: |
400 Bad Request
如果商店考虑从Yandex收到的请求。 如果不正确,商店必须返回响应状态400,其中包含响应正文中错误原因的描述。 这些回应将被分析为API违规和市场上的缺陷。
500 Internal Server Error
如果商店一侧出现技术错误,它应该返回响应状态500。 具有大量此类响应的商店可能与市场脱节。
No longer supported, please use an alternative and newer version.