Обновление API: январь 2023

15.01.23 — В статье описаны изменения, которые будут затронуты в API предстоящим обновлением.

Уважаемые пользователи, в ночь с 28 на 29 января 2023 года ожидается глобальное  обновление системы LiveSklad, в результате которого будут затронуты действующие функции API.

Просим вас подготовится к обновлению и утром 29 января заменить старые функции  на новые.

Текущая документация API (без изменений).

Что именно изменится:

Во всех запросах появилось поле "expireDate", в нем содержится время, в которое произойдет обновление ограничений. В случае нормальной работы с API там будет время, в которое произойдет обновление лимита запросов. В случае блокировки API там будет время, в которое произойдет разблокировка.

Изменения в запросах:

 GET https://api.livesklad.com/shops/{id}/sales

Изменилось "data[].cash", теперь оно имеет формат:


 summ: 100 

Удалены поля:

  • data[].isBank
  • data[].isMoney
  • data[].shop

 GET https://api.livesklad.com/documents/{id}

Изменилось поле "data.customer", теперь оно имеет формат:


 id: “5a44dbcad05dbceff65c1f7f” 
 name: “Фамили Имя” 

Поле "productHistories" переименовано в "positions"

В поле "positions[].batches" содержится информация о партиях которые были использованы в данной позиции.

Вместо уникального идентификатора позиции "positions[].id" теперь используется "positions[].positionId". Поле "positions[].id" удалено.


 GET https://api.livesklad.com/shops/{id}/orders 
 GET https://api.livesklad.com/company/orders

Удалены поля:

  • data[].createManagerId
  • data[].closeManagerId
  • data[].managerId
  • data[].masterId
  • data[].typeOrderId
  • data[].shopId
  • data[].counteragentId
  • data[].statusId

Изменились поля:

  • data[].createManager
  • data[].closeManager
  • data[].manager
  • data[].master

Теперь они имеют формат:


 id: “5a44dbcad05dbceff65c1f7f” 
 name: “Фамили Имя” 

Изменилось поле "data[].typeOrder", теперь оно имеет формат:


 id: “5a44dbcad05dbceff65c1f7f” 
 name: “Платный” 


Изменились поля:

  • data[].shop
  • data[].counteragent
  • data[].status

В них добавлено вложенное поле id:


 id: “5a44dbcad05dbceff65c1f7f”, 
 … 

Изменилось поле "data[].cash", теперь оно имеет формат:


 summ: 100 

Изменилось поле "data[].summ", теперь оно имеет формат:


 price: 100, 
 soldPrice: 100 


 POST https://api.livesklad.com/shops/{id}/orders 

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


 GET https://api.livesklad.com/orders/{id} 

Изменились поля:

  • data.master
  • data.manager
  • data.createManager
  • data.closeManager

Теперь они имеют формат:


 id: “5a44dbcad05dbceff65c1f7f” 
 name: “Фамили Имя” 

Поле "data.workProducts" переименовано в "data.positions".

В поле "positions[].batches" содержится информация о партиях которые были использованы в данной позиции.

Вместо уникального идентификатора позиции "positions[].id" теперь используется "positions[].positionId". Поле "positions[].id" удалено.

Удалены поля:

  • positions[].productId
  • positions[].purchasePrice

Добавлены поля:

  • positions[].isWork
  • positions[].purchasePriceSumm

Поле "positions[].orderPrice" переименовано в "positions[].price".

Поле "positions[].price" переименовано в "positions[].soldPrice".


На этом все, документация к API будет также обновлена после выхода обновления.
Спасибо за уделенное время.
С уважением, команда LiveSklad.