Получить изменения заказов исполнителя

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

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

Получите порцию изменений после сохранённого курсора. Для первого запроса выберите границу синхронизации и получите начальный курсор через POST /api/orders/changesForExecutors/getLastLogId/v0. Запись ленты сообщает об изменении. За актуальным состоянием заказа обращайтесь к методу деталей.

Метод: POST /api/orders/changesForExecutors/get/v0

ДоступДоступ

Нужны роль exec и право view_all_orders_exec. В выборку входят только доступные организации-исполнители.

Входные данныеВходные данные

Укажите executorId, если нужна одна доступная организация. Если поле опущено, метод проверяет все доступные организации-исполнители. Параметр может только сузить область доступа.

lastId — исключающая нижняя граница. В ответ попадают только изменения с id > lastId. Если параметр опущен, используется 0.

Если право чтения есть в другой организации, запрос с недоступным executorId может вернуть пустой список. При отсутствии права во всех организациях метод возвращает 403.

limit задаёт максимальный размер одной порции. Значение по умолчанию — 100. Значения выше 1000 ограничиваются 1000.

РезультатРезультат

Обрабатывайте записи в порядке возрастания id. После успешной обработки всей порции сохраните последний changes[].id как следующий lastId. Для курсора нужен идентификатор изменения. Ответ не содержит общего числа записей или отдельного признака следующей страницы.

Успешный ответ с changes: [] или допустимым по схеме changes: null не содержит записей. Сохраните текущий курсор для следующего вызова. Если ключ changes отсутствует, проверьте ответ перед продолжением.

changes[].updatedAt — время изменения.

changes[].executorId — идентификатор организации, связанной с изменением.

changes[].orderId — идентификатор изменившегося заказа. Выберите нужные идентификаторы и передайте их как exactOrderIds в POST /api/orders/v0/transferOrder/getFlatForExecutor. Перед запросом можно убрать повторы, чтобы уменьшить его размер. Описывайте статус, маршрут, груз и участников по ответу метода деталей.

Повтор запросаПовтор запроса

Метод только читает данные. Повторяйте запрос после временных сетевых ошибок и ошибок сервера. При ошибке доступа сначала устраните её причину.

Работа с чувствительными даннымиРабота с чувствительными данными

Выбирайте только идентификаторы, нужные для задачи. Передавайте исходные значения в ответ пользователю, контекст ИИ или внешнюю систему только по явному запросу, при подтверждённой необходимости и с действующим доступом. Исключите исходные значения из журналов, трассировок, метрик и диагностики. Используйте синтетические идентификаторы в примерах.

Проверенные примерыПроверенные примеры

Пример содержит синтетические данные. Для проверки документации используйте его без вызова рабочего сервиса.

Следующая порция изменений · синтетический пример

Две синтетические записи показывают порядок и продолжение чтения по курсору.

Запрос

{
  "data": {
    "executorId": "executor-example",
    "lastId": 42000,
    "limit": 2
  }
}

Сокращённый ответ

{
  "data": {
    "changes": [
      {
        "id": 42001,
        "updatedAt": "2000-01-02T00:01:00Z",
        "executorId": "executor-example",
        "orderId": "0-example-0000-00-00-001"
      },
      {
        "id": 42002,
        "updatedAt": "2000-01-02T00:02:00Z",
        "executorId": "executor-example",
        "orderId": "0-example-0000-00-00-002"
      }
    ]
  }
}

Ответ при отсутствии новых изменений.

{
  "data": {
    "changes": []
  }
}

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

RequestRequest

https://partner-test-yamagistrali.ru/api/orders/changesForExecutors/get/v0

{
  "data": {
    "executorId": "example",
    "lastId": 0,
    "limit": 0
  }
}

{
  "executorId": "example",
  "lastId": 0,
  "limit": 0
}

{
  "executorId": "example",
  "lastId": 0,
  "limit": 0
}

ResponsesResponses

{
  "data": {
    "changes": [
      {
        "executorId": "example",
        "id": 0,
        "orderId": "example",
        "updatedAt": "2025-07-22T20:21:19.773333823Z"
      }
    ]
  }
}

{
  "changes": [
    {
      "executorId": "example",
      "id": 0,
      "orderId": "example",
      "updatedAt": "2025-07-22T20:21:19.773333823Z"
    }
  ]
}

{
  "executorId": "example",
  "id": 0,
  "orderId": "example",
  "updatedAt": "2025-07-22T20:21:19.773333823Z"
}

[
  {
    "executorId": "example",
    "id": 0,
    "orderId": "example",
    "updatedAt": "2025-07-22T20:21:19.773333823Z"
  }
]

{
  "changes": [
    {
      "executorId": "example",
      "id": 0,
      "orderId": "example",
      "updatedAt": "2025-07-22T20:21:19.773333823Z"
    }
  ]
}

{
  "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"
}