订单的详细信息
方法适用于所有模式.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
返回市场上包含您的产品的订单信息。
你可以用它来收集你的订单的统计数字,例如,哪些产品最常被顾客退回,而哪些产品则是需求量很大的,等等。
有关已创建或更新订单的信息可能会出现,最长延迟为40分钟。
要无延迟地获取数据,请使用以下方法 GET v2/campaigns/{campaignId}/orders 或 POST v1/businesses/{businessId}/orders.
您可以在一个请求中获得最多200个订单的信息。
| ⚙️ 限制: 每小时1,000,000份订单 |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/stats/orders
Path parameters
|
Name |
Description |
|
campaignId* |
Type: integer<int64> 活动ID。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 不要发送商店ID,这是在市场上的卖家帐户旁边的商店名称和一些报告。
Min value: |
Query parameters
|
Name |
Description |
|
limit |
Type: integer<int32> 每页的值数。
Min value: |
|
page_token |
Type: string 结果页面的ID。 如果省略该参数,则返回第一页。 我们建议传输输出参数的值 如果设置 |
Body
application/json
{
"dateFrom": "string",
"dateTo": "string",
"updateFrom": "string",
"updateTo": "string",
"orders": [
0
],
"statuses": [
"CANCELLED_BEFORE_PROCESSING"
],
"hasCis": false
}
|
Name |
Description |
|
dateFrom |
Type: string<date> 生成订单的初始日期。 日期格式: 不能与参数一起使用 |
|
dateTo |
Type: string<date> 生成订单的结束日期。 日期格式: 不能与参数一起使用 |
|
hasCis |
Type: boolean 用于接收系统中包含至少一个带有识别码的产品的订单的过滤器。 «Честный ЗНАК» 或 «ASL BELGISI» (对于卖家 Market Yandex Go):
|
|
orders |
Type: integer[] 订单Id列表。 在订单处理过程中,市场可以从中删除商品。 — 在仓库或在用户的主动问题的情况下。
Min items: Unique items |
|
statuses |
Type: string[] 订单状态列表。
Enum: Min items: Unique items |
|
updateFrom |
Type: string<date> 对订单进行更改的期间的开始日期(例如,状态或付款信息)。 日期格式: 不能与参数一起使用 |
|
updateTo |
Type: string<date> 更改订单的期间的结束日期(例如,状态或付款信息)。 日期格式: 不能与参数一起使用 |
Responses
200 OK
关于订单的信息。
Body
application/json
{
"status": "OK",
"result": {
"orders": [
{
"id": 0,
"creationDate": "string",
"statusUpdateDate": "2022-12-29T18:02:01Z",
"status": "CANCELLED_BEFORE_PROCESSING",
"partnerOrderId": "string",
"paymentType": "POSTPAID",
"fake": false,
"deliveryRegion": {
"id": 0,
"name": "string"
},
"items": [
{
"offerName": "string",
"marketSku": 0,
"shopSku": "string",
"count": 0,
"prices": [
{
"type": "BUYER",
"costPerItem": 0,
"total": 0
}
],
"warehouse": {
"id": 0,
"name": "string"
},
"details": [
{
"itemStatus": "REJECTED",
"itemCount": 0,
"updateDate": "string",
"stockType": "FIT"
}
],
"cisList": [
"string"
],
"initialCount": 0,
"bidFee": 570,
"cofinanceThreshold": 0,
"cofinanceValue": 0
}
],
"initialItems": [
{
"offerName": "string",
"marketSku": 0,
"shopSku": "string",
"count": 0,
"prices": [
{
"type": "BUYER",
"costPerItem": 0,
"total": 0
}
],
"warehouse": {
"id": 0,
"name": "string"
},
"details": [
{
"itemStatus": "REJECTED",
"itemCount": 0,
"updateDate": "string",
"stockType": "FIT"
}
],
"cisList": [
"string"
],
"initialCount": 0,
"bidFee": 570,
"cofinanceThreshold": 0,
"cofinanceValue": 0
}
],
"payments": [
{
"id": "string",
"date": "string",
"type": "PAYMENT",
"source": "BUYER",
"total": 0,
"paymentOrder": {
"id": "string",
"date": "string"
}
}
],
"commissions": [
{
"type": "FEE",
"actual": 0
}
],
"subsidies": [
{
"operationType": "ACCRUAL",
"type": "YANDEX_CASHBACK",
"amount": 0
}
],
"buyerType": "PERSON",
"currency": "RUR"
}
],
"paging": {
"nextPageToken": "string"
}
}
}
|
Name |
Description |
||||||
|
status* |
Type: string 响应的类型。 可能的值:
Enum: |
||||||
|
result |
Type: object
关于订单的信息。 |
400 Bad Request
请求包含不正确的数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
401 Unauthorized
请求中未指定授权数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
404 Not Found
找不到请求的资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
500 Internal Server Error
市场的内部错误。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
No longer supported, please use an alternative and newer version.