有关商店订单的信息
方法适用于模式:FBY, FBS, Express 和 DBS.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
返回有关商店中订单的信息。 查询可用于跟踪订单及其状态。
默认情况下,不会接收有关测试订单的数据。 要获取它们,请传递值 true 在参数中 fake.
您还可以设置API通知。
燕基科斯.市场会送你 请求 当新订单出现或其状态发生变化时。 使用这种方法可以获得完整的信息。, GET v2/campaigns/{campaignId}/orders/{orderId} 或 POST v1/businesses/{businessId}/orders.
可按参数过滤:
-
订单的日期。
-
订单更新的日期和时间;
-
装运日期;
-
订单状态(
statuses); -
处理阶段或取消原因(
substatuses); -
订单Id;
-
订单的类型(真实或测试)。
有关超过30天前交付或取消的订单的信息将不予退还。 如何获得:
- GET v2/campaigns/{campaignId}/orders/{orderId},如果有订单ID。
- POST v2/campaigns/{campaignId}/stats/orders.
每个请求的最大日期范围 — 30天(在参数中传递 fromDate 和 toDate). 如果没有传输,则返回过去30天的信息。
结果逐页返回。 要导航,请使用参数 page_token 和 limit.
您可以通过请求获取有关买家及其电话号码的更多详细信息 GET v2/campaigns/{campaignId}/orders/{orderId}/buyer.
参数的限制 limit
不要传输大于50的值。
| ⚙️ 限制: 每小时100,000次请求 |
|---|
Request
GET
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/orders
Path parameters
|
Name |
Description |
|
campaignId* |
Type: integer<int64> 活动ID。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 不要发送商店ID,这是在市场上的卖家帐户旁边的商店名称和一些报告。
Min value: |
Query parameters
|
Name |
Description |
|
buyerType |
Type: string 按客户类型过滤订单。
Enum: |
|
dispatchType |
Type: string 装运方法
Enum: |
|
fake |
Type: boolean 按类型过滤订单:
Default: |
|
fromDate |
Type: string<date> 按结帐日期筛选订单的开始日期。 日期格式: 开始和结束日期之间(参数 默认值:从当前日期起30天前. |
|
hasCis |
Type: boolean 用于接收系统中包含至少一个带有识别码的产品的订单的过滤器。 «Честный ЗНАК» 或 «ASL BELGISI» (对于卖家 Market Yandex Go):
这些代码被分配给需要贴标签并属于某些类别的产品。
Default: |
|
limit |
Type: integer<int32> 每页的值数。
Min value: |
|
onlyEstimatedDelivery |
Type: boolean 按已确认的交货日期过滤长交货(31-60天)的订单:
Default: |
|
onlyWaitingForCancellationApprove |
Type: boolean 只适用于型号 DBS 用于接收有取消请求的订单的过滤器。 与值 要确认或拒绝取消,请发送请求 PUT v2/campaigns/{campaignId}/orders/{orderId}/cancellation/accept.
Default: |
|
orderIds |
Type: integer[] 按Id过滤订单。
Min items: Max items: |
|
page |
Type: integer<int32> 如果方法有 用它代替参数 结果页的编号。 与参数一起使用
Default: Max value: |
|
pageSize |
Type: integer<int32> 页面大小。 与参数一起使用
|
|
page_token |
Type: string 结果页面的ID。 如果省略该参数,则返回第一页。 我们建议传输输出参数的值 如果设置 |
|
status |
Type: string[] 订单状况:
也可以返回其他值。 您不需要处理它们。 Enum: Unique items |
|
substatus |
Type: string[] 订单处理阶段(状态 状态中订单的可能值
状态中订单的可能值
也可以返回其他值。 您不需要处理它们。 Enum: Unique items |
|
supplierShipmentDateFrom |
Type: string<date> 按发货到送货服务的日期筛选订单的开始日期(参数 日期格式: 开始和结束日期之间(参数 开始日期包含在筛选的间隔中。 |
|
supplierShipmentDateTo |
Type: string<date> 按发货到送货服务的日期筛选订单的结束日期(参数 日期格式: 在初始(参数 结束日期不包括在过滤间隔中。 如果之间的时间间隔 |
|
toDate |
Type: string<date> 按结帐日期筛选订单的结束日期。 显示指定日期00:00之前创建的订单。 日期格式: 在初始(参数 默认值:当前日期。 如果之间的时间间隔 |
|
updatedAtFrom |
Type: string<date-time> 按更新日期和时间筛选订单的开始日期(参数 日期格式: ISO 8601 具有相对于 UTC. 例如, 开始和结束日期之间(参数 开始日期包含在筛选的间隔中。 |
|
updatedAtTo |
Type: string<date-time> 按更新日期和时间筛选订单的结束日期(参数 日期格式: ISO 8601 具有相对于 UTC. 例如, 在初始(参数 结束日期不包括在过滤间隔中。 |
Responses
200 OK
有关订单的信息。
Body
application/json
{
"pager": {
"total": 0,
"from": 0,
"to": 0,
"currentPage": 0,
"pagesCount": 0,
"pageSize": 0
},
"orders": [
{
"id": 0,
"externalOrderId": "string",
"status": "PLACING",
"substatus": "RESERVATION_EXPIRED",
"creationDate": "23-09-2022 09:12:41",
"updatedAt": "23-09-2022 09:12:41",
"currency": "RUR",
"itemsTotal": 0,
"deliveryTotal": 0,
"buyerItemsTotal": 0,
"buyerTotal": 0,
"buyerItemsTotalBeforeDiscount": 0,
"buyerTotalBeforeDiscount": 0,
"paymentType": "PREPAID",
"paymentMethod": "CASH_ON_DELIVERY",
"fake": false,
"items": [
{
"id": 0,
"offerId": "string",
"offerName": "string",
"price": 0,
"buyerPrice": 0,
"buyerPriceBeforeDiscount": 0,
"priceBeforeDiscount": 0,
"count": 0,
"vat": "NO_VAT",
"shopSku": "string",
"subsidy": 0,
"partnerWarehouseId": "string",
"promos": [
{
"type": "DIRECT_DISCOUNT",
"discount": 0,
"subsidy": 0,
"shopPromoId": "string",
"marketPromoId": "string"
}
],
"instances": [
{
"cis": "string",
"cisFull": "string",
"uin": "string",
"rnpt": "string",
"gtd": "string",
"countryCode": "RU"
}
],
"details": [
{
"itemCount": 0,
"itemStatus": "REJECTED",
"updateDate": "23-09-2022"
}
],
"subsidies": [
{
"type": "YANDEX_CASHBACK",
"amount": 0
}
],
"requiredInstanceTypes": [
"CIS"
],
"tags": [
"ULTIMA"
]
}
],
"subsidies": [
{
"type": "YANDEX_CASHBACK",
"amount": 0
}
],
"delivery": {
"id": "string",
"type": "DELIVERY",
"serviceName": "string",
"price": 0,
"deliveryPartnerType": "SHOP",
"courier": {
"fullName": "string",
"phone": "string",
"phoneExtension": "string",
"vehicleNumber": "string",
"vehicleDescription": "string"
},
"dates": {
"fromDate": "23-09-2022",
"toDate": "23-09-2022",
"fromTime": "string",
"toTime": "string",
"realDeliveryDate": "23-09-2022"
},
"region": {
"id": 0,
"name": "string",
"type": "OTHER"
},
"address": {
"country": "string",
"postcode": "string",
"city": "string",
"district": "string",
"subway": "string",
"street": "string",
"house": "string",
"estate": "string",
"block": "string",
"building": "string",
"entrance": "string",
"entryphone": "string",
"floor": "string",
"apartment": "string",
"phone": "string",
"recipient": "string",
"gps": {
"latitude": 0,
"longitude": 0
}
},
"vat": "NO_VAT",
"deliveryServiceId": 0,
"logisticPointId": 0,
"liftType": "NOT_NEEDED",
"liftPrice": 0,
"outletCode": "string",
"outletStorageLimitDate": "23-09-2022",
"dispatchType": "UNKNOWN",
"tracks": [
{
"trackCode": "string",
"deliveryServiceId": 0
}
],
"shipments": [
{
"id": 0,
"shipmentDate": "23-09-2022",
"shipmentTime": "string",
"tracks": [
{
"trackCode": "string",
"deliveryServiceId": 0
}
],
"boxes": [
{
"id": 0,
"fulfilmentId": "string"
}
]
}
],
"estimated": false,
"eacType": "MERCHANT_TO_COURIER",
"eacCode": "string"
},
"buyer": {
"id": "string",
"lastName": "string",
"firstName": "string",
"middleName": "string",
"type": "PERSON"
},
"notes": "string",
"taxSystem": "OSN",
"cancelRequested": false,
"expiryDate": "23-09-2022 09:12:41"
}
],
"paging": {
"nextPageToken": "string"
}
}
|
Name |
Description |
||||||||||||
|
orders* |
Type: object[] 的订单模型。
Max items: |
||||||||||||
|
pager |
Type: object
分页的模型。 |
||||||||||||
|
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.
安全标签有助于防止产品在退货时被更换。 如果没有购买时存在的保护标签,您将无法退回产品。