有关商店订单的信息
Deprecated
方法适用于模式:FBY, FBS, Express 和 DBS.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
我应该使用哪种方法而不是过时的方法?
返回有关商店中订单的信息。 查询可用于跟踪订单及其状态。
默认情况下,不会接收有关测试订单的数据。 要获取它们,请传递值 true 在参数中 fake.
您还可以设置API通知。
燕基科斯.市场会送你 请求 当新订单出现或其状态发生变化时。 使用该方法可以获得完整的信息 POST v1/businesses/{businessId}/orders.
可按参数过滤:
-
订单的日期。
-
订单更新的日期和时间;
-
装运日期;
-
订单状态(
statuses); -
处理阶段或取消原因(
substatuses); -
订单Id;
-
订单的类型(真实或测试)。
有关超过30天前交付或取消的订单的信息将不予退还。 如何获得它:
每个请求的最大日期范围 — 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 广告系列(商店)的ID — 通过API工作时,代表您在Yandex市场系统中的商店的技术标识符。 它与您的商店唯一链接,但仅用于自动交互。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到它。 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 不要把它与:
Min value: |
Query parameters
|
Name |
Description |
|
buyerType |
Type: string 按客户类型过滤订单。 买方类型:
Enum: |
|
dispatchType |
Type: string 装运方法 装运方法:
Enum: |
|
fake |
Type: boolean 按类型过滤订单:
Default: |
|
fromDate |
Type: string<date> 按结帐日期筛选订单的开始日期。 日期格式: 开始和结束日期之间(参数 默认值:从当前日期起30天前. Example: `` |
|
hasCis |
Type: boolean 用于接收系统中包含至少一个带有识别码的产品的订单的过滤器。 «Честный ЗНАК» 或 «ASL BELGISI» (对于卖家 Market Yandex Go):
这些代码被分配给需要贴标签并属于某些类别的产品。 Default: |
|
limit |
Type: integer 每页的值数。 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: Example: `` |
|
page |
Type: integer 如果方法有 用它代替参数 结果页的编号。 与参数一起使用
Default: Max value: |
|
page_token |
Type: string 结果页面的ID。 如果省略该参数,则返回第一页。 我们建议传输输出参数的值 如果设置 Example: |
|
pageSize |
Type: integer 页面大小。 与参数一起使用
|
|
status |
Type: string[] 订单状况:
Unique items: Example: `` |
|
substatus |
Type: string[] 订单处理阶段(状态 状态中订单的可能值
状态中订单的可能值
Unique items: Example: `` |
|
supplierShipmentDateFrom |
Type: string<date> 按发货到送货服务的日期筛选订单的开始日期(参数 日期格式: 开始日期和结束日期之间(参数 开始日期包含在筛选的间隔中。 Example: `` |
|
supplierShipmentDateTo |
Type: string<date> 按发货到送货服务的日期筛选订单的结束日期(参数 日期格式: 在初始(参数 结束日期不包括在过滤间隔中。 如果之间的时间间隔 Example: `` |
|
toDate |
Type: string<date> 按结帐日期筛选订单的结束日期。 显示指定日期00:00之前创建的订单。 日期格式: 在初始(参数 默认值:当前日期。 如果之间的时间间隔 Example: `` |
|
updatedAtFrom |
Type: string<date-time> 按更新日期和时间筛选订单的开始日期(参数 日期格式: ISO 8601 具有相对于 UTC. 例如, 开始日期和结束日期之间(参数 开始日期包含在筛选的间隔中。 Example: `` |
|
updatedAtTo |
Type: string<date-time> 按更新日期和时间筛选订单的结束日期(参数 日期格式: ISO 8601 具有相对于 UTC. 例如, 在初始(参数 结束日期不包括在过滤间隔中。 Example: `` |
Responses
200 OK
关于订单的信息。
Body
application/json
{
"pager": {
"total": 0,
"from": 0,
"to": 0,
"currentPage": 0,
"pagesCount": 0,
"pageSize": 0
},
"orders": [
{
"id": 0,
"externalOrderId": "example",
"status": "PLACING",
"substatus": "RESERVATION_EXPIRED",
"creationDate": "23-09-2022 09:12:41",
"updatedAt": "23-09-2022 09:12:41",
"currency": "RUR",
"itemsTotal": 0.5,
"deliveryTotal": 0.5,
"buyerItemsTotal": 0.5,
"buyerTotal": 0.5,
"buyerItemsTotalBeforeDiscount": 0.5,
"buyerTotalBeforeDiscount": 0.5,
"paymentType": "PREPAID",
"paymentMethod": "CASH_ON_DELIVERY",
"fake": true,
"items": [
{
"id": 0,
"offerId": "example",
"offerName": "example",
"price": 0.5,
"buyerPrice": 0.5,
"buyerPriceBeforeDiscount": 0.5,
"priceBeforeDiscount": 0.5,
"count": 0,
"vat": "NO_VAT",
"shopSku": "example",
"subsidy": 0.5,
"partnerWarehouseId": "example",
"promos": [
null
],
"instances": [
null
],
"details": [
null
],
"subsidies": [
null
],
"requiredInstanceTypes": [
null
],
"tags": [
null
]
}
],
"subsidies": [
{
"type": "YANDEX_CASHBACK",
"amount": 0.5
}
],
"delivery": {
"id": "example",
"type": "DELIVERY",
"serviceName": "example",
"price": 0.5,
"deliveryPartnerType": "SHOP",
"courier": {
"fullName": "example",
"phone": "example",
"phoneExtension": "example",
"vehicleNumber": "example",
"vehicleDescription": "example"
},
"dates": {
"fromDate": "23-09-2022",
"toDate": "23-09-2022",
"fromTime": "12:00:00",
"toTime": "12:00:00",
"realDeliveryDate": "23-09-2022"
},
"region": {
"id": 0,
"name": "example",
"type": "OTHER",
"parent": null
},
"address": {
"country": "example",
"postcode": "example",
"city": "example",
"district": "example",
"subway": "example",
"street": "example",
"house": "example",
"estate": "example",
"block": "example",
"building": "example",
"entrance": "example",
"entryphone": "example",
"floor": "example",
"apartment": "example",
"phone": "example",
"recipient": "example",
"gps": {}
},
"vat": "NO_VAT",
"deliveryServiceId": 0,
"logisticPointId": 1,
"liftType": "NOT_NEEDED",
"liftPrice": 0.5,
"outletCode": "example",
"outletStorageLimitDate": "23-09-2022",
"dispatchType": "UNKNOWN",
"tracks": [
{}
],
"shipments": [
{}
],
"estimated": true,
"eacType": "MERCHANT_TO_COURIER",
"eacCode": "example",
"receiveCode": "example"
},
"buyer": {
"id": "example",
"lastName": "example",
"firstName": "example",
"middleName": "example",
"email": "example",
"type": "PERSON"
},
"notes": "example",
"taxSystem": "OSN",
"cancelRequested": true,
"expiryDate": "23-09-2022 09:12:41",
"sourcePlatform": "MARKET"
}
],
"paging": {
"nextPageToken": "example"
}
}
|
Name |
Description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
orders |
Type: object[]
的订单模型。 Max items: Example
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
pager |
Type: object
分页的模型。 Example
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
paging |
Type: object
下一页的ID。 Example
|
500 Internal Server Error
Yandex的内部错误。 市场。 有关错误的更多信息
Body
application/json
{
"status": "OK"
}
Type: object
pathParams:
- description: "广告系列(商店)的ID — 通过API工作时,代表您在Yandex市场系统中的商店的技术标识符。 它与您的商店唯一链接,但仅用于自动交互。\n\n您可以使用查询找到它 [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) 或者在市场上的卖家办公室找到它。 点击您的帐户图标→ **设置** 在左边的菜单中,选择 **Api和模块**:\n\n* 座 **运动ID**;\n* 标签 **查询日志** →块中的下拉列表 **显示日志**.\n\n⚠️ 不要把它与:\n- 商店的标识符,显示在商家的个人帐户中。\n- 广告活动。\n"
name: campaignId
in: path
required: true
schema:
type: integer
format: int64
minimum: 1
searchParams:
- description: |
按Id过滤订单。
<br><br>
⚠️ 不要与其他过滤器在同一时间使用此字段。 如果您想使用它们,请将字段留空。
name: orderIds
in: query
required: false
schema:
type: array
items:
type: integer
format: int64
minItems: 1
maxItems: 50
- description: |
订单状况:
* `CANCELLED` — 订单已被取消。
* `DELIVERED` — 买方收到了订单。
* `DELIVERY` — 订单已发送到送货服务。
* `PICKUP` — 订单已送到提货点。
* `PROCESSING` — 订单正在处理中。
* `UNPAID` — 订单已放置,但尚未付款(如果在结账时选择付款)。
name: status
in: query
required: false
schema:
type: array
uniqueItems: true
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
- description: >
订单处理阶段(状态 `PROCESSING`)或取消订单的原因(状态
`CANCELLED`).
状态中订单的可能值 `PROCESSING`:
* `STARTED` — 订单已确认,可以处理。
* `READY_TO_SHIP` — 订单已组装并准备装运。
* `SHIPPED` — 订单已转移到送货服务.
状态中订单的可能值 `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` — 订单在PVZ中的存储期已过期。
* `DELIVERY_SERVICE_UNDELIVERED` —
送货服务无法交付订单。
* `CANCELLED_COURIER_NOT_FOUND` — 找不到信使。
* `USER_WANTS_TO_CHANGE_DELIVERY_DATE` —
客户希望在另一天收到订单。
* `RESERVATION_FAILED` — 市场无法继续进一步处理订单。
name: substatus
in: query
required: false
schema:
type: array
uniqueItems: true
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
- description: |
按结帐日期筛选订单的开始日期。
日期格式: `DD-MM-YYYY`.
开始和结束日期之间(参数 `toDate`)应该不超过30天。
默认值:从当前日期起30天前.
name: fromDate
in: query
required: false
schema:
type: string
format: date
- description: >
按结帐日期筛选订单的结束日期。
显示指定日期00:00之前创建的订单。
日期格式: `DD-MM-YYYY`.
在初始(参数 `fromDate`)和结束日期应不超过30天。
默认值:当前日期。
如果之间的时间间隔 `toDate` 和 `fromDate` 不到一天,那么
`toDate` 等于 `fromDate` +一天。
name: toDate
in: query
required: false
schema:
type: string
format: date
- description: |
按发货到送货服务的日期筛选订单的开始日期(参数 `shipmentDate`).
日期格式: `DD-MM-YYYY`.
开始日期和结束日期之间(参数 `supplierShipmentDateTo`)应该不超过30天。
开始日期包含在筛选的间隔中。
name: supplierShipmentDateFrom
in: query
required: false
schema:
type: string
format: date
- description: >
按发货到送货服务的日期筛选订单的结束日期(参数 `shipmentDate`).
日期格式: `DD-MM-YYYY`.
在初始(参数 `supplierShipmentDateFrom`)和结束日期应不超过30天。
结束日期不包括在过滤间隔中。
如果之间的时间间隔 `supplierShipmentDateTo` 和
`supplierShipmentDateFrom` 不到一天,那么
`supplierShipmentDateTo` 等于
`supplierShipmentDateFrom` +一天。
name: supplierShipmentDateTo
in: query
required: false
schema:
type: string
format: date
- description: >
按更新日期和时间筛选订单的开始日期(参数 `updatedAt`).
日期格式: ISO 8601 具有相对于 UTC. 例如,
`2017-11-21T00:42:42+03:00`.
开始日期和结束日期之间(参数 `updatedAtTo`)应该不超过30天。
开始日期包含在筛选的间隔中。
name: updatedAtFrom
in: query
required: false
schema:
type: string
format: date-time
- description: >
按更新日期和时间筛选订单的结束日期(参数 `updatedAt`).
日期格式: ISO 8601 具有相对于 UTC. 例如,
`2017-11-21T00:42:42+03:00`.
在初始(参数 `updatedAtFrom`)和结束日期应不超过30天。
结束日期不包括在过滤间隔中。
name: updatedAtTo
in: query
required: false
schema:
type: string
format: date-time
- description: 装运方法
name: dispatchType
in: query
required: false
schema:
description: |
装运方法:
* `BUYER` — 快递交付给买方。
* `MARKET_BRANDED_OUTLET` — 送到市场的取货点。
* `SHOP_OUTLET` — 送货到商店的订单提货点.
* `UNKNOWN` — 未知类型。
type: string
enum:
- UNKNOWN
- BUYER
- MARKET_BRANDED_OUTLET
- SHOP_OUTLET
- description: >
按类型过滤订单:
* `false` — 真正的客户的订单。
* `true` —
[测试订单](../../concepts/sandbox.md) 燕基科斯. 市场。
name: fake
in: query
required: false
schema:
type: boolean
default: false
- description: >
用于接收系统中包含至少一个带有识别码的产品的订单的过滤器。 [«Честный
ЗНАК»](https://честныйзнак.рф/) 或 [«ASL
BELGISI»](https://aslbelgisi.uz) (对于卖家
Market Yandex Go):
* `true` — 是的.
* `false` — 非也。.
这些代码被分配给需要贴标签并属于某些类别的产品。
name: hasCis
in: query
required: false
schema:
type: boolean
default: false
- description: "**只适用于型号 DBS**\n\n用于接收有取消请求的订单的过滤器。\n\n与值 `true` 仅返回具有以下状态的订单 `DELIVERY` 或 `PICKUP` 用户决定取消。\n\n要确认或拒绝取消,请发送请求 [PUT\_v2/campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation).\n"
name: onlyWaitingForCancellationApprove
in: query
required: false
schema:
type: boolean
default: false
- description: |
按已确认的交货日期过滤长交货(31-60天)的订单:
* `true` — 只有未确认交货日期的订单才会被退回.
* `false` — 不应用过滤。
name: onlyEstimatedDelivery
in: query
required: false
schema:
type: boolean
default: false
- description: |
按客户类型过滤订单。
name: buyerType
in: query
required: false
schema:
description: |
买方类型:
* `PERSON` — 一个自然人。
* `BUSINESS` — 组织。
type: string
enum:
- PERSON
- BUSINESS
- name: page
description: >
{% note warning "如果方法有 `page_token`" %}
用它代替参数 `page`.
[了解有关分页类型及其使用的更多信息](../../concepts/pagination.md)
{% endnote %}
结果页的编号。
与参数一起使用 `pageSize`.
`page` 如果指定,则忽略 `page_token` 或
`limit`.
in: query
required: false
schema:
type: integer
format: int32
default: 1
maximum: 10000
- name: pageSize
description: >
页面大小。
与参数一起使用 `page`.
`pageSize` 如果指定,则忽略 `page_token` 或
`limit`.
in: query
required: false
schema:
type: integer
format: int32
- 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: null
schema: {}
method: get
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: v2/campaigns/{campaignId}/orders
host: https://api.partner.market.yandex.ru
No longer supported, please use an alternative and newer version.
安全标签有助于防止产品在退货时被更换。 如果没有购买时存在的保护标签,您将无法退回产品。