Отмена заказа покупателем (DBS)

Подтверждает или отклоняет запрос покупателя на отмену заказа, который передан службе доставки.

Покупатель может отменить заказ в течение его обработки или доставки. Если заказ еще обрабатывается (имеет статус PROCESSING), вам не нужно подтверждать отмену заказа — он будет отменен автоматически.

Если заказ уже передан службе доставки (принимает статус DELIVERY или PICKUP) и пользователь отменил его, вы можете предупредить службу об отмене в течение 48 часов. Если служба доставки узнала об отмене до передачи заказа покупателю, подтвердите отмену с помощью запроса PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept. Если заказ уже доставлен, отклоните отмену с помощью этого же запроса. Тогда у покупателя останется заказ, и деньги за него возвращаться не будут.

Чтобы узнать, какие заказы были отменены в статусе DELIVERY или PICKUP, отправьте запрос GET campaigns/{campaignId}/orders. В его URL добавьте входной параметр onlyWaitingForCancellationApprove=true. Вы также можете узнать об отмененных заказах в кабинете или через почту — на нее придет уведомление об отмене.

Если в течение 48 часов вы не подтвердите или отклоните отмену, заказ будет отменен автоматически.

⚙️ Лимит: 500 запросов в час

Request

PUT

https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/cancellation/accept

Path parameters

Name

Type

Description

campaignId*

integer<int64>

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

orderId*

integer<int64>

Идентификатор заказа.

Body

application/json
{
    "accepted": false,
    "reason": "ORDER_DELIVERED"
}

Name

Type

Description

accepted*

boolean

Решение об отмене заказа:

  • true — заказ отменяется, служба доставки узнала об отмене до передачи заказа покупателю.
  • false — заказ не отменяется, так как он уже доставлен покупателю курьером или передан в пункт выдачи заказов.

reason

OrderCancellationReasonType

Причина, по которой заказ не может быть отменен (она сообщается покупателю).

Обязательный параметр, если вы передаете accepted="false".


Enum: ORDER_DELIVERED, ORDER_IN_DELIVERY

OrderCancellationReasonType

Варианты причин, по которым заказ не может быть отменен.

  • ORDER_DELIVERED — заказ уже доставлен.
  • ORDER_IN_DELIVERY — заказ уже у курьера.

Type

Description

OrderCancellationReasonType

Enum: ORDER_DELIVERED, ORDER_IN_DELIVERY

Responses

200 OK

Ответ на отмену заказа был успешно передан.

Body

application/json
{
    "status": "OK"
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

ApiResponseStatusType

Тип ответа.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

400 Bad Request

Запрос содержит неправильные данные.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

ApiErrorDTO

Общий формат ошибки.

Name

Type

Description

code*

string

Код ошибки.

message

string

Описание ошибки.

401 Unauthorized

В запросе не указаны данные для авторизации.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.