Отменить черновик заказа
Порядок работы для агента · Методы API и схема OpenAPI.
Назначение
Отмените заказ в статусе draft. Передайте data.id и обязательный data.cancelReasonKey из справочника причин отмены черновика. После вызова перечитайте заказ и проверьте статус cancel.
Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде
exampleпоказывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.
Request
POST
https://partner-test-yamagistrali.ru/api/orders/draft/cancel/v0
Тестовый стенд
Body
application/json
{
"data": {
"cancelComment": "example",
"cancelReasonKey": "example",
"id": "example"
}
}
|
Name |
Description |
|
data |
Type: OrdersDraftCancelV0Request Example
|
OrdersDraftCancelV0Request
|
Name |
Description |
|
cancelReasonKey |
Type: string Min length: Example: |
|
id |
Type: string Example: |
|
cancelComment |
Type: string | null Example: |
Example
{
"cancelComment": "example",
"cancelReasonKey": "example",
"id": "example"
}
Responses
200 OK
OK
Body
application/json
{
"data": {}
}
|
Name |
Description |
|
data |
Type: OrdersDraftCancelV0Response Example
|
OrdersDraftCancelV0Response
Type: object
Example
{}
400 Bad Request
Bad Request
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|
Error
|
Name |
Description |
|
info |
Type: object Example
|
|
message |
Type: string Example: |
|
message_code |
Type: string Example: |
Example
{
"info": {},
"message": "example",
"message_code": "example"
}
403 Forbidden
Forbidden
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|
500 Internal Server Error
Internal Server Error
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|