Получить начальный курсор изменений заказов заказчика

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

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

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

Метод: POST /api/orders/changesForForwarders/getLastLogId/v0

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

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

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

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

toTime — исключающая граница в формате RFC 3339. Метод ищет последнее изменение строго до указанного времени. Если параметр опущен, граница устанавливается за 32 дня до обработки запроса.

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

id — курсор журнала изменений. Передайте его как lastId в POST /api/orders/changesForForwarders/get/v0. Метод ленты возвращает изменения с большим идентификатором. Для деталей выберите orderId из записей ленты и передайте их как exactOrderIds в POST /api/orders/v0/transferOrder/getFlatForCustomer. Перед запросом деталей можно убрать повторяющиеся идентификаторы. Описывайте заказ по ответу метода деталей.

Успешный ответ с id: 0 означает, что до границы в выбранной области нет изменений. Используйте 0 как начальный lastId.

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

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

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

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

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

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

Начальный курсор для одной организации · синтетический пример

Синтетический пример запрашивает последний идентификатор изменения перед явно заданным моментом времени.

Запрос

{
  "data": {
    "forwarderId": "example-forwarder-org",
    "toTime": "2030-01-15T12:00:00Z"
  }
}

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

{
  "data": {
    "id": 1001
  }
}

Ответ при отсутствии более раннего изменения.

{
  "data": {
    "id": 0
  }
}

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

RequestRequest

https://partner-test-yamagistrali.ru/api/orders/changesForForwarders/getLastLogId/v0

{
  "data": {
    "forwarderId": "example",
    "toTime": "2025-07-22T20:21:19.773333823Z"
  }
}

{
  "forwarderId": "example",
  "toTime": "2025-07-22T20:21:19.773333823Z"
}

{
  "forwarderId": "example",
  "toTime": "2025-07-22T20:21:19.773333823Z"
}

ResponsesResponses

{
  "data": {
    "id": 0
  }
}

{
  "id": 0
}

{
  "id": 0
}

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