5. Отмена заказа

Отмена заказа доступна для заказов в статусах APPROVED_BY_BANK (новый заказ) и ACCEPTED_BY_MERCHANT (заказ принят).

На этом этапе вы можете отменить заказ, если он ещё не был передан на доставку. Отмена доступна только для заказов в статусах:

APPROVED_BY_BANK — новый заказ;

ACCEPTED_BY_MERCHANT — заказ принят продавцом. POST-запрос:

Шаблон запроса:

curl --location 'https://api.halykmarket.com/api/merchant/v1/orders' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ваш токен' \
--data '{
  "data": {
    "type": "orders",
    "id": "11111111",
    "attributes": {
        "code": "1111111111-1",
        "status": "CANCELLED",
        "cancellationReason": "BUYER_CANCELLATION_BY_MERCHANT"
    }
  }
}'

Атрибуты запроса:

Наименование	Описание / Значение
type	атрибут, равный "orders"
id	ID заказа
code	номер заказа
status	статус заказа — "CANCELLED"
cancellationReason	причина отмены заказа. Возможные значения: • BUYER_CANCELLATION_BY_MERCHANT — получен отказ покупателя • BUYER_NOT_REACHABLE — не удалось дозвониться до покупателя • MERCHANT_OUT_OF_STOCK — товара нет в наличии

Ответ сервера:

Шаблон ответа:

"data": {
        "type": "orders",
        "id": "11111111",
        "attributes": {
            "code": "1111111111-1",
            "status": "CANCELLED",
            "posCode": "test00_pp48",
            "countPlace": 1,
            "cancellationReason": "BUYER_CANCELLATION_BY_MERCHANT"
        },
        "relationships": {
            "entries": {
                "links": {
                    "self": "/api.halykmarket.com/api/merchant/v1/orders/11111111/relationships/entries",
                    "related": "/api.halykmarket.com/api/merchant/v1/orders/11111111/entries"
                }
            }
        }
    }
}

Атрибуты ответа:

Наименование	Описание / Значение
type	атрибут, равный "orders"
id	ID заказа
code	номер заказа
status	статус заказа — "CANCELLED"
posCode	ID точки продаж для забора заказа (поле не несёт бизнес-смысла на данном этапе)
countPlace	количество мест для доставки (поле не несёт бизнес-смысла на данном этапе)
cancellationReason	отправленная причина отмены заказа
Relationships (взаимосвязи)
— entries	состав заказа
— self	ссылка, указывающая на сам заказ; по ней можно получить данные конкретного заказа

Вы отменили заказ.

Также в GET-запросе на v1/orders по заказам в статусе CANCELLED вы будете дополнительно получать атрибут cancellationReason - причину отмены заказа.