有关柜内订单的信息
方法适用于模式：FBY, FBS, Express 和 DBS.
如果您使用API-Key令牌，调用该方法时需要具备列表中可用权限之一
返回商家配置文件中有关订单的信息。 查询可用于跟踪订单及其状态。
可按参数过滤:
-
订单的日期。
-
订单更新的日期和时间;
-
装运日期;
-
订单状态(
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 内阁ID。 要找到答案，请使用请求 GET v2/campaigns. Min value: |
Query parameters
|
Name |
Description |
|
limit |
Type: integer 每页的值数。 Min value: |
|
page_token |
Type: string 结果页面的ID。 如果省略该参数，则返回第一页。 我们建议传输输出参数的值 如果设置 Example: |
Body
application/json
{
"orderIds": [
0
],
"externalOrderIds": [
"example"
],
"programTypes": [
"FBY"
],
"campaignIds": [
1
],
"statuses": [
"PLACING"
],
"substatuses": [
"RESERVATION_EXPIRED"
],
"dates": {
"creationDateFrom": "2025-01-01",
"creationDateTo": "2025-01-01",
"shipmentDateFrom": "2025-01-01",
"shipmentDateTo": "2025-01-01",
"updateDateFrom": "2025-01-01T00:00:00Z",
"updateDateTo": "2025-01-01T00:00:00Z"
},
"fake": true,
"waitingForCancellationApprove": true,
"sourcePlatforms": [
"MARKET"
]
}
|
Name |
Description |
||||||||||||
|
campaignIds |
Type: integer[] | null 商店活动的id。 Min items: Max items: Unique items: Example |
||||||||||||
|
dates |
Type: object
按订单日期筛选。 Example |
||||||||||||
|
externalOrderIds |
Type: string[] | null 外部订单Id。 Min items: Max items: Unique items: Example |
||||||||||||
|
fake |
Type: boolean 订单类型:
|
||||||||||||
|
orderIds |
Type: integer[] | null 订单Id。 Min items: Max items: Unique items: Example |
||||||||||||
|
programTypes |
Type: string[] | null 商店在市场上的运作模式。 Min items: Unique items: Example |
||||||||||||
|
sourcePlatforms |
Type: string[] | null 平台是订单的来源。 Min items: Unique items: Example |
||||||||||||
|
statuses |
Type: string[] | null 订单状态。 Min items: Unique items: Example |
||||||||||||
|
substatuses |
Type: string[] | null 处理阶段或取消订单的原因。 Min items: Unique items: Example |
||||||||||||
|
waitingForCancellationApprove |
Type: boolean 只适用于型号 DBS 用于接收具有取消请求的订单的过滤器。 与值 |
Responses
200 OK
内阁的订单清单。
Body
application/json
{
"orders": [
{
"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": {},
"instances": [
null
],
"requiredInstanceTypes": [
null
],
"tags": [
null
]
}
],
"prices": {
"payment": {
"value": 0.5,
"currencyId": "RUR"
},
"subsidy": {
"value": 0.5,
"currencyId": "RUR"
},
"cashback": {
"value": 0.5,
"currencyId": "RUR"
},
"delivery": {
"payment": {},
"subsidy": {},
"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": {},
"region": {}
},
"pickup": {
"address": {},
"region": {},
"logisticPointId": 1,
"outletCode": "example",
"outletStorageLimitDate": "2025-01-01"
},
"transfer": {
"courier": {},
"eac": {}
},
"boxesLayout": [
{}
],
"tracks": [
{}
],
"estimated": true,
"receiveCode": "example"
},
"services": {
"liftType": "NOT_NEEDED"
},
"buyerType": "PERSON",
"notes": "example",
"cancelRequested": true,
"sourcePlatform": "MARKET"
}
],
"paging": {
"nextPageToken": "example"
}
}
|
Name |
Description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
orders |
Type: object[]
内阁的订单清单。 Max items: Example |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
paging |
Type: object
下一页的ID。 Example |
500 Internal Server Error
Yandex中的内部错误。 市场。 有关错误的更多信息
Body
application/json
{
"status": "OK"
}
Type: object
pathParams:
- description: "内阁ID。 要找到答案，请使用请求 [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md).\n\nℹ️ [什么是市场上的橱柜和商店？](https://yandex.ru/support/marketplace/account/introduction.html)\n"
name: businessId
in: path
required: true
schema:
type: integer
format: int64
minimum: 1
searchParams:
- name: page_token
description: >
结果页面的ID。
如果省略该参数，则返回第一页。
我们建议传输输出参数的值 `nextPageToken`，在最后一次请求期间接收。
如果设置 `page_token` 并且请求有参数 `page` 和
`pageSize` 它们被忽略了。
in: query
required: false
example: eyBuZXh0SWQ6IDIzNDIgfQ==
schema:
type: string
- name: limit
description: |
每页的值数。
in: query
required: false
example: 20
schema:
type: integer
format: int32
minimum: 1
headers: []
body: |-
{
"orderIds": [
0
],
"externalOrderIds": [
"example"
],
"programTypes": [
"FBY"
],
"campaignIds": [
1
],
"statuses": [
"PLACING"
],
"substatuses": [
"RESERVATION_EXPIRED"
],
"dates": {
"creationDateFrom": "2025-01-01",
"creationDateTo": "2025-01-01",
"shipmentDateFrom": "2025-01-01",
"shipmentDateTo": "2025-01-01",
"updateDateFrom": "2025-01-01T00:00:00Z",
"updateDateTo": "2025-01-01T00:00:00Z"
},
"fake": true,
"waitingForCancellationApprove": true,
"sourcePlatforms": [
"MARKET"
]
}
schema:
type: object
description: 请求有关业务订单的信息。
properties:
orderIds:
description: 订单Id。
nullable: true
uniqueItems: true
type: array
items:
type: integer
format: int64
minItems: 1
maxItems: 50
externalOrderIds:
description: 外部订单Id。
nullable: true
uniqueItems: true
type: array
items:
description: "您提交的订单的外部ID [POST\_v2/campaigns/{campaignId}/orders/{orderId}/external-id](../../reference/orders/updateExternalOrderId.md)."
type: string
minLength: 1
minItems: 1
maxItems: 50
programTypes:
description: 商店在市场上的运作模式。
nullable: true
uniqueItems: true
type: array
items:
description: |
工作模式:
* `FBY` — FBY.
* `FBS` — FBS.
* `DBS` — DBS.
* `EXPRESS` — Express.
type: string
enum:
- FBY
- FBS
- DBS
- EXPRESS
- LAAS
minItems: 1
campaignIds:
description: 商店活动的id。
nullable: true
uniqueItems: true
type: array
items:
description: "广告系列（商店）的ID — 通过API工作时，代表您在Yandex市场系统中的商店的技术标识符。 它与您的商店唯一链接，但仅用于自动交互。\n\n您可以使用查询找到它 [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) 或者在市场上的卖家办公室找到它。 点击您的帐户图标→ **设置** 在左边的菜单中，选择 **Api和模块**:\n\n* 座 **运动ID**;\n* 标签 **查询日志** →块中的下拉列表 **显示日志**.\n\n⚠️ 不要把它与:\n- 商店的标识符，显示在商家的个人帐户中。\n- 广告活动。\n"
type: integer
format: int64
minimum: 1
minItems: 1
maxItems: 50
statuses:
description: 订单状态。
nullable: true
uniqueItems: true
type: array
items:
description: |
订单状况:
* `PLACING` — 它正在处理，准备预订。
* `RESERVED` — 预订，但预订不足。
* `UNPAID` — 已发出，但尚未付款（如果在结账时选择付款）。
* `PROCESSING` — 它正在处理中。
* `DELIVERY` — 转移到送货服务。
* `PICKUP` — 送到取件点。
* `DELIVERED` — 由买方接收。
* `CANCELLED` — 取消。
* `PENDING` — 等待卖方处理。
* `PARTIALLY_RETURNED` — 部分退款。
* `RETURNED` — 全额回来了。
* `UNKNOWN` — 状态不明。
也可以返回其他值。 您不需要处理它们。
type: string
enum:
- PLACING
- RESERVED
- UNPAID
- PROCESSING
- DELIVERY
- PICKUP
- DELIVERED
- CANCELLED
- PENDING
- PARTIALLY_RETURNED
- RETURNED
- UNKNOWN
minItems: 1
substatuses:
description: 处理阶段或取消订单的原因。
nullable: true
uniqueItems: true
type: array
items:
description: >
订单处理阶段（状态 `PROCESSING`）或取消订单的原因（状态
`CANCELLED`).
* 状态中的订单值 `PROCESSING`:
* `STARTED` — 订单已确认，可以处理。
* `READY_TO_SHIP` — 订单已组装并准备装运。
* 状态中的订单值 `CANCELLED`:
* `RESERVATION_EXPIRED` — 客户没有在10分钟内完成预订订单。
* `USER_NOT_PAID` — 买方没有为订单付款（对于付款类型 `PREPAID`）30分钟。
* `USER_UNREACHABLE` — 无法联系买家。 为此取消，必须满足以下条件:
* 至少3个电话从8到21在买方的时区;
* 第一次和第三次通话之间的休息时间至少为90分钟;
* 连接不短于5秒。
如果不满足其中至少一个条件（号码不可用时除外），您将无法取消订单。 将返回带有错误代码400的响应。
* `USER_CHANGED_MIND` — 客户因个人原因取消了订单。
* `USER_REFUSED_DELIVERY` — 买方对交货条件不满意.
* `USER_REFUSED_PRODUCT` — 该产品不适合买方。
* `SHOP_FAILED` — 商店无法完成订单。
* `USER_REFUSED_QUALITY` — 买方对产品的质量不满意。
* `REPLACING_ORDER` — 买方决定主动更换另一种产品。
* `PROCESSING_EXPIRED` — 值不再使用。
* `PICKUP_EXPIRED` — 取货点的订单保质期已过期。
* `TOO_MANY_DELIVERY_DATE_CHANGES` — 订单被推迟了太多次。
* `TOO_LONG_DELIVERY` — 订单太长，无法交付。
* `INCORRECT_PERSONAL_DATA` — 对于来自国外的订单，收件人的信息不正确，订单将不会在海关检查。
* `TECHNICAL_ERROR` — 市场方面的技术错误。 联系支持。
也可以返回其他值。 您不需要处理它们。
type: string
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
minItems: 1
dates:
type: object
description: 按订单日期筛选。
properties:
creationDateFrom:
description: 订单的初始日期(YYYY-MM-DD)。
type: string
format: date
creationDateTo:
description: 订单的结束日期(YYYY-MM-DD)。
type: string
format: date
shipmentDateFrom:
description: 装运的初始日期(YYYY-MM-DD).
type: string
format: date
shipmentDateTo:
description: 最后装运日期(YYYY-MM-DD).
type: string
format: date
updateDateFrom:
description: 订单更新的初始日期（ISO 8601).
type: string
format: date-time
updateDateTo:
description: 订单更新的结束日期（ISO 8601).
type: string
format: date-time
fake:
description: >
订单类型:
* `false` — 真正的客户的订单。
* `true` —
[测试订单](../../concepts/sandbox.md) 燕基科斯. 市场。
type: boolean
waitingForCancellationApprove:
description: >
**只适用于型号 DBS**
用于接收具有取消请求的订单的过滤器。
与值 `true` 仅返回处于状态的那些订单。 `DELIVERY` 或
`PICKUP`，而用户决定取消它们。
type: boolean
sourcePlatforms:
x-hidden: true
description: 平台是订单的来源。
nullable: true
uniqueItems: true
type: array
items:
x-hidden: true
description: >
该网站是订单的来源:
* `MARKET` — 市场上的订单。
* `OZON` — LaaS是Ozon的订单。
* `WILDBERRIES` —
LaaS是放在Wildberries上的订单。
* `OTHER` — LaaS是卖方创建的订单。
type: string
enum:
- MARKET
- OZON
- WILDBERRIES
- OTHER
minItems: 1
bodyType: application/json
method: post
security:
- type: apiKey
name: 'Api-Key'
in: header
- type: oauth2
x-inline: true
flows:
implicit:
authorizationUrl: https://oauth.yandex.ru/authorize
scopes:
market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v1/businesses/{businessId}/orders
host: https://api.partner.market.yandex.ru
No longer supported, please use an alternative and newer version.
安全标签有助于防止产品在退货时被更换。 如果没有购买时存在的保护标签，您将无法退回产品。