|
orders
|
Type: object[]
|
campaignId
|
Type: integer
广告系列（商店）的ID — 通过API工作时，代表您在Yandex市场系统中的商店的技术标识符。 它与您的商店唯一链接，但仅用于自动交互。
您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到它。 点击您的帐户图标→ 设置 在左边的菜单中，选择 Api和模块:
- 座 运动ID;
- 标签 查询日志 →块中的下拉列表 显示日志.
⚠️ 不要把它与:
- 商店的标识符，显示在商家的个人帐户中。
- 广告活动。
Min value: 1
|
|
creationDate
|
Type: string<date-time>
订单的日期和时间。
日期格式: ISO 8601 具有相对于 UTC.
Example: 2020-02-02T14:30:30+03:00
|
|
delivery
|
Type: object
|
dates
|
Type: object
|
fromDate
|
Type: string<date>
最近的交货日期。
日期格式: YYYY-MM-DD.
Example: 2025-01-01
|
|
fromTime
|
Type: string<time>
送时间间隔的开始。
它仅与参数一起传递 类型=交付.
时间格式：24小时, HH：MM. 而不是 毫米 始终指定 00 （例外 — 23:59).
最小值: 00:00.
Example: 12:00:00
|
|
realDeliveryDate
|
Type: string<date>
产品送到提货点（如果是提货）或买方（如果订单是由快递员送到）的日期。
日期格式: YYYY-MM-DD.
Example: 2025-01-01
|
|
toDate
|
Type: string<date>
最晚交货日期。
如果 toDate 省略，参数中的日期被认为是 fromDate.
日期格式: YYYY-MM-DD.
Example: 2025-01-01
|
|
toTime
|
Type: string<time>
送时间间隔的结束。
它仅与参数一起传递 类型=交付.
时间格式：24小时, HH：MM. 而不是 毫米 始终指定 00 （例外 — 23:59).
最大值: 23:59.
Example: 12:00:00
|
交货日期的范围。
Example
{
"fromDate": "2025-01-01",
"toDate": "2025-01-01",
"fromTime": "12:00:00",
"toTime": "12:00:00",
"realDeliveryDate": "2025-01-01"
}
|
|
deliveryPartnerType
|
Type: string
在特定订单内与送货服务的合作类型:
Enum: SHOP, YANDEX_MARKET, UNKNOWN
|
|
deliveryServiceId
|
Type: integer
送服务ID。
|
|
serviceName
|
Type: string
送货服务的名称。
Example: example
|
|
type
|
Type: string
订单交付方式:
-
DELIVERY — 快递送货。
-
PICKUP — 皮卡。
-
— 邮件。
-
DIGITAL — 用于数字商品。
-
UNKNOWN — 未知类型。
Enum: DELIVERY, PICKUP, POST, DIGITAL, UNKNOWN
|
|
boxesLayout
|
Type: object[]
|
barcode
|
Type: string
商店系统中货位的ID。
Example: example
|
|
boxId
|
Type: integer
箱的ID。
|
|
items
|
Type: object[]
|
id
|
Type: integer
订单中的产品ID。
参数 id 在 items.
|
|
fullCount
|
Type: integer
一个盒子里的项目数量。
Min value: 1
|
|
instances
|
Type: object[]
|
cis
|
Type: string
[识别码](*cis-regular-value) 系统中的产品单元 "诚实的标志" 或 "ASL BELGISI" （对于Yandex Go市场的卖家）。
不要转义分隔符代码中的斜杠。 \u001d
✅ 01030410947874432155Qbag！\u001d93Zjqw
❌ 01030410947874432155Qbag！\\u001d93Zjqw
根据JSON规则在其他地方转义斜杠和引号。: \\ 和 \"
Example: example
|
|
countryCode
|
Type: string
生产国采用ISO3166-1alpha-2格式。 如何获得
Min length: 2
Max length: 2
Pattern: ^[A-Z]{2}$
Example: RU
|
|
gtd
|
Type: string
货物报关。
它是由斜杠分隔的三个数字组成的字符串：XXXXXXX/XXXXXXX/XXXXXXXXXXX。
第一部分 — 登记进口货物申报的海关代码。 进一步 — 声明的日期和编号。
Example: example
|
|
rnpt
|
Type: string
品批次的注册号。
它是由斜杠分隔的四个数字组成的字符串：XXXXXXX/XXXXXXX/XXXXXXX/XXX。
第一部分 — 登记货物申报的海关办公室的代码。 进一步 — 声明的日期、编号和声明中标记产品的编号。
Example: example
|
|
uin
|
Type: string
珠宝的唯一标识号。
这是一个16位数字。
Example: example
|
传输的标记代码。
Min items: 1
Example
[
{
"cis": "example",
"uin": "example",
"rnpt": "example",
"gtd": "example",
"countryCode": "RU"
}
]
|
|
partialCount
|
Type: object
|
current
|
Type: integer
零件编号，从1开始。
Min value: 1
|
|
total
|
Type: integer
产品分成的总份数。
Min value: 2
|
盒中的产品的部分的信息。
Example
{
"current": 1,
"total": 2
}
|
箱中的产品列表。
如果盒子里有一个大的产品的一部分，列表中只能有一个项目。
Min items: 1
Example
[
{
"id": 0,
"fullCount": 1,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "example",
"uin": "example",
"rnpt": "example",
"gtd": "example",
"countryCode": "RU"
}
]
}
]
|
箱中的货物的布局。
Min items: 1
Example
[
{
"items": [
{
"id": 0,
"fullCount": 1,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{}
]
}
],
"boxId": 0,
"barcode": "example"
}
]
|
|
courier
|
Type: object
|
address
|
Type: object
|
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
|
|
gps
|
Type: object
|
latitude
|
Type: number
宽度。
|
|
longitude
|
Type: number
经度。
|
纬度和经度的GPS坐标。
Example
{
"latitude": 0.5,
"longitude": 0.5
}
|
|
house
|
Type: string
门牌号。
Example: example
|
|
postcode
|
Type: string
邮政编码。
Example: example
|
|
street
|
Type: string
街道。
Example: example
|
|
subway
|
Type: string
地铁站。
Example: example
|
送货地址。
如果参数指定 type 取值 DELIVERY, POST 或 PICKUP （仅适用于模型 DBS). 如果 类型=皮卡，返回取件点的地址。
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",
"gps": {
"latitude": 0.5,
"longitude": 0.5
}
}
|
|
region
|
Type: object
|
id
|
Type: integer
区域的ID。
|
|
name
|
Type: string
区域的名称。
Example: example
|
|
type
|
Type: string
区域的类型。
可能的值:
-
CITY_DISTRICT — 城市的面积。
-
CITY — 一个大城市。
-
CONTINENT — 大陆。
-
COUNTRY_DISTRICT — 区域。
-
COUNTRY — 国家。
-
REGION — 地区。
-
REPUBLIC_AREA — 联的主体的区。
-
REPUBLIC — 联的主体。
-
SUBWAY_STATION — 地铁站。
-
VILLAGE — 城市。
-
OTHER — 未知区域。
Enum: OTHER, CONTINENT, REGION, COUNTRY, COUNTRY_DISTRICT, REPUBLIC, CITY, VILLAGE, CITY_DISTRICT, SUBWAY_STATION, REPUBLIC_AREA
|
|
parent
|
Type: unknown
有关父区域的信息。
父区域指定到国家级别。
Example: null
|
的输送区域。
Example
{
"id": 0,
"name": "example",
"type": "OTHER",
"parent": null
}
|
关于快递的信息。
Example
{
"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",
"gps": {
"latitude": 0.5,
"longitude": 0.5
}
},
"region": {
"id": 0,
"name": "example",
"type": "OTHER",
"parent": null
}
}
|
|
dispatchType
|
Type: string
装运方法:
Enum: UNKNOWN, BUYER, MARKET_BRANDED_OUTLET, SHOP_OUTLET
|
|
estimated
|
Type: boolean
交货日期是否近似。
|
|
pickup
|
Type: object
|
address
|
Type: object
|
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
|
|
gps
|
Type: object
|
latitude
|
Type: number
宽度。
|
|
longitude
|
Type: number
经度。
|
纬度和经度的GPS坐标。
Example
{
"latitude": 0.5,
"longitude": 0.5
}
|
|
house
|
Type: string
门牌号。
Example: example
|
|
postcode
|
Type: string
邮政编码。
Example: example
|
|
street
|
Type: string
街道。
Example: example
|
|
subway
|
Type: string
地铁站。
Example: example
|
送货地址。
如果参数指定 type 取值 DELIVERY, POST 或 PICKUP （仅适用于模型 DBS). 如果 类型=皮卡，返回取件点的地址。
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",
"gps": {
"latitude": 0.5,
"longitude": 0.5
}
}
|
|
logisticPointId
|
Type: integer
取件点的ID。
使用该方法可以找到 POST v1/businesses/{businessId}/logistics-points.
Min value: 1
|
|
outletCode
|
Type: string
店分配的取件点ID。
Example: example
|
|
outletStorageLimitDate
|
Type: string<date>
订单将储存在提货点的日期。 当订单状态更改为 PICKUP.
您可以使用该方法更改日期一次 PUT v2/campaigns/{campaignId}/orders/{orderId}/delivery/storage-limit.
日期格式: YYYY-MM-DD.
Example: 2025-01-01
|
|
region
|
Type: object
|
id
|
Type: integer
区域的ID。
|
|
name
|
Type: string
区域的名称。
Example: example
|
|
type
|
Type: string
区域的类型。
可能的值:
-
CITY_DISTRICT — 城市的面积。
-
CITY — 一个大城市。
-
CONTINENT — 大陆。
-
COUNTRY_DISTRICT — 区域。
-
COUNTRY — 国家。
-
REGION — 地区。
-
REPUBLIC_AREA — 联的主体的区。
-
REPUBLIC — 联的主体。
-
SUBWAY_STATION — 地铁站。
-
VILLAGE — 城市。
-
OTHER — 未知区域。
Enum: OTHER, CONTINENT, REGION, COUNTRY, COUNTRY_DISTRICT, REPUBLIC, CITY, VILLAGE, CITY_DISTRICT, SUBWAY_STATION, REPUBLIC_AREA
|
|
parent
|
Type: unknown
有关父区域的信息。
父区域指定到国家级别。
Example: null
|
的输送区域。
Example
{
"id": 0,
"name": "example",
"type": "OTHER",
"parent": null
}
|
送到取件点的信息。
Example
{
"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",
"gps": {
"latitude": 0.5,
"longitude": 0.5
}
},
"region": {
"id": 0,
"name": "example",
"type": "OTHER",
"parent": null
},
"logisticPointId": 1,
"outletCode": "example",
"outletStorageLimitDate": "2025-01-01"
}
|
|
shipment
|
Type: object
|
shipmentDate
|
Type: string<date>
装运日期。
日期格式: YYYY-MM-DD.
Example: 2025-01-01
|
|
id
|
Type: integer | null
装运ID。
|
|
shipmentTime
|
Type: string<time> | null
装运时间。
Example: 12:00:00
|
有关订单装运的信息。
Example
{
"id": 0,
"shipmentDate": "2025-01-01",
"shipmentTime": "12:00:00"
}
|
|
tracks
|
Type: object[]
|
deliveryServiceId
|
Type: integer
送服务ID。 有关派递服务的资料，可透过要求 GET delivery/services.
|
|
trackCode
|
Type: string
包裹的轨道号码。
Example: example
|
跟踪包裹的信息。
Min items: 1
Example
[
{
"trackCode": "example",
"deliveryServiceId": 0
}
]
|
|
transfer
|
Type: object
|
courier
|
Type: object
|
fullName
|
Type: string
全名。
Example: example
|
|
phone
|
Type: string
电话号码。
Example: example
|
|
phoneExtension
|
Type: string
分机电话号码。
Example: example
|
|
vehicleDescription
|
Type: string
车辆的描述。 例如，模型和颜色。
Example: example
|
|
vehicleNumber
|
Type: string
车辆号码。
Example: example
|
关于快递员的信息。
Example
{
"fullName": "example",
"phone": "example",
"phoneExtension": "example",
"vehicleNumber": "example",
"vehicleDescription": "example"
}
|
|
eac
|
Type: object
|
eacType
|
Type: string
EAPP确认码的类型:
-
MERCHANT_TO_COURIER (暂时不退款) — 卖方将代码传送给快递员以接收非购买。
-
COURIER_TO_MERCHANT — 快递员将代码传送给卖方以接收订单。
-
CHECKING_BY_MERCHANT — 卖方检查他身边的代码。
Enum: MERCHANT_TO_COURIER, COURIER_TO_MERCHANT, CHECKING_BY_MERCHANT
|
|
eacCode
|
Type: string
EAPP确认码（适用于类型 MERCHANT_TO_COURIER).
Example: example
|
确认码的信息。
Example
{
"eacType": "MERCHANT_TO_COURIER",
"eacCode": "example"
}
|
有关快递员和确认码的信息。
Example
{
"courier": {
"fullName": "example",
"phone": "example",
"phoneExtension": "example",
"vehicleNumber": "example",
"vehicleDescription": "example"
},
"eac": {
"eacType": "MERCHANT_TO_COURIER",
"eacCode": "example"
}
}
|
|
warehouseId
|
Type: string
为其下订单的商店系统中仓库的ID。
Example: example
|
订单配送信息。
Example
{
"type": "DELIVERY",
"serviceName": "example",
"deliveryServiceId": 0,
"warehouseId": "example",
"deliveryPartnerType": "SHOP",
"dispatchType": "UNKNOWN",
"dates": {
"fromDate": "2025-01-01",
"toDate": "2025-01-01",
"fromTime": "12:00:00",
"toTime": "12:00:00",
"realDeliveryDate": "2025-01-01"
},
"shipment": {
"id": 0,
"shipmentDate": "2025-01-01",
"shipmentTime": "12:00:00"
},
"courier": {
"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",
"gps": {
"latitude": 0.5,
"longitude": 0.5
}
},
"region": {
"id": 0,
"name": "example",
"type": "OTHER",
"parent": null
}
},
"pickup": {
"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",
"gps": {
"latitude": 0.5,
"longitude": 0.5
}
},
"region": {
"id": 0,
"name": "example",
"type": "OTHER",
"parent": null
},
"logisticPointId": 1,
"outletCode": "example",
"outletStorageLimitDate": "2025-01-01"
},
"transfer": {
"courier": {
"fullName": "example",
"phone": "example",
"phoneExtension": "example",
"vehicleNumber": "example",
"vehicleDescription": "example"
},
"eac": {
"eacType": "MERCHANT_TO_COURIER",
"eacCode": "example"
}
},
"boxesLayout": [
{
"items": [
{
"id": 0,
"fullCount": 1,
"partialCount": {},
"instances": [
null
]
}
],
"boxId": 0,
"barcode": "example"
}
],
"tracks": [
{
"trackCode": "example",
"deliveryServiceId": 0
}
],
"estimated": true
}
|
|
fake
|
Type: boolean
订单类型:
-
false — 真正的客户的订单。
-
true — 测试订单 燕基科斯. 市场。
|
|
items
|
Type: object[]
|
count
|
Type: integer
积单元的数量。
|
|
id
|
Type: integer
订单中的产品ID。
允许您在订单中识别产品。
|
|
offerId
|
Type: string
你的 SKU — 系统中的产品ID。
使用规则 SKU:
SKU 产品可以在市场上的卖方帐户中更改。 阅读如何做到这一点。 在市场对卖家的帮助.
重要
值开头和结尾的空格会自动删除。 例如, " SKU123 " 和 "SKU123" 它们将被视为相同的值。
什么是 SKU 以及如何分配它
Min length: 1
Max length: 255
Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$
Example: example
|
|
offerName
|
Type: string
产品名称。
Example: example
|
|
instances
|
Type: object[]
|
cis
|
Type: string
系统中的单元识别码 "诚实的标志" 没有密码或 "ASL BELGISI" （对于Yandex Go市场的卖家）。
Example: example
|
|
cisFull
|
Type: string
系统中的单元识别码 "诚实的标志" 用密码锁。
Example: example
|
|
countryCode
|
Type: string
生产国采用ISO3166-1alpha-2格式。 如何获得
Min length: 2
Max length: 2
Pattern: ^[A-Z]{2}$
Example: RU
|
|
gtd
|
Type: string
货物报关。
它是由斜杠分隔的三个数字组成的字符串：XXXXXXX/XXXXXXX/XXXXXXXXXXX。
第一部分 — 登记进口货物申报的海关代码。 进一步 — 声明的日期和编号。
Example: example
|
|
rnpt
|
Type: string
品批次的注册号。
它是由斜杠分隔的四个数字组成的字符串：XXXXXXX/XXXXXXX/XXXXXXX/XXX。
第一部分 — 登记货物申报的海关办公室的代码。 进一步 — 声明的日期、编号和声明中标记产品的编号。
Example: example
|
|
uin
|
Type: string
珠宝的UIN(16位数字代码)
当制造商在贵金属和宝石的周转控制系统中注册产品时，他会获得胜利。 — GIIS DMDK。
Example: example
|
品单元的标签的信息。
将返回请求中传递的标记数据:
为 FBY 在交付过程中传输的标记代码被返回.
如果商店尚未发送此订单的代码, instances 缺席。
Min items: 1
Example
[
{
"cis": "example",
"cisFull": "example",
"uin": "example",
"rnpt": "example",
"gtd": "example",
"countryCode": "RU"
}
]
|
|
prices
|
Type: object
|
cashback
|
Type: object
|
currencyId
|
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
|
|
value
|
Type: number
意义。
|
货币及其价值。
Example
{
"value": 0.5,
"currencyId": "RUR"
}
|
|
payment
|
Type: object
|
currencyId
|
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
|
|
value
|
Type: number
意义。
|
货币及其价值。
Example
{
"value": 0.5,
"currencyId": "RUR"
}
|
|
subsidy
|
Type: object
|
currencyId
|
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
|
|
value
|
Type: number
意义。
|
货币及其价值。
Example
{
"value": 0.5,
"currencyId": "RUR"
}
|
|
vat
|
Type: string
产品或交付的增值税:
-
NO_VAT — 增值税不收取，它仅用于某些类型的服务。
-
VAT_0 — 0%增值税。 例如，它用于销售在出口海关程序中出口的货物，或为国际货物运输提供服务。
-
VAT_10 — 10%增值税。 例如，它用于销售某些食品和医疗产品。
-
VAT_10_110 — 增值税 10/110. 10%增值税，仅适用于预付款。
-
VAT_20 — 增值税20%。 基本增值税从2019年到2026年1月1日。
-
VAT_20_120 — 增值税 20/120. 增值税为20％，仅适用于预付款。
-
VAT_18 — 增值税18%。 基本增值税至2019年。
-
VAT_18_118 — 增值税 18/118. 增值税用于预付款，直到2019年1月1日。
-
VAT_12 — 增值税是12％。 它仅在乌兹别克斯坦使用。
-
VAT_05 — 增值税是5％。 简化税制（USN）的增值税。
-
VAT_07 — 增值税是7％。 简化税制（USN）的增值税。
-
VAT_22 — 增值税是22％。 基本增值税从2026年1月1日开始。
-
UNKNOWN_VALUE — 未知类型。
Enum: NO_VAT, VAT_0, VAT_10, VAT_10_110, VAT_20, VAT_20_120, VAT_18, VAT_18_118, VAT_12, VAT_05, VAT_07, VAT_22, UNKNOWN_VALUE
|
有关付款和奖励的信息。
所有单位货物的成本和对卖方的报酬是如何计算的?
- 产品的所有单位的成本由参数组成
payment 和 cashback.
- 在参数中返回给卖家的奖励总额
subsidy.
- 意义
payment, cashback 和 subsidy 它可能与目录价格不同，因为有关商店促销的信息不会返回。
- 如果订单中有多个项目，则在参数中返回总价值。
- 所有金额均以商店的货币表示。
Example
{
"payment": {
"value": 0.5,
"currencyId": "RUR"
},
"subsidy": {
"value": 0.5,
"currencyId": "RUR"
},
"cashback": {
"value": 0.5,
"currencyId": "RUR"
},
"vat": "NO_VAT"
}
|
|
requiredInstanceTypes
|
Type: string[] | null
所需产品标记的列表。
Min items: 1
Unique items: true
Example |
|
tags
|
Type: string[] | null
产品属性。
Min items: 1
Unique items: true
Example |
订单中的产品列表。
Example
[
{
"id": 0,
"offerId": "example",
"offerName": "example",
"count": 0,
"prices": {
"payment": {
"value": 0.5,
"currencyId": "RUR"
},
"subsidy": {
"value": 0.5,
"currencyId": "RUR"
},
"cashback": {
"value": 0.5,
"currencyId": "RUR"
},
"vat": "NO_VAT"
},
"instances": [
{
"cis": "example",
"cisFull": "example",
"uin": "example",
"rnpt": "example",
"gtd": "example",
"countryCode": "RU"
}
],
"requiredInstanceTypes": [
"CIS"
],
"tags": [
"ULTIMA"
]
}
]
|
|
orderId
|
Type: integer
的订单ID。
|
|
paymentMethod
|
Type: string
订购付款方法:
默认值: CASH_ON_DELIVERY.
Enum: CASH_ON_DELIVERY, CARD_ON_DELIVERY, BOUND_CARD_ON_DELIVERY, BNPL_BANK_ON_DELIVERY, BNPL_ON_DELIVERY, YANDEX, APPLE_PAY, EXTERNAL_CERTIFICATE, CREDIT, GOOGLE_PAY, TINKOFF_CREDIT, SBP, TINKOFF_INSTALLMENTS, B2B_ACCOUNT_PREPAYMENT, B2B_ACCOUNT_POSTPAYMENT, UNKNOWN
|
|
paymentType
|
Type: string
订购付款类别:
-
PREPAID — 结账时付款。
-
POSTPAID — 在收到订单后付款。
-
UNKNOWN — 未知类型。
如果省略此参数，订单将在收到时支付。
Enum: PREPAID, POSTPAID, UNKNOWN
|
|
status
|
Type: string
订单状况:
也可以返回其他值。 您不需要处理它们。
Enum: PLACING, RESERVED, UNPAID, PROCESSING, DELIVERY, PICKUP, DELIVERED, CANCELLED, PENDING, PARTIALLY_RETURNED, RETURNED, UNKNOWN
|
|
substatus
|
Type: string
订单处理阶段（状态 PROCESSING）或取消订单的原因（状态 CANCELLED).
也可以返回其他值。 您不需要处理它们。
Enum: RESERVATION_EXPIRED, USER_NOT_PAID, USER_UNREACHABLE, USER_CHANGED_MIND, USER_REFUSED_DELIVERY, USER_REFUSED_PRODUCT, SHOP_FAILED, USER_REFUSED_QUALITY, REPLACING_ORDER, PROCESSING_EXPIRED, PENDING_EXPIRED, SHOP_PENDING_CANCELLED, PENDING_CANCELLED, USER_FRAUD, RESERVATION_FAILED, USER_PLACED_OTHER_ORDER, USER_BOUGHT_CHEAPER, MISSING_ITEM, BROKEN_ITEM, WRONG_ITEM, PICKUP_EXPIRED, DELIVERY_PROBLEMS, LATE_CONTACT, CUSTOM, DELIVERY_SERVICE_FAILED, WAREHOUSE_FAILED_TO_SHIP, DELIVERY_SERVICE_UNDELIVERED, PREORDER, AWAIT_CONFIRMATION, STARTED, PACKAGING, READY_TO_SHIP, SHIPPED, ASYNC_PROCESSING, WAITING_USER_INPUT, WAITING_BANK_DECISION, BANK_REJECT_CREDIT_OFFER, CUSTOMER_REJECT_CREDIT_OFFER, CREDIT_OFFER_FAILED, AWAIT_DELIVERY_DATES_CONFIRMATION, SERVICE_FAULT, DELIVERY_SERVICE_RECEIVED, USER_RECEIVED, WAITING_FOR_STOCKS, AS_PART_OF_MULTI_ORDER, READY_FOR_LAST_MILE, LAST_MILE_STARTED, ANTIFRAUD, DELIVERY_USER_NOT_RECEIVED, DELIVERY_SERVICE_DELIVERED, DELIVERED_USER_NOT_RECEIVED, USER_WANTED_ANOTHER_PAYMENT_METHOD, USER_RECEIVED_TECHNICAL_ERROR, USER_FORGOT_TO_USE_BONUS, DELIVERY_SERVICE_NOT_RECEIVED, DELIVERY_SERVICE_LOST, SHIPPED_TO_WRONG_DELIVERY_SERVICE, DELIVERED_USER_RECEIVED, WAITING_TINKOFF_DECISION, COURIER_SEARCH, COURIER_FOUND, COURIER_IN_TRANSIT_TO_SENDER, COURIER_ARRIVED_TO_SENDER, COURIER_RECEIVED, COURIER_NOT_FOUND, COURIER_NOT_DELIVER_ORDER, COURIER_RETURNS_ORDER, COURIER_RETURNED_ORDER, WAITING_USER_DELIVERY_INPUT, PICKUP_SERVICE_RECEIVED, PICKUP_USER_RECEIVED, CANCELLED_COURIER_NOT_FOUND, COURIER_NOT_COME_FOR_ORDER, DELIVERY_NOT_MANAGED_REGION, INCOMPLETE_CONTACT_INFORMATION, INCOMPLETE_MULTI_ORDER, INAPPROPRIATE_WEIGHT_SIZE, TECHNICAL_ERROR, SORTING_CENTER_LOST, COURIER_SEARCH_NOT_STARTED, LOST, AWAIT_PAYMENT, AWAIT_LAVKA_RESERVATION, USER_WANTS_TO_CHANGE_ADDRESS, FULL_NOT_RANSOM, PRESCRIPTION_MISMATCH, DROPOFF_LOST, DROPOFF_CLOSED, DELIVERY_TO_STORE_STARTED, USER_WANTS_TO_CHANGE_DELIVERY_DATE, WRONG_ITEM_DELIVERED, DAMAGED_BOX, AWAIT_DELIVERY_DATES, LAST_MILE_COURIER_SEARCH, PICKUP_POINT_CLOSED, LEGAL_INFO_CHANGED, USER_HAS_NO_TIME_TO_PICKUP_ORDER, DELIVERY_CUSTOMS_ARRIVED, DELIVERY_CUSTOMS_CLEARED, FIRST_MILE_DELIVERY_SERVICE_RECEIVED, AWAIT_AUTO_DELIVERY_DATES, AWAIT_USER_PERSONAL_DATA, NO_PERSONAL_DATA_EXPIRED, CUSTOMS_PROBLEMS, AWAIT_CASHIER, WAITING_POSTPAID_BUDGET_RESERVATION, AWAIT_SERVICEABLE_CONFIRMATION, POSTPAID_BUDGET_RESERVATION_FAILED, AWAIT_CUSTOM_PRICE_CONFIRMATION, READY_FOR_PICKUP, TOO_MANY_DELIVERY_DATE_CHANGES, TOO_LONG_DELIVERY, DEFERRED_PAYMENT, POSTPAID_FAILED, INCORRECT_PERSONAL_DATA, UNKNOWN
|
|
buyerType
|
Type: string
买方类型:
-
PERSON — 一个自然人。
-
BUSINESS — 组织。
Enum: PERSON, BUSINESS
|
|
cancelRequested
|
Type: boolean
只适用于型号 DBS
是否已要求取消。
|
|
externalOrderId
|
Type: string
您提交的订单的外部ID POST v2/campaigns/{campaignId}/orders/{orderId}/external-id.
Min length: 1
Example: example
|
|
notes
|
Type: string
对订单进行评论。
Example: example
|
|
prices
|
Type: object
|
cashback
|
Type: object
|
currencyId
|
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
|
|
value
|
Type: number
意义。
|
货币及其价值。
Example
{
"value": 0.5,
"currencyId": "RUR"
}
|
|
delivery
|
Type: object
|
payment
|
Type: object
|
currencyId
|
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
|
|
value
|
Type: number
意义。
|
货币及其价值。
Example
{
"value": 0.5,
"currencyId": "RUR"
}
|
|
subsidy
|
Type: object
|
currencyId
|
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
|
|
value
|
Type: number
意义。
|
货币及其价值。
Example
{
"value": 0.5,
"currencyId": "RUR"
}
|
|
vat
|
Type: string
产品或交付的增值税:
-
NO_VAT — 增值税不收取，它仅用于某些类型的服务。
-
VAT_0 — 0%增值税。 例如，它用于销售在出口海关程序中出口的货物，或为国际货物运输提供服务。
-
VAT_10 — 10%增值税。 例如，它用于销售某些食品和医疗产品。
-
VAT_10_110 — 增值税 10/110. 10%增值税，仅适用于预付款。
-
VAT_20 — 增值税20%。 基本增值税从2019年到2026年1月1日。
-
VAT_20_120 — 增值税 20/120. 增值税为20％，仅适用于预付款。
-
VAT_18 — 增值税18%。 基本增值税至2019年。
-
VAT_18_118 — 增值税 18/118. 增值税用于预付款，直到2019年1月1日。
-
VAT_12 — 增值税是12％。 它仅在乌兹别克斯坦使用。
-
VAT_05 — 增值税是5％。 简化税制（USN）的增值税。
-
VAT_07 — 增值税是7％。 简化税制（USN）的增值税。
-
VAT_22 — 增值税是22％。 基本增值税从2026年1月1日开始。
-
UNKNOWN_VALUE — 未知类型。
Enum: NO_VAT, VAT_0, VAT_10, VAT_10_110, VAT_20, VAT_20_120, VAT_18, VAT_18_118, VAT_12, VAT_05, VAT_07, VAT_22, UNKNOWN_VALUE
|
有关交付成本的信息，包括上到地板。
运费如何计算？
- 运费由以下参数组成
payment 和 subsidy.
- 所有金额均以商店的货币表示。
Example
{
"payment": {
"value": 0.5,
"currencyId": "RUR"
},
"subsidy": {
"value": 0.5,
"currencyId": "RUR"
},
"vat": "NO_VAT"
}
|
|
payment
|
Type: object
|
currencyId
|
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
|
|
value
|
Type: number
意义。
|
货币及其价值。
Example
{
"value": 0.5,
"currencyId": "RUR"
}
|
|
subsidy
|
Type: object
|
currencyId
|
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
|
|
value
|
Type: number
意义。
|
货币及其价值。
Example
{
"value": 0.5,
"currencyId": "RUR"
}
|
有关订单成本的信息。
如何计算订单、交货和卖方报酬的成本?
- 订单中货物的成本由参数组成
payment 和 cashback.
- 在参数中返回给卖家的奖励总额
subsidy.
- 意义
payment, cashback 和 subsidy 它可能与目录中的价格不同，因为有关商店促销的信息不会返回。
- 交付成本由参数组成
payment 和 subsidy 在 delivery.
- 所有金额均以商店的货币表示。
Example
{
"payment": {
"value": 0.5,
"currencyId": "RUR"
},
"subsidy": {
"value": 0.5,
"currencyId": "RUR"
},
"cashback": {
"value": 0.5,
"currencyId": "RUR"
},
"delivery": {
"payment": {
"value": 0.5,
"currencyId": "RUR"
},
"subsidy": {
"value": 0.5,
"currencyId": "RUR"
},
"vat": "NO_VAT"
}
}
|
|
programType
|
Type: string
工作模式:
FBY — FBY.FBS — FBS.DBS — DBS.EXPRESS — Express.
Enum: FBY, FBS, DBS, EXPRESS, LAAS
|
|
services
|
Type: object
|
liftType
|
Type: string
将订单提升到地板的类型:
Enum: NOT_NEEDED, MANUAL, ELEVATOR, CARGO_ELEVATOR, FREE, UNKNOWN
|
添加到订单中的服务。
Example
{
"liftType": "NOT_NEEDED"
}
|
|
updateDate
|
Type: string<date-time>
上次订单更新的日期和时间。
日期格式: ISO 8601 具有相对于 UTC.
Example: 2020-02-02T14:30:30+03:00
|
内阁的订单清单。
Max items: 50
Example
[
{
"orderId": 0,
"campaignId": 1,
"programType": "FBY",
"externalOrderId": "example",
"status": "PLACING",
"substatus": "RESERVATION_EXPIRED",
"creationDate": "2020-02-02T14:30:30+03:00",
"updateDate": "2020-02-02T14:30:30+03:00",
"paymentType": "PREPAID",
"paymentMethod": "CASH_ON_DELIVERY",
"fake": true,
"items": [
{
"id": 0,
"offerId": "example",
"offerName": "example",
"count": 0,
"prices": {
"payment": {},
"subsidy": {},
"cashback": {},
"vat": "NO_VAT"
},
"instances": [
{}
],
"requiredInstanceTypes": [
"CIS"
],
"tags": [
"ULTIMA"
]
}
],
"prices": {
"payment": {
"value": 0.5,
"currencyId": "RUR"
},
"subsidy": {
"value": 0.5,
"currencyId": "RUR"
},
"cashback": {
"value": 0.5,
"currencyId": "RUR"
},
"delivery": {
"payment": {
"value": 0.5,
"currencyId": "RUR"
},
"subsidy": {
"value": 0.5,
"currencyId": "RUR"
},
"vat": "NO_VAT"
}
},
"delivery": {
"type": "DELIVERY",
"serviceName": "example",
"deliveryServiceId": 0,
"warehouseId": "example",
"deliveryPartnerType": "SHOP",
"dispatchType": "UNKNOWN",
"dates": {
"fromDate": "2025-01-01",
"toDate": "2025-01-01",
"fromTime": "12:00:00",
"toTime": "12:00:00",
"realDeliveryDate": "2025-01-01"
},
"shipment": {
"id": 0,
"shipmentDate": "2025-01-01",
"shipmentTime": "12:00:00"
},
"courier": {
"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",
"gps": {}
},
"region": {
"id": 0,
"name": "example",
"type": "OTHER",
"parent": null
}
},
"pickup": {
"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",
"gps": {}
},
"region": {
"id": 0,
"name": "example",
"type": "OTHER",
"parent": null
},
"logisticPointId": 1,
"outletCode": "example",
"outletStorageLimitDate": "2025-01-01"
},
"transfer": {
"courier": {
"fullName": "example",
"phone": "example",
"phoneExtension": "example",
"vehicleNumber": "example",
"vehicleDescription": "example"
},
"eac": {
"eacType": "MERCHANT_TO_COURIER",
"eacCode": "example"
}
},
"boxesLayout": [
{
"items": [
null
],
"boxId": 0,
"barcode": "example"
}
],
"tracks": [
{
"trackCode": "example",
"deliveryServiceId": 0
}
],
"estimated": true
},
"services": {
"liftType": "NOT_NEEDED"
},
"buyerType": "PERSON",
"notes": "example",
"cancelRequested": true
}
]
|