CloudWarehouseAPI

16.11.2021 © Cloud Commerce

Документация CloudWarehouseAPI v.1.2

Инструкция по использованию программного интерфейса системы управления фулфиллмент складом компании “Клауд Коммерс”

Общие сведения
Ошибки
Константы
- GET QualityList - группы качества товара
- GET DeliveryTypeList - способы доставки
- GET PackTypeList - типы упаковочных материалов
Чтение справочников
- GET GoodsList - чтение информации из справочника “Товары”
- GET GoodsGroupsList - чтение информации из справочника “Группы товаров”
- GET MeasurementUnitList - чтение информации из справочника “Единицы измерения”
- GET PackagingList - чтение информации из справочника “Упаковка”
- GET TZoneList - чтение информации из справочника “Температурные зоны”
- GET WarehouseList - чтение информации из справочника “Склады”
Изменение справочников
- POST GoodsModify - создание/редактирование товаров
- POST GoodsMUnitModify - создание/редактирование единиц измерения товара
- POST GoodsBarcodeModify - создание/редактирование штрих кода товара
- POST GoodsBatchModify - создание/редактирование информации о партиях товара
- POST PackagingModify - создание/редактирование видов упаковок
Чтение документов
- GET PlanInboundList - реестр документов “План прихода”
- GET FactInboundList - реестр документов “Факт прихода”
- GET OrdersList - реестр документов “Заказ”
- GET DocStatusList - получение истории статусов документа по номеру
Изменение документов
- POST OrdersModify - создание/изменение заказа на комплектацию
- POST OrdersItemModify - создание/изменение спецификации к заказу
- POST OrdersFileModify - создание/изменение файлов к заказу
- POST OrdersDelete - удаление одного заказа
- POST PlanInboundModify - создание/изменение плана прихода
- POST PlanInboundItemModify - создание/изменение спецификации к плану прихода
Отчеты
- GET GoodsStock - текущие остатки товаров

1. Общие сведения

Спасибо, что пользуетесь услугами компании “Клауд Коммерс”!

В этом документе описан API интерфейс - CloudWarehouseAPI - системы управления (WMS) фулфиллмент складом нашей компании. Интерфейс веб-сервиса реализован на основе протокола REST с использованием формата JSON.

Работа с программным интерфейсом осуществляется по защищенному протоколу HTTPS. Доступ к CloudWarehouseAPI по адресу:

    https://api.cloudcommerce.zd.ua/wms/v1

Для работы с API необходимо использовать индивидуальный уникальный ключ (APIKEY), который генерируется при регистрации клиента в системе управления складом. Тестирование веб-сервиса можно выполнять с APIKEY тестового клиента:

    83F5428CBAE296FFE0509CB9CB2A24EB

С помощью этого ключа можно создавать, удалять, редактировать любые объекты в “песочнице” системы управления складом (WMS).

Для ознакомления с функционалом API, рекомендуем использовать программу Postman.

В CloudWarehouseAPI v1 используются два типа запросов - GET и POST.

С помощью GET запросов осуществляется получение информации: справочников, актуальных остатков, выполнение заказов и других операций в системе управления складом (WMS).

С помощью POST запросов создаются, изменяются и удаляются объекты в справочниках, заказы, документы в системе управления складом (WMS).

Вызов GET методов:

    https://api.cloudcommerce.zd.ua/wms/v1/<MethodName>?APIKEY={{API_KEY}}&{{PARAMS}}

Где:
- <MethodName> - наименование вызываемого метода
- {{API_KEY}} - уникальный ключ доступа
- {{PARAMS}} - дополнительные параметры, разделяемые знаком & (зависит от метода)

В случае успешного выполнения запроса, возвращается код HTTP ответа - 200 (https://developer.mozilla.org/ru/docs/Web/HTTP/Status)

Пример:

    https://api.cloudcommerce.zd.ua/wms/v1/WarehouseList?APIKEY=83F5428CBAE296FFE0509CB9CB2A24EB

Вызов POST методов:

    https://api.cloudcommerce.zd.ua/wms/v1/<MethodName>

Где:
- <MethodName> - наименование вызываемого метода
- в заголовке запроса указывается параметр Content-Type со значением application/json - в теле запроса передаются данные в формате JSON с указанием необходимых параметров

Пример:

    https://api.cloudcommerce.zd.ua/wms/v1/FactInboundList

    JSON:
    {
        "p_api_key": "83F5428CBAE296FFE0509CB9CB2A24EB",
        "p_id": null,
        "p_doc_date_from": "",
        "p_doc_date_to": "",
        "p_ext_sys_guid": "",
        "p_plan_inbound_ext_sys_docnum": null
    }

В случае успешного выполнения запроса, возвращается код HTTP ответа - 200 (https://developer.mozilla.org/ru/docs/Web/HTTP/Status)

Примечание: * - обозначение обязательных полей в тексте описания методов

Вопросы и предложения по использованию программного интерфейса направляйте по адресу api@cloudcommerce.zd.ua

Оглавление

2. Ошибки

В случае передачи неверных данных, API возвратит код ошибки выполнения запроса HTTP (400, 401, 404, 409, 500 - https://developer.mozilla.org/ru/docs/Web/HTTP/Status) и одно из сообщений об ошибке.

Ошибка: неверный APIKEY (код 401) - в запросе передан неверный уникальный индивидуальный ключ доступа

{
    "response": {},
    "status": {
        "code": "error",
        "message": "API-ключ ’73F5428CBAE296FFE0509CB9CB2A24E0’ не найден"
    }
}

Ошибка: Данные не найдены (код 404) - в системе отсутствуют запрошенные данные

{
    "response": {},
    "status": {
        "code": "error",
        "message": "Данные не найдены"
    }
}

Ошибка: Пустой запрос (код 400) - не переданы параметры, пустой JSON

    {
        "response": {},
        "status": {
            "code": "error",
            "message": "Пустой запрос"
        }
    }

Ошибка: Ошибка парсинга поля (код 400) - неверное значение/тип данных в поле

    {
        "response": {},
        "status": {
            "code": "error",
            "message": "Ошибка парсинга поля "<имя_поля>" ("<ключ>") - <информация об ошибке>"
        }
    }

Ошибка: Не задано значение для обязательного поля (код 400) - не указано значение обязательного поля в JSON

    {
        "response": {},
        "status": {
            "code": "error",
            "message": "Не задано значение для обязательного поля "<имя_поля>" ("<ключ>")"
        }
    }

Ошибка: Неверный формат даты (код 400) - дата в поле JSON указана в не правильном формате

    {
        "response": {},
        "status": {
            "code": "error",
            "message": "Ошибка в поле "<имя_поля>", неверная дата "<значение>". Укажите дату в формате "<формат_даты>""
        }
    }

Ошибка: Нельзя изменить/записать данные | объект уже существует (код 409) - попытка удаления, изменения, записи данных, когда это сделать не возможно. Например, изменение заказа, когда он передан в работу, или попытка создать товар с номером артикула, который существует у другого товара, и т.д.

    {
        "response": {},
        "status": {
            "code": "error",
            "message": "Упаковка с артикулом "Гофроящ.зефир(188)" уже существует"
        }
    }

Ошибка: Ошибка базы данных (код 500) - во время обращения к базе данных произошла ошибка, либо найдено несколько записей, которые должны быть уникальны.

    {
        "response": {},
        "status": {
            "code": "error",
            "message": "Ошибка базы данных во время поиска партнера по API-ключу"
        }
    }

Оглавление

3. Константы

GET QualityList

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

https://api.cloudcommerce.zd.ua/wms/v1/QualityList?APIKEY={{string}}

Параметры

    Запрос:
        APIKEY=<string> - индивидуальный API ключ клиента*

    Ответ:
        "id": <number>   - код группы качества
        "name": <string> - наименование группы качества
        "stype": <number> - тип качества
        "status": <object>   - статус запроса
        "code": <string> - код статуса выполнения
        "message": <string> - информационное сообщение

Успешно

    {
        "response": {
            "quality": [
        {
            "id": 1,
            "name": "Кондиция",
            "stype": 1
        },
        {
            "id": 4,
            "name": "Брак",
            "stype": 2
        }
            ]
        },
        "status": {
            "code": "ok",
            "message": null
        }
    }

16.11.2021 © Cloud Commerce

Документация CloudWarehouseAPI v.1.2

Инструкция по использованию программного интерфейса системы управления фулфиллмент складом компании “Клауд Коммерс”

ОГЛАВЛЕНИЕ

1. Общие сведения

2. Ошибки

3. Константы

GET QualityList

GET DeliveryTypeList

GET PackTypeList

4. Чтение справочников

GET GoodsList

GET GoodsGroupsList

GET MeasurementUnitList

GET PackagingList

GET TZoneList

GET WarehouseList

5. Модификация справочников

POST GoodsModify

POST GoodsMUnitModify

POST GoodsBarcodeModify

POST GoodsBatchModify

POST PackagingModify

6. Чтение документов

GET PlanInboundList

GET FactInboundList

GET OrdersList

GET DocStatusList

7. Изменение документов

POST OrdersModify

POST OrdersItemModify

POST OrdersFileModify

POST OrdersDelete

POST PlanInboundModify

POST PlanInboundItemModify

8. Отчеты

GET GoodsStock