retailCRM Документация

Порядок интеграции складской системы и фулфилмента через API

Возможности интеграции

  1. Получение остатков и закупочных цен
  2. Обновление остатков и закупочных цен
  3. Обновление остатков и закупочных цен, инициирумое системой
  4. Получение информации о товарах
  5. Получение информации об отгрузке заказа

Работа с API производится в соответствии с правилами работы с API. Для интеграции используются API-методы секции Склад.

Регистрация и конфигурация складской системы

Для регистрации и конфигурации складской системы необходимо использовать метод POST /api/v5/integration-modules/{code}/edit. Если модуль с кодом {code} уже существует, метод меняет его настройки, в противном случае создается новый интеграционный модуль складской системы. Текущие параметры модуля можно посмотреть используя метод GET /api/v5/integration-modules/{code}.

При регистрации системы необходимо указать название integrationModule[name], код integrationModule[code], базовый url integrationModule[baseUrl] и пользовательский идентификатор integrationModule[clientId]. clientId необходим для идентификации пользователя в складской системе при совершении callback-запросов. Так же можно указать логотип складской системы integrationModule[logo], который будет отображаться в списке интеграций в разделе Маркетплейс.

Для активации callback-методов необходимо передать настройки нужного callback-метода в integrationModule[integrations][store][actions]. Для каждого метода необходимо указать код code, url. Адрес для запроса будет собираться из integrationModule[baseUrl] базовой конфигурации и url конкретного метода.

Ниже приведены доступные callback-методы.

Конфигурирование загрузки остатков

Для конфигурации загрузки остатков в методе POST /api/v5/integration-modules/{code}/edit нужно указать код метода inventoriesUpload в массиве integrationModule[integrations][store][actions]. Так же необходимо указать точки вызова integrationModule[integrations][store][actions][][callPoints], в которых будет инициироваться запрос:

Получение остатков и закупочных цен

Метод GET /api/v5/store/inventories позволяет получать информацию об остатках и закупочных ценах для торговых предложений. Для каждого торгового предложения возвращается информация об остатках и закупочных ценах в разрезе складов.

Обновление остатков и закупочных цен

Метод POST /api/v5/store/inventories/upload позволяет обновлять остатки и закупочные цены по складам для торговых предложений. Метод можно использовать как для мгновенного обновления остатков для небольшой порции товаров, так и для периодического обновления остатков по всему каталогу. В последнем случае необходимо передавать остатки порциями не более 250 товарных предложений за запрос до полного обноления каталога.

Обновление остатков и закупочных цен, инициирумое системой

Callback-метод POST {configuration["actions"]["inventoriesUpload"]["url"]} позволяет обновлять остатки и закупочные цены по складам для торговых предложений. Для использования метода необходимо зарегистрировать складскую систему через API. Вызов метода инициируется системой при определенных действиях, которые можно настроить при конфигурации складской системы.

Получение информации о товарах

Метод GET /api/v5/store/product-groups позволяет получить список групп товаров.

Метод GET /api/v5/store/products позволяет получать информацию о товарах и их товарных предложениях.

Метод GET /api/v5/store/products/properties позволяет получить список свойств товаров.

Получение информации об отгрузке заказа

В случае работы с внешней складской системой отгрузка должна происходить на стороне складской системы. Для передачи информации об отгрузке заказа из складской системы необходимо использовать метод POST /api/v5/orders/{externalId}/edit. Необходимо передавать флаг отгрузки order[shipped], склад отгрузки order[shipmentStore], дату отгрузки order[shipmentDate].

Важно: поле order[shipped] доступно для редактирования в API только при условии зарегистрированной складской системы.


Редакция от 14.11.2017 13:58