Получить причины отмены черновика
Порядок работы для агента · Методы API и схема OpenAPI.
Назначение
Выберите согласованную причину из data.reasons и передайте её reasonKey в data.cancelReasonKey при отмене черновика.
Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде
exampleпоказывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.
Request
GET
https://partner-test-yamagistrali.ru/api/dicts/order/v0/reasonOrderCancel
Тестовый стенд
Responses
200 OK
OK
Body
application/json
{
"data": {
"reasons": [
{
"name": "example",
"reasonKey": "example"
}
]
}
}
|
Name |
Description |
|
data |
Type: DictsOrderV0ReasonOrderCancelResponse Example |
ReasonOrderCancel
|
Name |
Description |
|
name |
Type: string Example: |
|
reasonKey |
Type: string Example: |
Example
{
"name": "example",
"reasonKey": "example"
}
DictsOrderV0ReasonOrderCancelResponse
|
Name |
Description |
|
reasons |
Type: ReasonOrderCancel[] | null Example |
Example
{
"reasons": [
{
"name": "example",
"reasonKey": "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 |