purchases/setSynced

Метод: POST

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

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

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

purchases/get;
purchases/getAll;
purchases/getModified.

Параметры

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

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

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

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

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

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

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

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

Результат

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

Коды ошибок

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

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

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

Тело запроса

[
  {
    "id": "6f275c25-60c3-45ea-90e2-94fe5a493027",
    "version": 1595823441
  },
  {
    "id": "935154f3-9b45-4c5c-864f-d720996ad22a",
    "version": 1595823500
  }
]

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

{
  "success": true
}

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

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

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

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

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

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

ЛЭЙМ БИЗНЕС

Войти