Отозвать исполняемый заказ со стороны заказчика

Порядок работы для агента · Методы API и схема OpenAPI.

НазначениеНазначение

Для заказа в onExecute передайте data.id и обязательный data.cancelReasonKey из справочника причин отзыва заказчиком. Флаг data.cancelActiveTasks управляет отменой задач АРУ. Задачи рейса могут быть отозваны отдельно, если первая погрузка ещё не завершена.

Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде example показывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.

RequestRequest

https://partner-test-yamagistrali.ru/api/orders/onExecute/revokeByForwarder/v0

{
  "data": {
    "cancelActiveTasks": true,
    "cancelComment": "example",
    "cancelReasonKey": "example",
    "id": "example"
  }
}

{
  "cancelActiveTasks": true,
  "cancelComment": "example",
  "cancelReasonKey": "example",
  "id": "example"
}

{
  "cancelActiveTasks": true,
  "cancelComment": "example",
  "cancelReasonKey": "example",
  "id": "example"
}

ResponsesResponses

{
  "data": {}
}

{}

{}

{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

{
  "info": {},
  "message": "example",
  "message_code": "example"
}

{}

{
  "info": {},
  "message": "example",
  "message_code": "example"
}

{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

{
  "info": {},
  "message": "example",
  "message_code": "example"
}

{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

{
  "info": {},
  "message": "example",
  "message_code": "example"
}