orders/setSynced

Метод: POST

Подтверждение успешной синхронизации заказов.

Метод принимает список заказов и отмечает их как синхронизированные.

Для каждого заказа необходимо передать его идентификатор и версию, полученную ранее через методы:

orders/get;
orders/getAll;
orders/getModified.

Параметры

Параметры передаются в теле запроса в формате JSON.

Тело запроса представляет собой массив объектов.

Тип	Название	Значение
string, обязательное поле	id	Идентификатор заказа
integer, обязательное поле	version	Версия данных заказа

Как работает метод

Заказ будет отмечен как синхронизированный только в том случае, если одновременно совпадают:

идентификатор заказа;
версия заказа.

Если после получения заказа его данные изменились, версия станет другой. В этом случае устаревший запрос не отметит новую версию заказа как синхронизированную.

Это защищает от ситуации, когда внешняя система подтверждает обработку старых данных заказа.

Результат

После успешного выполнения метод возвращает положительный результат без дополнительных данных.

Коды ошибок

В ходе выполнения запроса могут возникнуть общие ошибки. Их описание находится на отдельной странице.

Пример запроса

https://api.laim.bz/1.0/orders/setSynced

Тело запроса

[
  {
    "id": "b11219bf-11c3-44c7-b733-1729e91e03c8",
    "version": 1595823441
  },
  {
    "id": "4199445e-a603-421d-8465-2ad4ea314295",
    "version": 1595823500
  }
]

Пример ответа

{
  "success": true
}

Обратите внимание

Метод позволяет передать несколько заказов одним запросом.

Для каждого заказа необходимо использовать актуальное значение поля version.

Если версия заказа не совпадает с текущей версией в ЛЭЙМ, статус синхронизации этого заказа не изменится.

Метод не сообщает отдельно, какие заказы были отмечены как синхронизированные, а какие были пропущены из-за несовпадения идентификатора или версии.

После вызова метода можно повторно запросить orders/getModified, чтобы проверить, остались ли заказы, ожидающие синхронизации.

ЛЭЙМ БИЗНЕС

Войти