买方取消订单
方法适用于模式DBS.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
- inventory-and-order-processing — 订单处理和商品核算
- all-methods — 全面管理账户
确认或拒绝买方取消订单的请求,该订单已发送到送货服务。
买方可以在订单处理或交付过程中取消订单。 如果订单仍在处理中(状态 PROCESSING),您不需要确认取消订单 — 它将自动取消。
如果订单已发送到送货服务(状态 DELIVERY 或 PICKUP)并且用户取消了它,您可以在48小时内通知取消服务。
- 送货服务在将订单交给买家之前发现了取消 — 通过请求确认取消 PUT v2/campaigns/{campaignId}/orders/{orderId}/cancellation/accept.
- 订单已经交付 — 使用相同的请求拒绝取消。 然后客户仍然会有订单,并且它的钱不会被退还。
如何了解已取消的订单:
- 发送请求 GET v2/campaigns/{campaignId}/orders. 在他的 URL 添加输入参数
onlyWaitingForCancellationApprove=true. - 在办公室或通过电子邮件 — 将向其发送取消通知。
- 启用API通知。 燕基科斯.Market会向您发送请求。 POST notification 当有一个新的请求取消订单。 如何使用通知
如果您在48小时内未确认或拒绝取消订单,订单将自动取消。
| ⚙️ 限制: 每小时500个请求 |
|---|
Request
PUT
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/orders/{orderId}/cancellation/accept
Path parameters
|
Name |
Description |
|
campaignId* |
Type: integer<int64> 活动ID。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 不要发送商店ID,这是在市场上的卖家帐户旁边的商店名称和一些报告。
Min value: |
|
orderId* |
Type: integer<int64> 的订单ID。 |
Body
application/json
{
"accepted": false,
"reason": "ORDER_DELIVERED"
}
|
Name |
Description |
|
accepted* |
Type: boolean 取消订单的决定:
|
|
reason |
Type: OrderCancellationReasonType Причина, по которой заказ не может быть отменен (она сообщается покупателю). Обязательный параметр, если вы передаете Enum: |
OrderCancellationReasonType
订单无法取消的可能原因。
ORDER_DELIVERED— 订单已经交付。ORDER_IN_DELIVERY— 订单已经与快递。
|
Type |
Description |
|
Enum: |
Responses
200 OK
对订单取消的响应已成功传输。
Body
application/json
{
"status": "OK"
}
|
Name |
Description |
|
status* |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
ApiResponseStatusType
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
|
Type |
Description |
|
Enum: |
400 Bad Request
请求包含不正确的数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
ApiErrorDTO
一般错误格式。
|
Name |
Description |
|
code* |
Type: string 的错误代码。 |
|
message |
Type: string 错误的描述。 |
401 Unauthorized
请求中未指定授权数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
404 Not Found
找不到请求的资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
500 Internal Server Error
市场的内部错误。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
No longer supported, please use an alternative and newer version.