有关柜内订单的信息
方法适用于模式：FBY, FBS, Express 和 DBS.
如果您使用API-Key令牌，调用该方法时需要具备列表中可用权限之一
返回商家配置文件中有关订单的信息。 查询可用于跟踪订单及其状态。
您还可以设置API通知。
燕基科斯.市场会送你 请求 当新订单出现或其状态发生变化时。 使用这种方法可以获得完整的信息。, GET v2/campaigns/{campaignId}/orders/{orderId} 或 GET v2/campaigns/{campaignId}/orders.
可按参数过滤:
-
订单的日期。
-
订单更新的日期和时间;
-
装运日期;
-
订单状态(
statuses); -
处理阶段或取消原因（
substatuses); -
活动Id;
-
订单Id;
-
外部订单Id;
-
订单类型（真实或测试）;
-
买方类型;
-
就业模式;
-
客户要求取消订单的可用性.
每个请求的最大日期范围 — 30天（在参数中传递 fromDate 和 toDate). 如果没有传输，则返回过去30天的信息。
结果逐页返回。 要导航，请使用参数 page_token 和 limit.
您可以通过请求获取有关买家及其电话号码的更多详细信息 GET v2/campaigns/{campaignId}/orders/{orderId}/buyer.
参数的限制 limit
不要传输大于50的值。
| ⚙️ 限制: 每小时10,000次请求 |
|---|
Request
POST
https://api.partner.market.yandex.ru/v1/businesses/{businessId}/orders
Path parameters
|
Name |
Description |
|
businessId* |
Type: integer<int64> 内阁ID。 要找到答案，请使用请求 GET v2/campaigns. Min value: |
Query parameters
|
Name |
Description |
|
limit |
Type: integer<int32> 每页的值数。
Min value: |
|
page_token |
Type: string 结果页面的ID。 如果省略该参数，则返回第一页。 我们建议传输输出参数的值 如果设置 |
Body
application/json
{
"orderIds": [
0
],
"externalOrderIds": [
"string"
],
"programTypes": [
"FBY"
],
"campaignIds": [
0
],
"statuses": [
"PLACING"
],
"substatuses": [
"RESERVATION_EXPIRED"
],
"dates": {
"creationDateFrom": "string",
"creationDateTo": "string",
"shipmentDateFrom": "string",
"shipmentDateTo": "string",
"updateDateFrom": "2022-12-29T18:02:01Z",
"updateDateTo": "2022-12-29T18:02:01Z"
},
"fake": false,
"waitingForCancellationApprove": false
}
|
Name |
Description |
||||||||||||
|
campaignIds |
Type: integer[] 活动Id。 Min items: Max items: Unique items |
||||||||||||
|
dates |
Type: object
按订单日期筛选。 |
||||||||||||
|
externalOrderIds |
Type: string[] 外部订单Id。 Min length: Min items: Max items: Unique items |
||||||||||||
|
fake |
Type: boolean 订单类型:
|
||||||||||||
|
orderIds |
Type: integer[] 订单Id。 Min items: Max items: Unique items |
||||||||||||
|
programTypes |
Type: string[] 商店在市场上的运作模式。
Enum: Min items: Unique items |
||||||||||||
|
statuses |
Type: string[] 订单状态。
也可以返回其他值。 您不需要处理它们。 Enum: Min items: Unique items |
||||||||||||
|
substatuses |
Type: string[] 处理阶段或取消订单的原因。
也可以返回其他值。 您不需要处理它们。 Enum: Min items: Unique items |
||||||||||||
|
waitingForCancellationApprove |
Type: boolean 只适用于型号 DBS 用于接收具有取消请求的订单的过滤器。 与值 |
Responses
200 OK
内阁的订单清单。
Body
application/json
{
"orders": [
{
"orderId": 0,
"campaignId": 0,
"programType": "FBY",
"externalOrderId": "string",
"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": false,
"items": [
{
"id": 0,
"offerId": "string",
"offerName": "string",
"count": 0,
"prices": {
"payment": {
"value": 0,
"currencyId": "RUR"
},
"subsidy": {
"value": 0,
"currencyId": "RUR"
},
"cashback": {
"value": 0,
"currencyId": "RUR"
},
"vat": "NO_VAT"
},
"instances": [
{
"cis": "string",
"cisFull": "string",
"uin": "string",
"rnpt": "string",
"gtd": "string",
"countryCode": "RU"
}
],
"requiredInstanceTypes": [
"CIS"
],
"tags": [
"ULTIMA"
]
}
],
"prices": {
"payment": {
"value": 0,
"currencyId": "RUR"
},
"subsidy": {
"value": 0,
"currencyId": "RUR"
},
"cashback": {
"value": 0,
"currencyId": "RUR"
},
"delivery": {
"payment": {
"value": 0,
"currencyId": "RUR"
},
"subsidy": {
"value": 0,
"currencyId": "RUR"
},
"vat": "NO_VAT"
}
},
"delivery": {
"type": "DELIVERY",
"serviceName": "string",
"deliveryServiceId": 0,
"warehouseId": "string",
"deliveryPartnerType": "SHOP",
"dispatchType": "UNKNOWN",
"dates": {
"fromDate": "string",
"toDate": "string",
"fromTime": "string",
"toTime": "string",
"realDeliveryDate": "string"
},
"shipment": {
"id": 0,
"shipmentDate": "string",
"shipmentTime": "string"
},
"courier": {
"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",
"gps": {
"latitude": 0,
"longitude": 0
}
},
"region": {
"id": 0,
"name": "string",
"type": "OTHER"
}
},
"pickup": {
"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",
"gps": {
"latitude": 0,
"longitude": 0
}
},
"region": {
"id": 0,
"name": "string",
"type": "OTHER"
},
"logisticPointId": 0,
"outletCode": "string",
"outletStorageLimitDate": "string"
},
"transfer": {
"courier": {
"fullName": "string",
"phone": "string",
"phoneExtension": "string",
"vehicleNumber": "string",
"vehicleDescription": "string"
},
"eac": {
"eacType": "MERCHANT_TO_COURIER",
"eacCode": "string"
}
},
"boxesLayout": [
{
"items": [
{
"id": 0,
"fullCount": 0,
"partialCount": {
"current": 0,
"total": 0
},
"instances": [
{
"cis": "string",
"uin": "string",
"rnpt": "string",
"gtd": "string",
"countryCode": "RU"
}
]
}
],
"boxId": 0,
"barcode": "string"
}
],
"tracks": [
{
"trackCode": "string",
"deliveryServiceId": 0
}
],
"estimated": false
},
"services": {
"liftType": "NOT_NEEDED"
},
"buyerType": "PERSON",
"notes": "string",
"cancelRequested": false
}
],
"paging": {
"nextPageToken": "string"
}
}
|
Name |
Description |
||
|
orders* |
Type: object[] 内阁的订单清单。 Max items: |
||
|
paging |
Type: object
下一页的ID。 |
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.
安全标签有助于防止产品在退货时被更换。 如果没有购买时存在的保护标签，您将无法退回产品。