01.07.2020/v1.0 © Cloud Commerce
Документация CloudWarehouseAPI v.1.0.0
Инструкция по использованию программного интерфейса системы управления услугами фулфиллмент склада компании “Клауд Коммерс”
ОГЛАВЛЕНИЕ
- Константы
- GET DocStatusList - виды операций с товаром, документов и их статусы
- GET QualityList - группы качества товара
- GET DeliveryTypeList - способы доставки
- GET PackTypeList - типы упаковочных материалов
- Чтение справочников
- GET GoodsList - чтение информации из справочника “Товары”
- GET GoodsCharsList - чтение информации из справочника “Характеристики товара”
- GET GoodsGroupsList - чтение информации из справочника “Группы товаров”
- GET MeasurementUnitList - чтение информации из справочника “Единицы измерения”
- GET PackagingList - чтение информации из справочника “Упаковка”
- GET TZoneList - чтение информации из справочника “Температурные зоны”
- GET WarehouseList - чтение информации из справочника “Склады”
- Изменение справочников
- POST GoodsModify - создание/редактирование товаров
- POST GoodsMUnitModify - создание/редактирование единиц измерения товара
- POST GoodsBarcodeModify - создание/редактирование штрих кода товара
- POST GoodsGroupsModify - создание/редактирование групп товаров
- POST GoodsCharsModify - создание/редактирование характеристик товара
- POST GoodsBatchModify - создание/редактирование информации о партиях товара
- POST PackagingModify - создание/редактирование видов упаковок
- Чтение документов
- GET PlanInboundList - реестр документов “План прихода”
- GET FactInboundList - реестр документов “Факт прихода”
- GET OrdersList - реестр документов “Заказ”
- GET ProcReqList - реестр документов “Заявка на обработку товара”
- Изменение документов
- POST OrdersModify - создание/изменение заказа на комплектацию
- POST OrdersItemModify - создание/изменение спецификации к заказу
- POST OrdersFileModify - создание/изменение файлов к заказу
- POST OrdersDelete - удаление одного заказа
- POST OrdersCancel - отмена заказа
- POST PlanInboundModify - создание/изменение плана прихода
- POST PlanInboundItemModify - создание/изменение спецификации к плану прихода
- POST PlanInboundCancel - отмена плана приема
- POST ProcReqModify - создание/изменение заявки на обработку товара
- [POST ProcReqCancel][pprc] - отмена заявки на обработку товара
- Отчеты
- GET GoodsTurns - оборотная ведомость и остатки товаров за период
- GET GoodsStock - текущие остатки товаров
1. Общие сведения
Спасибо, что пользуетесь услугами компании “Клауд Коммерс”!
В этом документе описан API интерфейс - CloudWarehouseAPI - системы управления (WMS) фулфиллмент складом нашей компании. Интерфейс веб-сервиса реализован на основе протокола REST с использованием формата JSON.
Рекомендуем работать с программным интерфейсом по защищенному протоколу HTTPS. Протокол HTTP не безопасен и поддерживается для совместимости. Доступ к CloudWarehouseAPI осуществляется по адресу:
https://cloudcommerce.zd.ua/API/CloudWarehouse/
Для работы с API необходимо использовать индивидуальный уникальный ключ (APIKEY), который генерируется при регистрации клиента в системе управления складом. Тестирование веб-сервиса можно выполнять с APIKEY тестового клиента:
8ABA6F71D6D83FB8E055000000000001
С помощью этого ключа можно создавать, удалять, редактировать любые объекты в “песочнице” системы управления складом (WMS).
Для ознакомления с функционалом API, рекомендуем использовать программу Postman.
В CloudWarehouseAPI используются два типа запросов - GET и POST.
С помощью GET запросов осуществляется получение информации: справочной, о движении товаров, актуальных остатках, выполнении заказов, о статусе документов и других операций в системе управления складом (WMS) компании “Клауд Коммерс”.
С помощью POST запросов создаются, изменяются и удаляются объекты в справочниках, заказы, документы в системе управления складом (WMS) компании “Клауд Коммерс”.
Вызов GET методов:
https://cloudcommerce.zd.ua/API/CloudWarehouse/<MethodName>?APIKEY={{API_KEY}}&{{PARAMS}}
Где:
- <MethodName> - наименование вызываемого метода
- {{API_KEY}} - уникальный ключ доступа
- {{PARAMS}} - дополнительные параметры, разделяемые знаком & (зависит от метода)
Пример:
https://cloudcommerce.zd.ua/API/CloudWarehouse/WarehouseList?APIKEY=8ABA6F71D6D83FB8E055000000000001
Вызов POST методов:
https://cloudcommerce.zd.ua/API/CloudWarehouse/<MethodName>
Где:
- <MethodName> - наименование вызываемого метода
- в заголовке запроса указывается параметр Content-Type со значением application/json
- в теле запроса передаются данные в формате JSON с указанием необходимых параметров
Пример:
https://cloudcommerce.zd.ua/API/CloudWarehouse/FactInboundList
JSON:
{
"p_api_key": "8ABA6F71D6D83FB8E055000000000001",
"p_id": null,
"p_doc_date_from": "",
"p_doc_date_to": "",
"p_ext_sys_guid": "",
"p_plan_inbound_ext_sys_docnum":null
}
Примечание: * - обозначение обязательных полей в тексте описания методов
Вопросы и предложения по использованию программного интерфейса направляйте по адресу api@cloudcommerce.zd.ua
2. Ошибки
В случае передачи неверных данных, API возвратит одно из сообщений об ошибке.
Ошибка: неверный APIKEY - в запросе передан неверный уникальный индивидуальный ключ доступа
{
"response": {},
"status": {
"code": "error",
"message": "API-ключ ’8ABA6F71D6D83FB8E055000000000002’ не найден"
}
}
Ошибка: Данные не найдены - в системе отсутствуют запрошенные данные
{
"response": {},
"status": {
"code": "error",
"message": "Данные не найдены"
}
}
Ошибка: Пустой запрос - не переданы параметры, пустой JSON
{
"response": {},
"status": {
"code": "error",
"message": "Пустой запрос"
}
}
3. Константы
GET DocStatusList
Метод используется для получение перечня допустимых операций с товаром, связанных документов и их статусов.
https://cloudcommerce.zd.ua/API/CloudWarehouse/DocStatusList?APIKEY={{API_KEY}}
Параметры
Запрос:
APIKEY=<string> - индивидуальный API ключ клиента
Ответ:
"doc_status": <array> - перечень документов
"doc_type_id": <string> - внутренний идентификатор документа
"doc_type_name" <string> - наименование документа
"operation_type": <array> - перечень типов операций
"id": <number> - внутренний идентификатор операции
"name": <string> - наименование операции
"status_list": <array> - перечень статусов документов
"id": <number> - внутренний идентификатор статуса
"name": <string> - наименование статуса
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
{
"response": {
"docs_status":[
{
"doc_type_id": "1",
"doc_type_name": "План приема",
"operation_type": [
{
"id":35,
"name": "Прием товара"
},
{
"id":36,
"name": "Возврат товара"
}
],
"status_list": [
{
"id": 1,
"name": "Создан"
},
{
"id":2,
"name": "Поставка прибыла на склад"
},
{
"id":3,
"name": "В работе"
},
{
"id":4,
"name": "Завершен"
},
{
"id":5,
"name":"Отменен"
}
]
},
{
"doc_type_id": "2",
"doc_type_name": "Прием",
"operation_type": [
{
"id": 33,
"name": "Прием товара"
},
{
"id": 34,
"name": "Возврат товара"
}
],
"status_list": [
{
"id": 6,
"name": "В работе"
},
{
"id": 7,
"name": "Завершен"
},
{
"id": 8,
"name": "Отменен"
},
{
"id": 34,
"name": "Создан"
}
]
},
{
"doc_type_id": "3",
"doc_type_name": "Заказ",
"operation_type": [
{
"id": 5,
"name": "Заказ B2B"
},
{
"id": 6,
"name": "Заказ B2C"
},
{
"id": 18,
"name": "Заказ кросс-док"
}
],
"status_list": [
{
"id": 9,
"name": "Создан"
},
{
"id": 10,
"name": "В работу"
},
{
"id": 11,
"name": "Спланирован отбор"
},
{
"id": 12,
"name": "Выполнен контроль"
},
{
"id": 13,
"name": "Завершен"
},
{
"id": 14,
"name": "Отменен"
},
{
"id": 18,
"name": "Начат контроль"
},
{
"id": 23,
"name": "Отобран"
},
{
"id":35,
"name": "Не сформирован отбор"
},
{
"id": 36,
"name": "Спланирован отбор частично"
},
{
"id": 37,
"name": "Отсортирован"
},
{
"id": 38,
"name": "Отобран частично"
}
]
}
]
},
"status": {
"code": "ok",
"message":null
}
}
GET QualityList
Метод используется для получение перечня групп и типов качества товара.
https://cloudcommerce.zd.ua/API/CloudWarehouse/QualityList?APIKEY={{API_KEY}}
Параметры
Запрос:
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
},
{
"id": 5,
"name": "Бой",
"stype": 2
}
]
},
"status": {
"code": "ok",
"message": null
}
}
GET DeliveryTypeList
Метод используется для получения списка доступных способов доставки заказов - самовывозом, курьерскими службами (с интеграцией и без).
https://cloudcommerce.zd.ua/API/CloudWarehouse/DeliveryTypeList?APIKEY={{API_KEY}}
Параметры
Запрос:
APIKEY=<string> - индивидуальный API ключ клиента
Ответ:
"id": <number> - код типа доставки
"name": <string> - наименование типа доставки
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
{
"response": {
"delivery_type": [
{
"id": 1,
"name": "Самовывоз"
}
]
},
"status": {
"code": "ok",
"message": ""
}
}
GET PackTypeList
Метод используется для получения перечня типов упаковочных материалов.
https://cloudcommerce.zd.ua/API/CloudWarehouse/PackTypeList?APIKEY={{API_KEY}}
Параметры
Запрос:
APIKEY=<string> - индивидуальный API ключ клиента
Ответ:
"id": <number> - код типа упаковки
"name": <string> - наименование типа упаковки
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
{
"response": {
"packtype": [
{
"id": 1,
"name": "закрытый"
},
{
"id": 2,
"name": "экран"
},
{
"id": 3,
"name": "Палета"
},
{
"id": 4,
"name": "гофро"
}
]
},
"status": {
"code": "ok",
"message": ""
}
}
4. Чтение справочников
GET GoodsList
Метод используется для получения списка товаров со стандартными характеристиками из справочника “Товары”, а так же получения информации о товаре по его внутреннему (ID), или внешнему (EXTGUID) номеру.
https://cloudcommerce.zd.ua/API/CloudWarehouse/GoodsList?APIKEY={{API_KEY}}&ID={{ID}}&EXTGUID={{EXTGUID}}
Параметры
Запрос:
APIKEY=<string> - индивидуальный API ключ клиента
ID=<number> - внутренний код товара
EXTGUID=<number> - внешний код товара
Ответ:
"goods":
"id": <number> - внутренний идентификатор товара
"sku": <string> - артикул товара
"name": <string> - наименование товара
"gg_id": <number> - внутренний идентификатор группы товаров (метод для получения значений GoodsGroupsList)
"storage_model": <number> - модель учета (1 - без деления, 2 - по партиям, 3 - по серийным номерам)
"photo_link": <string> - ссылка на фото
"experation_day": <number> - срок реализации в днях (количество дней с даты производства до окончания срока годности)
"tzone_id": <number> - код температурной зоны (метод для получения значений TZoneList)
"ext_sys_guid": <number> - внешний идентификатор товара
"ask_part_number": <number> - признак ввода номера партии при приеме
"batch_date_type": <number> - тип даты партии товара (0-производства/1-реализации)
"picking_qty_min": <number> - минимальный остаток товара в зоне отбора для формирования задания на пополнение (в базовой единице измерения товара)
"manufacturing_date_more": <number> - количество дней с даты производства до текущей даты
"manufacturing_date_last": <number> - количество дней для максимально ранней даты производства с учетом срока реализации товара
"goods_props": <array> - дополнительные свойства товара
"name": <string> - наименование свойства
"value": <string> - значение свойства
"goods_munit": <array> - основные свойства товара
"id": <number> - внутренний код единицы измерения
"ext_sys_guid": <string> - внешний код единицы измерения
"mu_id": <number> - внутренний код справочника единиц измерения (метод для получения справочника MeasurementUnitList)
"pack_id": <number> - внутренний код упаковки (метод для получения справочника PackagingList)
"name": <string> - название единицы измерения
"k": <number> - коэффициент пересчета к базовой единице измерения
"base_unit": <number> - признак базовой единицы измерения (0-нет, 1-да)
"qty_in_layer": <number> - количество (в указанной единице измерения) в слое на паллете
"layers_on_pallet": <number> - количество слоев на паллете
"weight": <number> - вес товара в указанной единице измерения
"length": <number> - длина товара в указанной единице измерения
"width": <number> - ширина товара в указанной единице измерения
"height": <number> - высота товара в указанной единице измерения
"is_active": <number> - активность единицы измерения (0 – не активна; 1 – активна)
"goods_munit_props": <array> - дополнительные свойства
"name": <string> - наименование свойства
"value": <string> - значение свойства
"goods_barcode": <array> - штрих коды товара с привязкой к упаковке и партии
"id": <number> - внутренний идентификатор штрих кода
"goods_munit_id": <number> - внутренний идентификатор единицы измерения (метод для получения справочника GoodsMUnitModify)
"goods_batch_id": <number> - внутренний идентификатор партии (метод для получения GoodsBatchModify)
"sn_flag": <number> - признак, что штрих код - это серийный номер (используется в модели учета товара по серийным номерам, параметр "storage_model": 3)
"barcode": <string> - штрих код товара
"barcode_synonym": <string> - штрих код синоним
"note": <string> - примечание
"ext_sys_guid": <string> - внешний идентификатор штрих кода
"goods_batch": <array> - партия товара
"id": <number> - внутренний идентификатор партии товара
"ext_sys_guid": <string> - внешний идентификатор партии товара
"name": <string> - наименование партии товара
"manufacturing_date": <string> - дата производства
"expiration_date": <string> - дата окончания срока годности
"part_number": <string> - номер партии
"haccp": <string> - HACCP
"goods_chars": <array> - характеристики товара
"id": <number> - внутренний идентификатор сборного названия характеристики из её значений
"name": <string> - сборное наименование характеристики из её значений
"goods_chars_vals": <array> - список характеристик
"id": <number> - внутренний идентификатор характеристики
"ext_sys_guid": <number> - внешний идентификатор характеристики
"name": <string> - наименование характеристики
"str_value": <string> - значение характеристики
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
{
"response": {
"goods": [
{
"id": 1077229,
"sku": "0023",
"name": "Спец товар СП-01",
"gg_id": null,
"storage_model": 2,
"photo_link": null,
"experation_day": 90,
"tzone_id": null,
"ext_sys_guid": "0023-23",
"ask_part_number": 0,
"batch_date_type": 0,
"picking_qty_min": 10,
"manufacturing_date_more": 2,
"manufacturing_date_last": 5,
"goods_props": [
{
"name": "ЦВЕТ",
"value": "Белый"
}
],
"goods_munit": [
{
"id": 1077230,
"ext_sys_guid": "5625486",
"mu_id": 1,
"pack_id": null,
"name": "шт",
"k": 1,
"base_unit": 1,
"qty_in_layer": 2,
"layers_on_pallet": 1,
"weight": 30,
"length": 500,
"width": 600,
"height": 500,
"is_active": 1,
"goods_munit_props": [
{
"name": "ЦВЕТ",
"value": "Белый"
}
]
}
],
"goods_barcode": [
{
"id": 1077231,
"goods_munit_id": 1077230,
"goods_batch_id": null,
"sn_flag": 0,
"barcode": "3000100022367",
"barcode_synonym": null,
"note": null,
"ext_sys_guid": null
}
],
"goods_batch": [],
"goods_chars": []
}
]
},
"status": {
"code": "ok",
"message": null
}
}
GET GoodsCharsList
Метод используется для получения перечня дополнительных характеристик из справочника “Характеристики товара”.
https://cloudcommerce.zd.ua/API/CloudWarehouse/GoodsCharsList?APIKEY={{API_KEY}}
Параметры
Запрос:
APIKEY=<string> - индивидуальный API ключ клиента
Ответ:
"goods_chars": <array> - перечень характеристик товара
"id": <number> - внутренний идентификатор характеристики
"name": <string> - наименование характеристики
"input_type": <number> - способ ввода (1 - ввод значения, 2 - из списка)
"ext_sys_guid": <number> - внешний идентификатор характеристики
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
{
"response": {
"goods_chars": [
{
"id": "1062642",
"name": "Сырные изделия КЗ Марк",
"input_type": "2",
"ext_sys_guid": "100025486"
}
]
},
"status": {
"code": "ok",
"message": null
}
}
GET GoodsGroupsList
Метод используется для получения перечня используемых групп из справочника “Группы товара”.
https://cloudcommerce.zd.ua/API/CloudWarehouse/GoodsGroupsList?APIKEY={{API_KEY}}
Параметры
Запрос:
APIKEY=<string> - индивидуальный API ключ клиента
Ответ:
"goods_groups": <array> - перечень групп товаров
"id": <number> - внутренний идентификатор группы товаров
"name": <string> - наименование группы товаров
"ext_sys_guid": <string> - внешний идентификатор группы товаров
"goods_groups_chars": <array> - характеристики групп товаров
"chars_id": <number> - внутренний идентификатор характеристики
"chars_ext_sys_guid": <number> - внешний идентификатор характеристики
"chars_name": <string> - наименование характеристики
"use_in_name": <number> - использовать в составном наименовании
"is_required": <number> - обязательность заполнения (1 - да, 0 - нет)
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
{
"response": {
"goods_groups": [
{
"id": 1061418,
"name": "Сырные изделия КЗ Марк",
"ext_sys_guid": "10008569",
"goods_groups_chars": [
{
"chars_id": 1062642,
"chars_ext_sys_guid": "100025486",
"chars_name": "Сырные изделия КЗ Марк",
"use_in_name": 1,
"is_required": 1
}
]
}
]
},
"status": {
"code": "ok",
"message": null
}
}
GET MeasurementUnitList
Метод используется для получения информации из справочника “Единицы измерения”.
https://cloudcommerce.zd.ua/API/CloudWarehouse/MeasurementUnitList?APIKEY={{API_KEY}}
Параметры
Запрос:
APIKEY=<string> - индивидуальный API ключ клиента
Ответ:
"measurement_unit": <array> - перечень единиц измерения
"id": <number> - идентификатор единицы измерения
"name": <string> - наименование единицы измерения
"full_name": <string> - полное название единицы измерения
"cod_kspovo": <string> - код по классификатору КСПОВО
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
{
"response": {
"measurement_unit": [
{
"id": 1,
"name": "шт",
"full_name": "шт",
"cod_kspovo": "2009"
},
{
"id": 2,
"name": "кг",
"full_name": "кг",
"cod_kspovo": "0301"
},
{
"id": 3,
"name": "пара",
"full_name": "пара",
"cod_kspovo": "1617"
},
{
"id": 4,
"name": "партія",
"full_name": "Партія",
"cod_kspovo": "2006"
},
{
"id": 5,
"name": "кор",
"full_name": "Коробка",
"cod_kspovo": "2052"
},
{
"id": 6,
"name": "пляш",
"full_name": "Пляшка",
"cod_kspovo": "2061"
},
{
"id": 7,
"name": "пак",
"full_name": "Пакунок",
"cod_kspovo": "2110"
},
{
"id": 8,
"name": "пач",
"full_name": "Пачка",
"cod_kspovo": "2112"
},
{
"id": 9,
"name": "100 шт",
"full_name": "Сто штук",
"cod_kspovo": "2012"
},
{
"id": 10,
"name": "л",
"full_name": "Літр",
"cod_kspovo": "0138"
},
{
"id": 11,
"name": "м",
"full_name": "Метр",
"cod_kspovo": "0101"
},
{
"id": 12,
"name": "міш",
"full_name": "Мішок",
"cod_kspovo": "2060"
},
{
"id": 13,
"name": "рул",
"full_name": "Рулон",
"cod_kspovo": "2116"
},
{
"id": 14,
"name": "ящ",
"full_name": "Ящик",
"cod_kspovo": "2075"
}
]
},
"status": {
"code": "ok",
"message": ""
}
}
GET PackagingList
Метод используется для получения перечня упаковочных материалов и их характеристик из справочника “Упаковки”.
https://cloudcommerce.zd.ua/API/CloudWarehouse/PackagingList?APIKEY={{API_KEY}}
Параметры
Запрос:
APIKEY=<string> - индивидуальный API ключ клиента
Ответ:
"packaging": <array> - список упаковочного материала
"id": <number> - внутренний идентификатор упаковки
"ext_sys_guid": <string> - внешний идентификатор упаковки
"sku": <string> - артикул упаковки
"name": <string> - название упаковки
"qty_in_layer": <number> - количество в слое на поддоне
"layers_on_pallet": <number> - количество слоев на поддоне
"max_weight": <number> - максимальный вес
"length": <number> - длина
"width": <number> - ширина
"height": <number> - высота
"packtype_id": <number> - внутренний идентификатор типа упаковки
"packtype_name": <number> - наименование типа упаковки
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
{
"response": {
"packaging": [
{
"id": 1,
"ext_sys_guid": "",
"sku": "",
"name": "Паллета",
"qty_in_layer": 1,
"layers_on_pallet": 1,
"max_weight": 2000,
"length": 120,
"width": 80,
"height": 180,
"packtype_id": null,
"packtype_name": null
},
{
"id": 2,
"ext_sys_guid": "111-222-333-444",
"sku": "Гофроящ.зефир(188)",
"name": "Гофроящик зефирный (№188)",
"qty_in_layer": 5,
"layers_on_pallet": 6,
"max_weight": 7,
"length": 8,
"width": 9,
"height": 10,
"packtype_id": null,
"packtype_name": null
}
]
},
"status": {
"code": "ok",
"message": ""
}
}
GET TZoneList
Метод используется для получения информации из справочника “Температурные зоны”.
https://cloudcommerce.zd.ua/API/CloudWarehouse/TZoneList?APIKEY={{API_KEY}}
Параметры
Запрос:
APIKEY=<string> - индивидуальный API ключ клиента
Ответ:
"tzone": <array> - перечень температурных зон
"id": <number> - идентификатор температурной зоны
"name": <string> - название температурной зоны
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
{
"response": {
"tzone": [
{
"id": 1,
"name": "+5℃...+30℃"
},
{
"id": 2,
"name": "0℃...+5℃"
},
{
"id": 1006108,
"name": "-5℃...0℃"
}
]
},
"status": {
"code": "ok",
"message": null
}
}
GET WarehouseList
Данный метод используется для получения кодов и наименований складов из справочника “Склады”, доступных к размещению товаров.
https://cloudcommerce.zd.ua/API/CloudWarehouse/WarehouseList?APIKEY={{API_KEY}}
Параметры
Запрос:
APIKEY=<string> - индивидуальный API ключ клиента
Ответ:
"warehouse": <array> - перечень складов
"id": <number> - идентификатор склада
"name": <string> - наименование склада
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
{
"response": {
"warehouse": [
{,
"id": 3,
"name": "Киев, Малая Кольцевая, 10/1"
}
]
},
"status": {
"code": "ok",
"message": null
}
}
5. Модификация справочников
POST GoodsModify
Метод используется для создания/редактирования карточки товара в справочнике “Товары”.
https://cloudcommerce.zd.ua/API/CloudWarehouse/GoodsModify
Параметры
Запрос:
"p_api_key": <string> - индивидуальный API ключ клиента*
"p_id": <number> - внутренний идентификатор товара
"p_sku": <string> - артикул товара*
"p_name": <string> - наименование товара*
"p_gg_id": <number> - внутренний идентификатор группы товаров (метод для получения справочника GoodsGroupsList)
"p_sm": <number> - модель учета товара: 1 - без деления, 2 - по партиям, 3 - по серийным номерам*
"p_days": <number> - количество дней хранения
"p_link": <string> - cсылка на фото
"p_tzone_id": <number> - код температурной зоны (метод для получения справочника TZoneList)
"p_ext_sys_guid": <string> - внешний идентификатор товара*
"p_gg_ext_sys_guid": <string> - внешний идентификатор группы товаров
"p_ask_part_number": <number> - спрашивать номер партии при приеме: 1 - да, 0 - нет. Поле заполняется только при выборе модели учета по партиям (p_sm=2)
"p_batch_date_type": <number> - тип даты партии: 0 - производства, 1 - реализации. Поле заполняется только при выборе модели учета по партиям (p_sm=2)
"p_goods_type": <number> - тип товара: 1 – штучный, 2 – тара; 3 – дробный
"p_is_large_home_device": <number> - признак крупной бытовой техники: 0 - "Не задано" (по умолчанию); 1 - "Нет"; 2 - "Да"
"p_base_munit": <object> - не обязательный параметр. В объекте передаются параметры для создания базовой единицы измерения.
"p_abc_group": <string> - группа АВС-анализа. Допустимые значения: null, A, B, C
"p_picking_qty_min": <number> - минимальный остаток товара в пикинге (задается в базовой единице измерения товара)
"p_manufacturing_date_more": <number> - количество дней превышения даты производства от текущей даты
"p_manufacturing_date_last": <number> - количество дней для максимально ранней даты производства с учетом срока реализации товара
"p_props": <array> - дополнительные свойства товара
"name": <string> - наименование свойства
"value": <string> - значение свойства
Ответ:
"id": <number> - внутренний идентификатор товара
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
Запрос:
{
"p_api_key": "8ABA6F71D6D83FB8E055000000000001",
"p_id": null,
"p_sku": "0023",
"p_name": "Спец товар СП-01",
"p_gg_id": null,
"p_sm": 2,
"p_days": 90,
"p_link": "",
"p_tzone_id": null,
"p_ext_sys_guid": "0023-23",
"p_gg_ext_sys_guid": null,
"p_ask_part_number": 0,
"p_batch_date_type": 0,
"p_goods_type": 1,
"p_is_large_home_device": 2,
"p_props": [
{
"name": "Цвет",
"value": "Белый"
}
],
"p_base_munit":
{
"p_ext_sys_guid": "5625486",
"p_mu_id": 1,
"p_cod_kspovo": "2009",
"p_pack_id": null,
"p_pack_ext_sys_guid": null,
"p_qty_in_layer": 2,
"p_layers_on_pallet": 1,
"p_weight": 30,
"p_length": 500,
"p_width": 600,
"p_height": 500,
"p_is_active": 1,
"p_props": [
{
"name": "Цвет",
"value": "Белый"
}
]
},
"p_abc_group": null,
"p_picking_qty_min": 10,
"p_manufacturing_date_more": 2,
"p_manufacturing_date_last" : 7
}
Ответ:
{
"response":
{
"id": 1010862
},
"status":
{
"code": "ok",
"message": null
}
}
POST GoodsMUnitModify
Метод используется для создания/редактирования единиц измерения конкретного товара в справочнике “Товары”.
https://cloudcommerce.zd.ua/API/CloudWarehouse/GoodsMUnitModify
Параметры
Запрос:
"p_api_key": <string> - индивидуальный API ключ клиента*
"p_id": <number> - внутренний идентификатор поля
"p_goods_id": <number> - внутренний идентификатор товара
"p_ext_sys_guid": <string> - внешний идентификатор единицы измерения*
"p_goods_ext_sys_guid": <string> - внешний идентификатор товара
"p_mu_id": <number> - внутренний идентификатор словаря единицы измерений (метод для получения справочника MeasurementUnitList, альтернатива параметра p_cod_kspovo)
"p_cod_kspovo": <string> - код единицы измерения по КСПОВО (метод для получения справочника MeasurementUnitList, альтернатива параметра p_mu_id)
"p_pack_id": <number> - внутренний идентификатор упаковки (метод для получения справочника PackagingList)
"p_pack_ext_sys_guid": <string> - внешний идентификатор упаковки
"p_k": <number> - коэффициент пересчета к базовой единице измерения*
"p_base_unit": <number> - признак базовой единицы измерения (0 - нет, 1 - да)*
"p_qty_in_layer": <number> - количество в слое на поддоне
"p_layers_on_pallet": <number> - количество слоев на поддоне
"p_weight": <number> - вес
"p_length": <number> - длина (не более трёх знаков после запятой)
"p_width": <number> - ширина (не более трёх знаков после запятой)
"p_height": <number> - высота (не более трёх знаков после запятой)
"p_is_active": <number> - активность единиц измерения: 0 – неактивна, 1 – активна (по умолчанию)
Ответ:
"id": <number> - внутренний идентификатор единицы измерения
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
Запрос:
{
"p_api_key": "8ABA6F71D6D83FB8E055000000000001",
"p_goods_id": 1010862,
"p_ext_sys_guid": "64351564845",
"p_goods_ext_sys_guid": "",
"p_mu_id": 1,
"p_cod_kspovo": "2009",
"p_pack_id": null,
"p_pack_ext_sys_guid": null,
"p_k": 12,
"p_base_unit": 0,
"p_qty_in_layer": 100,
"p_layers_on_pallet": 5,
"p_weight": 0.5,
"p_length": 50,
"p_width": 50,
"p_height": 200,
"p_is_active": 1,
"p_props":[
{
"name": "Объем основной",
"value": "0,45"
}
]
}
Ответ:
{
"response": {
"id": 1010864
},
"status": {
"code": "ok",
"message": null
}
}
POST GoodsBarcodeModify
Данный метод используется для создания/редактирования штрих кода конкретного товара и его единицы измерения в справочнике “Товары”.
https://cloudcommerce.zd.ua/API/CloudWarehouse/GoodsBarcodeModify
Параметры
Запрос:
"p_api_key": <string> - API ключ*
"p_id": <number> - внутренний идентификатор поля
"p_ext_sys_guid": <string> - внешний идентификатор*
"p_goods_id": <number> - внутренний идентификатор товара
"p_goods_ext_sys_guid": <string> - внешний идентификатор товара
"p_goods_munit_id": <number> - внутренний идентификатор единицы измерения товара (метод для получения справочника MeasurementUnitList)
"p_goods_munit_esg": <string> - внешний идентификатор единицы измерения*
"p_goods_batch_id": <number> - внутренний идентификатор партии
"p_goods_batch_esg": <string> - внешний идентификатор партии
"p_barcode": <string> - штрих код товара*
"p_note": <string> - примечание
"p_barcode_synonym": <string> - штрих код синоним
"p_sn_flag": <number> - признак, что штрих код, это серийный номер*
Ответ:
"id": <number> - внутренний идентификатор штрих кода
"barcode": <string> - штрих код
"p_ext_sys_guid": <string> - внешний идентификатор штрих кода товара
"p_goods_ext_sys_guid": <string> - внешний идентификатор товара
"p_goods_munit_esg": <string> - внешний идентификатор единицы измерения
"p_goods_batch_esg": <string> - внешний идентификатор партии
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
Запрос:
{
"p_api_key": "8ABA6F71D6D83FB8E055000000000001",
"p_id": null,
"p_ext_sys_guid": null,
"p_goods_id": 1010862,
"p_goods_ext_sys_guid": "",
"p_goods_munit_id": 1010864,
"p_goods_munit_esg": "",
"p_goods_batch_id": null,
"p_goods_batch_esg": null,
"p_note": null,
"p_sn_flag": 0,
"p_barcode": "4820042653343"
}
Ответ:
{
"response": {
"id": 1010865,
"barcode": "4820042653343",
"p_ext_sys_guid": null,
"p_goods_ext_sys_guid": null,
"p_goods_munit_esg": null,
"p_goods_batch_esg": null
},
"status": {
"code": "ok",
"message": null
}
}
POST GoodsGroupsModify
Данный метод используется для создания/редактирования групп товаров в справочнике “Группы товаров”.
https://cloudcommerce.zd.ua/API/CloudWarehouse/GoodsGroupsModify
Параметры
Запрос:
"p_api_key": <string> - API ключ*
"p_ext_sys_guid": <string> - внешний номер группы товара*
"p_name": <string> - название группы товаров*
"p_goods_chars": <array> - характеристики товара
"id": <number> - внутренний идентификатор характеристики
"ext_sys_guid": <string> - внешний идентификатор характеристики
"use_in_name": <number> - использовать в составном наименовании* (1 - да, 0 - нет)
"is_required": <number> - обязательность заполнения* (1 - да, 0 - нет)
Ответ:
"id": <number> - внутренний номер группы товара
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
Запрос:
{
"p_api_key": "8ABA6F71D6D83FB8E055000000000001",
"p_name": "Группа товаров создана из песочницы API",
"p_ext_sys_guid": "AGENT007",
"p_goods_chars": [
{
"id": null,
"ext_sys_guid": "API_sandbox_Goods_Char",
"use_in_name": 1,
"is_required": 1
}
]
}
Ответ:
{
"response": {
"id": 1010873
},
"status": {
"code": "ok",
"message": null
}
}
POST GoodsCharsModify
Данный метод используется для создания/редактирования характеристик товаров и их значений в справочнике “Характеристики товаров”.
https://cloudcommerce.zd.ua/API/CloudWarehouse/GoodsCharsModify
Параметры
Запрос:
"p_api_key": <string> - API ключ*
"p_id": <number> - внутренний идентификатор характеристики
"p_ext_sys_guid": <string> - внешний идентификатор характеристики*
"p_name": <string> - наименование характеристики*
"p_input_type": <number> - способ ввода (1 - ввод значения, 2 - из списка)*
"p_vals": <array> - массив значений характеристики
Ответ:
"id": <number> - внутренний идентификатор характеристики товара
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
Запрос:
{
"p_api_key": "8ABA6F71D6D83FB8E055000000000001",
"p_id": null,
"p_ext_sys_guid": "API_sandbox_Goods_Char",
"p_name": "Назначение",
"p_input_type": 2,
"p_vals": [
"Экспорт",
"Украина",
"АТБ"
]
}
Ответ:
{
"response": {
"id": 1010869
},
"status": {
"code": "ok",
"message": null
}
}
POST GoodsBatchModify
Метод используется для создания и редактирования партий товара.
https://cloudcommerce.zd.ua/API/CloudWarehouse/GoodsBatchModify
Параметры
Запрос:
"p_api_key": <string> - API ключ*
"p_id": <number> - внутренний идентификатор поля
"p_ext_sys_guid": <string> - внешний идентификатор партии*
"p_goods_id": <number> - внутренний идентификатор товара
"p_goods_ext_sys_guid": <string> - внешний идентификатор товара
"p_manufacturing_date": <date> - дата производства*
"p_expiration_date": <date> - дата окончания срока годности*
"p_part_number": <string> - номер партии
"p_haccp": <string> - номер HACCP
"p_manufacturer_esg": <string> - внешний идентификатор производителя
Ответ:
"id": <number> - внутренний идентификатор товара
"p_ext_sys_guid": <string> - внешний идентификатор партии товара
"p_goods_ext_sys_guid": <string> - внешний идентификатор товара
"p_pack_ext_sys_guid": <string> - внешний идентификатор упаковки
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
Запрос:
{
"p_api_key": "8ABA6F71D6D83FB8E055000000000001",
"p_id": null,
"p_ext_sys_guid": null,
"p_goods_id": 1010862,
"p_goods_ext_sys_guid": null,
"p_manufacturing_date": "21.04.2018",
"p_expiration_date": "11.05.2018",
"p_part_number": null,
"p_haccp": null
}
Ответ:
{
"response": {
"id": 1010875,
"p_ext_sys_guid": null,
"p_goods_ext_sys_guid": null
},
"status": {
"code": "ok",
"message": null
}
}
POST PackagingModify
Метод используется для создания и редактирования упаковки в справочнике “Упаковка”.
https://cloudcommerce.zd.ua/API/CloudWarehouse/PackagingModify
Параметры
Запрос:
"p_api_key": <string> - API ключ*
"p_id": <number> - внутренний идентификатор упаковки
"p_ext_sys_guid": <string> - внешний идентификатор упаковки*
"p_sku": <string> - артикул упаковки*
"p_name": <string> - наименование упаковки*
"p_qty_in_layer": <number> - количество в слое*
"p_layers_on_pallet": <number> - количество слоев на паллете*
"p_max_weight": <number> - максимальный вес
"p_length": <number> - длина
"p_width": <number> - ширина
"p_height": <number> - высота
"p_packtype_name": <string> - наименование типа упаковки
"p_active": <number> - активность упаковки (да/нет)
"p_goods_ext_sys_guid": <string> - внешний идентификатор товара для учета тары
Ответ:
"id": <number> - внутренний идентификатор упаковки
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
Запрос:
{
"p_api_key": "8ABA6F71D6D83FB8E055000000000001",
"p_id": null,
"p_goods_id": null,
"p_ext_sys_guid": "111-222-333-444",
"p_sku": "Гофроящ.зефир(188)",
"p_name": "Гофроящик зефирный (№188)",
"p_qty_in_layer": 5,
"p_layers_on_pallet": 6,
"p_max_weight": 7,
"p_length": 8,
"p_width": 9,
"p_height": 10,
"p_packtype_name": "",
"p_active": 0,
"p_goods_ext_sys_guid": "0023-23"
}
Ответ:
{
"response": {
"id": 2,
},
"status": {
"code": "ok",
"message": null
}
}
6. Чтение документов
GET PlanInboundList
Метод используется для получения списка документов “План прихода” за выбранный период, а также отдельно приходов в системе по внутреннему (id) или внешнему (EXTGUID) идентификатору документа.
https://cloudcommerce.zd.ua/API/CloudWarehouse/PlanInboundList?APIKEY={{API_KEY}}&{{id}}&{{EXTGUID}}&{{DATE_FROM}}&{{DATE_TO}}&{{DOC_STATUS_ID}}
Параметры
Запрос:
APIKEY=<string> - индивидуальный API ключ клиента*
"id": <string> - внутренний идентификатор документа «План прихода»
"EXTGUID": <string> - внешний идентификатор документа «План прихода»
"DATE_FROM": <string> - 'дата с…' (включительно), в формате дд.мм.гггг (указывается в URL после ключа или в параметрах)
"DATE_TO": <string> - 'дата по…' (включительно), в формате дд.мм.гггг (указывается в URL после ключа или в параметрах)
"DOC_STATUS_ID": <number> - идентификатор статуса документа (обработан/не обработан, указывается в URL после ключа или параметрах)
Ответ:
"plan_inbound": <array> - документы "План прихода"
"id": <number> - внутренний идентификатор плана прихода
"doc_date": <string> - дата плана прихода
"doc_status_id": <number> - внутренний идентификатор статуса документа
"doc_status_name": <string> - название статуса документа
"operation_type_id": <number> - внутренний идентификатор типа прихода
"operation_type_name": <string> - название типа прихода
"wh_id": <number> - внутренний идентификатор склада (метод для получения справочника WarehouseList)
"inbound_plan_date": <date> - плановая дата доставки
"contragent_name": <string> - наименование поставщика
"contragent_telnum": <string> - телефон поставщика
"ext_sys_docnum": <number> - внешний номер плана прихода
"ext_sys_guid": <number> - внешний идентификатор плана прихода
"comments": <string> - комментарий
plan_inbound_items: <string> - параметры плана прихода
"id": <number> - внутренний идентификатор
"goods_id": <number> - внутренний идентификатор товара
"ext_sys_guid": <number> - внешний идентификатор плана прихода
"goods_munit_id": <number> - внутренний идентификатор единицы измерения товара (метод для получения справочника MeasurementUnitList)
"goods_quality_id": <number> - внутренний идентификатор качества товара (метод для получения справочника QualityList)
"qty": <number> - количество товара
"serialnumber": <number> - серийный номер
"manufacturing_date_min": <date> - дата производства (мин) для отбора товара
"manufacturing_date_max": <date> - дата производства (макс) для отбора товара
"expiration_date_min": <date> - дата завершения срока годности (мин)
"expiration_date_max": <date> - дата завершения срока годности (макс)
"part_number": <string> - номер партии
"price": <number> - цена
"total_price": <number> - общая сумма
"order_id": <number> - внутренний идентификатор заказа
"goods_chars": <array> - характеристики
"id": <number> - внутренний идентификатор характеристики
"ext_sys_guid": <string> - внешний идентификатор характеристики
"name": <string> - наименование характеристики
"str_value": <string> - значение характеристики
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное cообщение
Успешно
{
"response": {
"plan_inbound" [
{
"id": 10004853,
"doc_date": "11.07.2019",
"doc_status_id": 4,
"doc_status_name": "Завершен",
"operation_type_id": 35,
"operation_type_name": "Прием товара",
"wh_id": 14,
"inbound_plan_date": "11.07.2019",
"contragent_name": "Скорик С.С.",
"contragent_telnum": "33333333",
"ext_sys_docnum": "1000",
"ext_sys_guid": "11000",
"comments": "план по API 1",
"plan_inbound_items" [
{
"id": 101388,
"ext_sys_guid": "11000",
"goods_id": 1348388,
"goods_ext_sys_guid": "202020",
"goods_munit_id": 1348390,
"goods_munit_ext_sys_guid": "202021",
"goods_quality_id": 6,
"qty": 30,
"serialnumber": null,
"manufacturing_date_min": "11.07.2019",
"manufacturing_date_max": "11.07.2019",
"expiration_date_min": null,
"expiration_date_max": null,
"part_number": "1000",
"price":null,
"total_price": null,
"order_id": null,
"goods_chars" [
{
"id": 1348404,
"ext_sys_guid": "98000",
"name": "Назначение",
"str_value": "Украина"
}
]
},
{
"id": 101429,
"ext_sys_guid": "1000",
"goods_id": 1348420,
"goods_ext_sys_guid": "202012",
"goods_munit_id": 1348421,
"goods_munit_ext_sys_guid": "2020124",
"goods_quality_id": 6,
"qty": 50,
"serialnumber": null,
"manufacturing_date_min": "11.07.2019",
"manufacturing_date_max": "11.07.2019",
"expiration_date_min": null,
"expiration_date_max": null,
"part_number": "55",
"price": null,
"total_price": null,
"order_id":null,
"goods_chars":[
{
"id": 1348404,
"ext_sys_guid": "98000",
"name": "Назначение",
"str_value": "Украина"
}
]
}
]
}
]
},
"status": {
"code":"ok",
"message": null
}
}
GET FactInboundList
Метод используется для получения списка документов прихода в статусе “Завершен” (факт прихода) за выбранный период, а также отдельно приходов в системе по внутреннему (id) или внешнему (EXTGUID) идентификатору плана прихода.
https://cloudcommerce.zd.ua/API/CloudWarehouse/FactInboundList?APIKEY={{API_KEY}}&{{id}}&{{DATE_FROM}}&{{DATE_TO}}&{{EXTGUID}}
Параметры
Запрос:
APIKEY=<string> - индивидуальный API ключ клиента*
"id": <string> - внутренний идентификатор документа «План прихода»
"EXTGUID": <string> - внешний идентификатор документа «План прихода»
"DATE_FROM": <string> - 'дата с…' (включительно), в формате дд.мм.гггг (указывается в URL после ключа или в параметрах)
"DATE_TO": <string> - 'дата по…' (включительно), в формате дд.мм.гггг (указывается в URL после ключа или в параметрах)
Ответ:
"fact_inbound": <array> - документы "План прихода"
"id": <number> - внутренний идентификатор плана прихода
"doc_date": <string> - дата плана прихода
"doc_status_id": <number> - внутренний идентификатор статуса документа
"doc_status_name": <string> - название статуса документа
"operation_type_id": <number> - внутренний идентификатор типа прихода
"operation_type_name": <string> - название типа прихода
"wh_id": <number> - внутренний идентификатор склада (метод для получения справочника WarehouseList)
"contragent_name": <string> - наименование поставщика
"contragent_telnum": <string> - телефон поставщика
"comments": <string> - комментарий
user_close_doc: <string> - пользователь, выполнивший операцию
plan_inbound_id: <string> - внутренний идентификатор связанного документа «Плана прихода»
plan_inbound_ext_sys_docnum: <string> - внешний идентификатор связанного документа «Плана прихода»
parent_doc_id: <string> - внутренний идентификатор документа основания
"fact_inbound_items": <array> - параметры факта прихода
"item_id": <number> - внутренний идентификатор строки
"goods_id": <number> - внутренний идентификатор товара
"goods_munit_id": <number> - внутренний идентификатор единицы измерения товара (метод для получения справочника MeasurementUnitList)
"goods_quality_id": <number> - внутренний идентификатор качества товара (метод для получения справочника QualityList)
"goods_barcode_id": <number> - внутренний идентификатор штрих кода товара
"qty": <number> - количество товара
"qty_not_stored": <number> - количество не размещенного товара
"goods_ext_sys_guid": <string> - внешний идентификатор товара
"goods_munit_ext_sys_guid": <string> - внешний идентификатор единиц измерения товара
"goods_batch_ext_sys_guid": <string> - внешний идентификатор партии товара
"goods_barcode_ext_sys_guid": <string> - внешний идентификатор штрих кода товара
"manufacturing_date": <date> - дата производства
"expiration_date": <date> - дата окончания срока годности
"part_number": <string> - номер партии
"goods_barcode": <string> - внутренний штрих код товара
"container_barcode": <string> - внутренний штрих код контейнера
"return_order_id": <string> - внутренний идентификатор заказа возврата
"return_order_docnumb": <string> - внешний номер документа заказа возврата
"return_order_ext_sys_guid": <string> - внешний идентификатор заказа возврата
"finished_date": <string> - дата и время фактического приёма
"goods_chars": <array> - хараткеристики товара
"id": <number> - внутренний идентификатор характеристики
"ext_sys_guid": <string> - внешний идентификатор характеристики
"name": <string> - наименование характеристики
"str_value": <string> - значение характеристики
"containers_list": <array> - контейнеры
"ext_sys_guid": <string> - внешний идентификатор контейнера
"qty": <number> - количество контейнеров
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное cообщение
Успешно
{
"response": {
"fact_inbound": [
{
"id": 10007342,
"doc_date": "03.12.2019",
"doc_status_id": 7,
"doc_status_name": "Завершен",
"operation_type_id": 33,
"operation_type_name": "Прием товара",
"wh_id": 8,
"contragent_name": null,
"contragent_telnum": null,
"comments": "zdrhdghsf",
"user_close_doc": "Бондаренко Алексей",
"workshop_id": null,
"workshop_name": null,
"workshop_ext_sys_guid": null,
"recip_country_id": null,
"recip_country_name": null,
"manufacturer_id": null,
"manufacturer_name": null,
"manufacturer_ext_sys_guid": null,
"plan_inbound_id": "10007341",
"plan_inbound_ext_sys_docnum": null,
"fact_inbound_items": [
{
"item_id": 332270,
"goods_id": 1062974,
"goods_munit_id": 1062976,
"goods_quality_id": 1,
"goods_barcode_id": 1065759,
"qty": 201,
"goods_ext_sys_guid": "110095",
"goods_munit_ext_sys_guid": "100095",
"goods_batch_ext_sys_guid": null,
"goods_barcode_ext_sys_guid": null,
"manufacturing_date": "03.12.2019",
"expiration_date": "20.06.2020",
"part_number": null,
"goods_barcode": "3000100019897",
"container_barcode": "3000100019900",
"return_order_id": null,
"return_order_docnumb": null,
"return_order_ext_sys_guid": null,
"finished_date": "03.12.2019 10:59:26",
"goods_chars": []
}
],
"containers_list": [
{
"ext_sys_guid": null,
"qty": 1
}
]
}
]
},
"status": {
"code": "ok",
"message": null
}
}
GET OrdersList
Метод используется для получения списка заказов за выбранный период со статусами выполнения, а также отдельного заказа в системе по внутреннему (id) или внешнему (EXTGUID) идентификатору.
https://cloudcommerce.zd.ua/API/CloudWarehouse/OrderList?APIKEY={{API_KEY}}&{{id}}&{{DATE_FROM}}&{{DATE_TO}}&{{EXTGUID}}&{{ORDER_FILES}}&{{ORDER_LOG}}&{{DOC_STATUS_ID}}
Параметры
Запрос:
APIKEY=<string> - индивидуальный API ключ клиента*
"id": <string> - внутренний идентификатор заказа
"EXTGUID": <string> - внешний идентификатор заказа
"ORDER_FILES": <number> - 0 – не получать, 1 - получать файлы к заказу
"ORDER_LOG": <number> - 0 – не получать, 1 - получать лог к заказу
"DATE_FROM": <string> - 'дата с…' (включительно), в формате дд.мм.гггг (указывается в URL после ключа или в параметрах)
"DATE_TO": <string> - 'дата по…' (включительно), в формате дд.мм.гггг (указывается в URL после ключа или в параметрах)
"DOC_STATUS_ID": <number> - идентификатор статуса документа (обработан/не обработан)
Ответ:
"orders": <array> - заказ
"id": <number> - внутренний идентификатор заказа
"doc_date": <date> - дата заказа
"doc_status_id": <number> - внутренний идентификатор статуса документа
"doc_status_name": <string> - название статуса документа
"operation_type_id": <number> - внутренний идентификатор типа заказа
"operation_type_name": <string> - название типа заказа
"wh_id": <number> - внутренний идентификатор склада (метод для получения справочника WarehouseList)
"shipment_plan_date": <date> - плановая дата доставки
"delivery_type_id": <number> - код типа доставки
"delivery_type_name": <string> - название типа доставки
"contragent_name": <string> - контрагент/Получатель (наименование)
"contragent_telnum": <string> - контрагент/Получатель (телефон)
"ext_sys_docnum": <string> - внешний номер заказа
"ext_sys_guid": <string> - внешний идентификатор заказа
"comments": <string> - комментарий
"delivery_address": <string> - адрес доставки
"waybill": <string> - признак, объединяющий заказы для отгрузки (накладная, путевой лист, водитель, автомобиль)
"load_order": <number> - порядок загрузки
"decl_request": <string> - запрос к перевозчику на регистрацию посылки
"decl_response": <string> - ответ от перевозчика на регистрацию посылки
"decl_uuid": <number> - уникальный код посылки у перевозчика
"decl_number": <string> - номер документа перевозчика
"comments_pack": <string> - комментарий к упаковке
"orders_props": <array> - дополнительные свойства
"name": <string> - наименование свойства
"value": <string> - значение свойства
"orders_items": <array> - параметры заказа
"id": <number> - внутренний идентификатор строки заказа
"ext_sys_guid": <string> - внешний идентификатор строки заказа
"goods_id": <number> - внутренний идентификатор товара
"goods_munit_id": <number> - внутренний идентификатор единицы измерения товара (метод для получения справочника MeasurementUnitList)
"goods_quality_id": <number> - внутренний идентификатор качества товара (метод для получения справочника QualityList)
"goods_barcode_id": <string> - внутренний идентификатор штрих кода товара
"qty": <number> - количество товара в указанной единице измерения
"serialnumber": <string> - серийный номер
"manufacturing_date_min": <date> - дата производства (мин) для отбора товара
"manufacturing_date_max": <date> - дата производства (макс) для отбора товара
"expiration_date_min": <date> - дата завершения срока годности (мин)
"expiration_date_max": <date> - дата завершения срока годности (макс)
"part_number": <string> - номер партии
"price": <number> - цена
"total_price": <number> - общая сумма
"goods_ext_sys_guid": <string> - внешний идентификатор товара
"goods_munit_ext_sys_guid": <string> - внешний идентификатор единиц измерения товара
"goods_chars": <array> - характеристики товара
"id": <string> - внутренний идентификатор характеристики
"ext_sys_guid": <string> - внешний идентификатор характеристики
"name": <string> - наименование характеристики
"str_value": <string> - значение характеристики
"orders_seats": <array> - список мест к посылке
"id": <number> - внутренний идентификатор
"numb": <number> - порядковый номер
"uuid": <number> - уникальный код посылки у перевозчика
"barcode": <string> - штрих код места
"packaging_id": <number> - код упаковки
"packaging_name": <string> - название упаковки
"fact_outbound_items": <array> - описание товара, отгружаемого по заказу
"id": <number> - внутренний идентификатор строки товара
"goods_id": <number> - внутренний идентификатор товара
"goods_munit_id": <number> - внутренний идентификатор единицы измерения
"goods_quality_id": <number> - внутренний идентификатор качества
"goods_barcode_id": <number> - внутренний идентификатор штрих кода товара
"goods_batch_id": <number> - внутренний идентификатор партии
"goods_chars_id": <number> - внутренний идентификатор характеристики
"qty": <number> - количество
"finished_date": <date> - дата и время отгрузки заказа
"goods_ext_sys_guid": <string> - внешний идентификатор товара
"goods_munit_ext_sys_guid": <string> - внешний идентификатор единицы измерения
"goods_barcode": <string> - штрих код товара
"goods_barcode_ext_sys_guid": <string> - внешний идентификатор штрих кода товара
"goods_batch_ext_sys_guid": <string> - внешний идентификатор партии
"goods_batch_manuf_date": <string> - дата производства
"goods_batch_expir_date": <string> - дата реализации
"goods_batch_part_number": <string> - номер партии
"goods_batch_ext_sys_guid": <string> - внешний идентификатор партии
"goods_chars": <array> - массив характеристик
"id": <string> - внутренний идентификатор характеристики
"ext_sys_guid": <string> - внешний идентификатор характеристики
"name": <string> - наименование характеристики
"str_value": <string> - значение характеристики
"fact_select_items": <array> - массив отбора товара по заказу (отображается, когда отбор со статусом «Завершен», заказ не включен в отгрузку или не отгружен)
"goods_id": <number> - внутренний идентификатор товара
"goods_munit_id": <number> - внутренний идентификатор единицы измерения
"goods_batch_id": <number> - внутренний идентификатор партии
"goods_chars_id": <number> - внутренний идентификатор характеристики
"qty": <number> - количество отобранного товара
"goods_ext_sys_guid": <string> - внешний идентификатор товара
"goods_munit_ext_sys_guid": <string> - внешний идентификатор единицы измерения
"goods_barcode": <string> - штрих код товара
"goods_batch_manuf_date": <string> - дата производства
"goods_batch_expir_date": <string> - дата реализации
"goods_batch_part_number": <string> - номер партии
"goods_batch_ext_sys_guid": <string> - внешний идентификатор партии
"goods_chars": <array> - массив характеристик
"id": <string> - внутренний идентификатор характеристики
"ext_sys_guid": <string> - внешний идентификатор характеристики
"name": <string> - наименование характеристики
"str_value": <string> - значение характеристики
"orders_log": <array> - лог к заказу
"id": <number> - внутренний идентификатор
"text": <string> - описание
"time_stamp": <string> - отметка времени
"orders_files": <array> - файлы к заказу
"id": <number> - внутренний идентификатор
"file_data": <string> - файл в кодировке base64
"printer_type": <number> - 1 - А4, 2 - чековый, 3 - стикер/самоклейка маленькая, 4-стикер/самоклейка большая
"ext_sys_guid": <string> - внешний идентификатор файла
"barcode": <string> - штрих код файла
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное cообщение
Успешно
{
"response": {
"orders" [
{
"id":10013137,
"doc_date": "31.03.2020",
"doc_status_id": 23,
"doc_status_name": "Отобран",
"operation_type_id": 6,
"operation_type_name": "ЗаказB2C",
"wh_id": 8,
"shipment_plan_date": null,
"delivery_type_id": 1,
"delivery_type_name": "Самовывоз",
"contragent_name": null,
"contragent_telnum": null,
"ext_sys_docnum": null,
"ext_sys_guid": null,
"comments": null,
"delivery_address": null,
"waybill": null,
"load_order": null,
"decl_request": null,
"decl_response": null,
"decl_uuid": null,
"decl_number": null,
"orders_props": [],
"orders_items": [
{
"id": 413222,
"ext_sys_guid": null,
"goods_id": 1070535,
"goods_munit_id": 1070536,
"goods_quality_id": 1,
"goods_barcode_id": null,
"qty": 2,
"serialnumber": null,
"manufacturing_date_min": null,
"manufacturing_date_max": null,
"expiration_date_min": null,
"expiration_date_max": null,
"part_number": null,
"price": null,
"total_price": null,
"goods_ext_sys_guid": "1000965",
"goods_munit_ext_sys_guid": "100096547",
"goods_chars": []
},
{
"id": 413224,
"ext_sys_guid": null,
"goods_id": 1066422,
"goods_munit_id": 1066423,
"goods_quality_id": 1,
"goods_barcode_id": null,
"qty": 1,
"serialnumber": "234652456745",
"manufacturing_date_min": null,
"manufacturing_date_max": null,
"expiration_date_min": null,
"expiration_date_max": null,
"part_number": null,
"price": null,
"total_price": null,
"goods_ext_sys_guid": "102323",
"goods_munit_ext_sys_guid": "202323",
"goods_chars": []
}
],
"orders_seats":[],
"fact_outbound_items":[],
"fact_select_items": [
{
"goods_id": 1066422,
"goods_munit_id": 1066423,
"goods_batch_id": null,
"goods_chars_id": null,
"qty": 1,
"goods_ext_sys_guid": "102323",
"goods_munit_ext_sys_guid": "202323",
"goods_barcode": "234652456745",
"goods_batch_manuf_date": null,
"goods_batch_expir_date": null,
"goods_batch_part_number": null,
"goods_batch_ext_sys_guid": null,
"goods_chars":[]
},
{
"goods_id": 1070535,
"goods_munit_id": 1070536,
"goods_batch_id": 1070779,
"goods_chars_id": null,
"qty": 2,
"goods_ext_sys_guid": "1000965",
"goods_munit_ext_sys_guid": "100096547",
"goods_barcode": "3000100020742",
"goods_batch_manuf_date": "22.01.2020",
"goods_batch_expir_date": "09.08.2020",
"goods_batch_part_number": null,
"goods_batch_ext_sys_guid": null,
"goods_chars":[]
}
]
}
]
},
"status": {
"code": "ok",
"message":null
}
}
GET ProcReqList
Метод позволяет получить список заявок на обработку товара.
https://cloudcommerce.zd.ua/API/CloudWarehouse/ProcReqList?APIKEY={{API_KEY}}
Параметры
Запрос:
APIKEY=<string> - индивидуальный API ключ клиента*
Ответ:
"procreq": <array> - список заявок на обработку
"id": <number> - внутренний идентификатор
"doc_date": <date> - дата заявки
"doc_status_id": <number> - внутренний идентификатор статуса заявки (метод DocStatusList)
"doc_status_name": <string> - наименование статуса заявки
"operation_type_id": <number> - внутренний идентификатор типа заявки
"operation_type_name": <string> - наименование типа заявки
"wh_id": <number> - внутренний идентификатор склада (метод WarehouseList)
"ext_sys_docnum": <string> - внешний номер заявки
"ext_sys_guid": <string> - внешний идентификатор заявки
"comments": <string> - комментарий к заявке
"items_fr": <array> - данные о товаре до обработки
"id": <number> - внутренний идентификатор строки товара
"ext_sys_guid": <string> - внешний идентификатор строки товара
"goods_id": <string> - внутренний идентификатор товара
"goods_munit_id": <string> - внутренний идентификатор единицы измерения товара
"goods_batch_id": <string> - внутренний идентификатор партии товара
"goods_quality_id": <number> - внутренний идентификатор качества товара (метод QualityList)
"goods_barcode_id": <string> - внутренний идентификатор штрих кода товара
"qty": <number> - количество товара
"container_id": <string> - внутренний идентификатор контейнера
"goods_ext_sys_guid": <string> - внешний идентификатор товара
"goods_munit_ext_sys_guid": <string> - внешний идентификатор единицы измерения товара
"goods_batch_ext_sys_guid": <string> - внешний идентификатор партии товара
"goods_barcode": <string> - штрих код товара товара
"container_barcode": <string> - штрих код контейнера (метод GoodsStock)
"manufacturing_date": <string> - дата производства
"expiration_date": <string> - срок реализации
"part_number": <string> - номер партии
"goods_chars": <array> - характеристики товара (метод GoodsCharsList)
"items_to": <array> - данные о товаре после обработки
"id": <number> - внутренний идентификатор строки товара
"ext_sys_guid": <string> - внешний идентификатор строки товара
"goods_id": <string> - внутренний идентификатор товара
"goods_munit_id": <string> - внутренний идентификатор единицы измерения товара
"goods_batch_id": <string> - внутренний идентификатор партии товара
"goods_quality_id": <number> - внутренний идентификатор качества товара (метод QualityList)
"goods_barcode_id": <string> - внутренний идентификатор штрих кода товара
"qty": <number> - количество товара
"goods_ext_sys_guid": <string> - внешний идентификатор товара
"goods_munit_ext_sys_guid": <string> - внешний идентификатор единицы измерения товара
"goods_batch_ext_sys_guid": <string> - внешний идентификатор партии товара
"goods_barcode": <string> - штрих код товара
"manufacturing_date": <string> - дата производства
"expiration_date": <string> - срок реализации
"part_number": <string> - номер партии
"goods_chars": <array> - массив характеристик товара (метод GoodsCharsList)
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное cообщение
Успешно
{
"response": {
"procreq": [
{
"id": 10006235,
"doc_date": "02.10.2019",
"doc_status_id": 45,
"doc_status_name": "Отменена",
"operation_type_id": 38,
"operation_type_name": "Пересортица",
"wh_id": 8,
"ext_sys_docnum": "3213223",
"ext_sys_guid": "6546554",
"comments": "изменить качество",
"items_fr": [],
"items_to": []
},
{
"id": 10006242,
"doc_date": "03.10.2019",
"doc_status_id": 42,
"doc_status_name": "Создана",
"operation_type_id": 38,
"operation_type_name": "Пересортица",
"wh_id": 6,
"ext_sys_docnum": null,
"ext_sys_guid": "20191003/1242/1",
"comments": null,
"items_fr": [
{
"id": 303917,
"ext_sys_guid": "3333333",
"goods_id": 1062544,
"goods_munit_id": 1062545,
"goods_batch_id": 1063929,
"goods_quality_id": 1,
"goods_barcode_id": null,
"qty": 5,
"container_id": 1063701,
"goods_ext_sys_guid": "10002",
"goods_munit_ext_sys_guid": "10003",
"goods_batch_ext_sys_guid": null,
"goods_barcode": null,
"container_barcode": "3000100019267",
"manufacturing_date": "09.08.2019",
"expiration_date": "05.02.2020",
"part_number": "090819",
"goods_chars": []
}
],
"items_to": [
{
"id": 303918,
"ext_sys_guid": "10002666",
"goods_id": 1062544,
"goods_munit_id": 1062545,
"goods_batch_id": null,
"goods_quality_id": 6,
"goods_barcode_id": null,
"qty": null,
"goods_ext_sys_guid": "10002",
"goods_munit_ext_sys_guid": "10003",
"goods_batch_ext_sys_guid": null,
"goods_barcode": null,
"manufacturing_date": null,
"expiration_date": null,
"part_number": null,
"goods_chars": []
},
{
"id": 303927,
"ext_sys_guid": null,
"goods_id": 1062655,
"goods_munit_id": 1062656,
"goods_batch_id": 1063158,
"goods_quality_id": 1,
"goods_barcode_id": null,
"qty": 55,
"goods_ext_sys_guid": "100047851",
"goods_munit_ext_sys_guid": "10004132",
"goods_batch_ext_sys_guid": null,
"goods_barcode": null,
"manufacturing_date": "16.04.2019",
"expiration_date": "18.10.2019",
"part_number": "43534",
"goods_chars": [
{
"id": 1063652,
"ext_sys_guid": "123021547",
"name": "Продажа",
"str_value": "Экспорт"
}
]
}
]
},
"status": {
"code": "ok",
"message": null
}
}
7. Изменение документов
POST OrdersModify
Метод используется для создания и редактирования заказа на комплектацию.
https://cloudcommerce.zd.ua/API/CloudWarehouse/OrdersModify
Параметры
Запрос:
"p_api_key": <string> - API ключ*
"p_id": <number> - внутренний идентификатор заказа
"p_doc_date": <date> - дата заказа*
"p_operation_type_id": <number> - тип заказа*
"p_wh_id": <number> - внутренний идентификатор склада (метод для получения справочника - WarehouseList)*
"p_shipment_plan_date": <date> - плановая дата доставки
"p_delivery_type_id number": <number> - код типа доставки
"p_contragent_name": <string> - наименование Контрагента/Получателя*
"p_contragent_telnum": <string> - номер телефона Контрагента/Получателя
"p_ext_sys_docnum": <string> - внешний номер заказа*
"p_ext_sys_guid": <string> - внешний идентификатор заказа*
"p_comments": <string> - комментарий
"p_delivery_address": <string> - адрес доставки*
"p_decl_request": <string> - запрос регистрации ТТН через api перевозчика*
"p_comments_pack": <string> - комментарий к упаковке
"p_props": <array> - передачи массива дополнительных свойств к заказу парами параметров: «name» и «value»
"p_load_order": <number> - очередность загрузки заказа в транспорт: null – порядок не задан; больше нуля - порядок загрузки задан пользователем
"p_waybill": <string> - номер путевого листа (используется для объединения заказов при отборе или отгрузке)
"p_wh_id_recipient": <number> - идентификатор склада получателя (обязательный, когда по типу заказа «Создавать план приёма на основании заказа с видом операции» в правилах учета – Заказ – Виды операций, задано значение «Приём товара»/«Возрат товара»)
"p_items": <array> - массив объектов (аналогично параметрам метода OrdersItemModify)
Ответ:
"id": <number> - внутренний идентификатор заказа
"p_ext_sys_guid": <string> - внешний идентификатор заказа
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
Запрос:
{
"p_api_key": "8ABA6F71D6D83FB8E055000000000001",
"p_id": null,
"p_doc_date": "17.02.2020",
"p_operation_type_id": 5,
"p_wh_id": 1,
"p_shipment_plan_date": "18.02.2020",
"p_delivery_type_id": 1,
"p_contragent_name": "Панасенко Іван",
"p_contragent_telnum": "0671234567",
"p_ext_sys_docnum": "180220/1238-002",
"p_ext_sys_guid": "180220/1238-0002",
"p_comments": "Заказ создан в sandbox через API",
"p_delivery_address": "м.Київ, вул.Хрещатик, 1",
"p_decl_request": null,
"p_comments_pack": "",
"p_props": [
{
"name": "водитель",
"value": "Петров Александр"
},
{
"name": "№ авто",
"value": "ВН1111ВН"
}
],
"p_load_order": null,
"p_waybill": "180220/1238",
"p_wh_id_recipient": 8,
"p_items": [
{
"p_id": null,
"p_ext_sys_guid": "110095",
"p_order_id": null,
"p_order_ext_sys_guid": "180220/1235-0004",
"p_goods_id": null,
"p_goods_ext_sys_guid": "110095",
"p_goods_mu_id": null,
"p_goods_munit_esg": "100095",
"p_qty": 3,
"p_serialnumber": null,
"p_manuf_date_min": null,
"p_manuf_date_max": null,
"p_exp_date_min": null,
"p_exp_date_max": null,
"p_part_number": null,
"p_price": 30,
"p_total_price": 35,
"p_goods_qu_id": null,
"p_goods_bar_id": null,
"p_barcode": ""
}
]
}
Ответ:
{
"response": {
"id": 2,
"p_ext_sys_guid": "180220/1238-002"
},
"status": {
"code": "ok",
"message": null
}
}
POST OrdersItemModify
Метод используется для создания и редактирования строк спецификации к заказу на комплектацию.
https://cloudcommerce.zd.ua/API/CloudWarehouse/OrdersItemModify
Параметры
Запрос:
"p_api_key": <string> - API ключ*
"p_id": <number> - внутренний идентификатор заказа
"p_ext_sys_guid": <string> - внешний идентификатор строки заказа*
"p_order_id": <number> - внутренний идентификатор заказа
"p_order_ext_sys_guid": <string> - внешний идентификатор заказа*
"p_goods_id": <number> - внутренний идентификатор товара
"p_goods_ext_sys_guid": <string> - внешний идентификатор товара*
"p_goods_mu_id": <number> - внутренний идентификатор единицы измерения товара (метод для получения справочника MeasurementUnitList)
"p_goods_munit_esg": <string> - внешний идентификатор единицы измерения товара*
"p_qty": <number> - количество товара*
"p_serialnumber": <string> - серийный номер
"p_manuf_date_min": <date> - дата производства (мин) для отбора товара
"p_manuf_date_max": <date> - дата производства (макс) для отбора товара
"p_exp_date_min": <date> - дата завершения срока реализации (мин)
"p_exp_date_max": <date> - дата завершения срока реализации (макс)
"p_part_number": <string> - номер партии
"p_price": <number> - цена за единицу
"p_total_price": <number> - общая сумма
"p_goods_qu_id": <number> - внутренний идентификатор качества товара (метод для получения справочника QualityList)
"p_goods_bar_id": <number> - внутренний идентификатор штрих кода товара
"p_barcode": <string> - штрих код товара
"p_goods_chars": <array> - характеристики
"id": <string> - внутренний идентификатор характеристики
"ext_sys_guid": <string> - внешний идентификатор характеристики
"str_value": <string> - значение характеристики
Ответ:
"id": <number> - внутренний идентификатор заказа
"p_ext_sys_guid": <string> - внешний идентификатор заказа
"p_goods_ext_sys_guid": <string> - внешний идентификатор товара
"p_goods_munit_esg": <string> - внешний идентификатор единицы измерения
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
Запрос:
{
"p_api_key": "8ABA6F71D6D83FB8E055000000000001",
"p_id": null,
"p_ext_sys_guid": "235451",
"p_order_id": null,
"p_order_ext_sys_guid": "180220/1238-002",
"p_goods_id": null,
"p_goods_ext_sys_guid": "",
"p_goods_mu_id": 1010864,
"p_goods_munit_esg": "",
"p_qty": 1,
"p_price": 3000,
"p_total_price": 3000,
"p_serialnumber": null,
"p_manuf_date_min": null,
"p_manuf_date_max": null,
"p_exp_date_min": null,
"p_exp_date_max": null,
"p_part_number": null,
"p_goods_qu_id": null,
"p_goods_bar_id": null,
"p_barcode": null,
"p_goods_chars": [
{
"id": null,
"ext_sys_guid": "98000",
"str_value": "Украина"
}
]
}
Ответ:
{
"response": {
"id": 121324
},
"status": {
"code": "ok",
"message": null
}
}
POST OrdersFileModify
Метод используется для создания и редактирования файлов к заказу на комплектацию.
https://cloudcommerce.zd.ua/API/CloudWarehouse/OrdersFileModify
Параметры
Запрос:
"p_api_key": <string> - API ключ*
"p_ext_sys_guid": <string> - внешний идентификатор файла*
"p_order_ext_sys_guid": <string> - внешний идентификатор заказа*
"p_file_data": <string> - файл PDF в кодировке BASE64
"p_printer_type": <string> - тип принтера*: 1 - А4, 2 - чековый, 3 - стикер/самоклейка маленькая, 4 - стикер/самоклейка большая
"p_barcode": <string> - если параметр указан, то при завершении контроля отображается страница сканирования данного штрих кода. Таким образом, подтверждается, что вложенный файл напечатан и добавлен к заказу
Ответ:
"p_Ext_sys_guid": <string> - внешний идентификатор файла
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
Запрос:
{
"p_api_key": "8ABA6F71D6D83FB8E055000000000001",
"p_ext_sys_guid": "568456425856",
"p_order_ext_sys_guid": "180220/1238-002",
"p_file_data": "JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9DcmVhdG9yIChDaHJvbWl1bSkKL1Byb2R1Y2VyIChTa2lhL1BERiBtNjMpCi9DcmVhdGlvbkRhdGUgKEQ6MjAxODExMjgxNDE0MTkrMDAnMDAnKQovTW9kRGF0ZSAoRDoyMDE4MTEyODE0MTQxOSswMCcwMCcpPj4KZW5kb2JqCjIgMCBvYmoKPDwvVHlwZSAvWE9iamVjdAovU3VidHlwZSAvSW1hZ2UKL1dpZHRoIDI0OAovSGVpZ2h0IDE5MQovQ29sb3JTcGFjZSAvRGV2aWNlUkdCCi9TTWFzayAzIDAgUgovQml0c1BlckNvbXBvbmVudCA4Ci9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTYwPj4gc3RyZWFtCnic7cEBDQAAAMKg909tDwcUAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD8GCs2A +CnN0YXJ0eHJlZgozMTEyOAolJUVPRg==",
"p_printer_type": 1,
"p_barcode": "5631562555"
}
Ответ:
{
"response": {
"p_Ext_sys_guid": "568456425856"
},
"status": {
"code": "ok",
"message": null
}
}
POST OrdersDelete
Метод используется для удаления одного заказа. Удалять можно только заказ в статусе “Создан”.
https://cloudcommerce.zd.ua/API/CloudWarehouse/OrdersDelete
Параметры
Запрос:
"p_api_key": <string> - API ключ*
"p_ext_sys_guid": <string> - указывается для удаления по внешнему идентификатору заказа
"p_id": <string> - указывается для удаления по внутреннему идентификатору заказа
Ответ:
"id": <number> - внутренний идентификатор заказа
"p_ext_sys_guid": <string> - внешний идентификатор заказа
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
Запрос:
{
"p_api_key": "8ABA6F71D6D83FB8E055000000000001",
"p_ext_sys_guid": null,
"p_id":"10000484"
}
Ответ:
{
"response": {
"id": null,
"p_ext_sys_guid": null
},
"status": {
"code": "ok",
"message": null
}
}
POST OrdersCancel
Метод используется для отмены заказа на комплектацию. Отмена заказа возможна, если заказ в статусе «Создан» или «Не сформирован отбор».
https://cloudcommerce.zd.ua/API/CloudWarehouse/OrdersCancel
Параметры
Запрос:
"p_api_key": <string> - API ключ*
"p_id": <string> - внутренний идентификатор документа (обязательный, если не используется p_ext_sys_guid; если заполнены p_id и p_ext_sys_guid, используется p_id)
"p_ext_sys_guid": <number> - внешний идентификатор документа (обязательный, если не используется p_id)
Ответ:
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
Запрос:
{
"p_api_key": "8ABA6F71D6D83FB8E055000000000001",
"p_id": null,
"p_ext_sys_guid": "180220/1235-0004"
}
Ответ:
{
"response": {},
"status": {
"code": "ok",
"message": null
}
}
POST PlanInboundModify
Метод используется для создания и редактирования плана прихода товара на склад.
https://cloudcommerce.zd.ua/API/CloudWarehouse/PlanInboundModify
Параметры
Запрос:
"p_api_key": <string> - API ключ*
"p_id": <number> - внутренний идентификатор документа «Плана прихода»
"p_operation_type_id": <number> - тип документа «Плана прихода»*
"p_wh_id": <number> - внутренний идентификатор склада (метод для получения справочника WarehouseList)*
"p_inbound_plan_date": <date> - плановая дата поставки*
"p_contragent_name": <string> - наименование контрагента
"p_contragent_telnum": <string> - телефонный номер контрагента
"p_ext_sys_docnum": <string> - внешний номер документа «Плана прихода»
"p_ext_sys_guid": <string> - внешний идентификатор документа «Плана прихода»*
"p_comments": <string> - комментарий
"p_items": <array> - массив объектов, структура аналогична методу "PlanInboundItemModify", кроме двух полей "p_plan_inbound_id", "p_plan_inbound_esg"
Ответ:
"id": <number> - внутренний идентификатор документа "План прихода"
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
Запрос:
{
"p_api_key": "8ABA6F71D6D83FB8E055000000000001",
"p_id": "",
"p_operation_type_id": 35,
"p_wh_id": 1,
"p_inbound_plan_date": "24.07.2020",
"p_contragent_name": "Пестик",
"p_contragent_telnum": "",
"p_ext_sys_docnum": "00000000033",
"p_ext_sys_guid": "12345",
"p_comments": "тест API 1",
"p_items": [
{
"p_id": "",
"p_ext_sys_guid": "1",
"p_goods_id": "",
"p_goods_ext_sys_guid": "0023-23",
"p_goods_mu_id": "",
"p_goods_munit_esg": "64351564845",
"p_qty": 11,
"p_serialnumbe": "",
"p_manuf_date_min": "01.07.2020",
"p_manuf_date_max": "",
"p_exp_date_min": "",
"p_exp_date_max": "",
"p_part_number": "",
"p_price": "",
"p_total_price": "",
"p_goods_qu_id": "",
"p_order_id": "",
"p_barcode": ""
}
]
}
Ответ:
{
"response": {
"id": 10004227
},
"status": {
"code": "ok",
"message": null
}
}
POST PlanInboundItemModify
Метод используется для создания и редактирования строки спецификации к плану прихода товара на склад.
https://cloudcommerce.zd.ua/API/CloudWarehouse/PlanInboundItemModify
Параметры
Запрос:
"p_api_key": <string> - API ключ*
"p_id": <number> - внутренний идентификатор документа «План прихода»
"p_ext_sys_guid": <string> - внешний идентификатор строки документа «План прихода»*
"p_plan_inbound_id": <number> - внутренний идентификатор документа «План прихода»
"p_plan_inbound_esg": <string> - внешний идентификатор документа «План прихода»
"p_goods_id": <number> - внутренний идентификатор товара
"p_goods_ext_sys_guid": <string> - внешний идентификатор товара*
"p_goods_mu_id": <number> - внутренний идентификатор единицы измерения товара (метод для получения справочника - MeasurementUnitList)
"p_goods_munit_esg": <string> - внешний идентификатор единицы измерения товара*
"p_qty": <number> - количество товара*
"p_serialnumber": <string> - серийный номер
"p_manuf_date_min": <date> - дата производства (мин) для отбора товара
"p_manuf_date_max": <date> - дата производства (макс) для отбора товара
"p_exp_date_min": <date> - дата завершения срока годности (мин)
"p_exp_date_max": <date> - дата завершения срока годности (макс)
"p_part_number": <string> - номер партии
"p_price": <number> - цена единицы товара
"p_total_price": <number> - общая сумма
"p_goods_qu_id": <number> - внутренний идентификатор качества товара (метод для получения справочника - QualityList)
"p_order_id": <number> - внутренний идентификатор заказа
"p_barcode": <string> - штрих код товара
"p_container_barcode": <string> - штрих код контейнера
"p_goods_chars": <array> - характеристики товара
"id": <number> - внутренний идентификатор характеристики
"ext_sys_guid": <string> - внешний идентификатор характеристики
"str_value": <string> - значение характеристики*
Ответ:
"id": <number> - внутренний идентификатор строки товара в плане прихода
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
Запрос:
{
"p_api_key": "8ABA6F71D6D83FB8E055000000000001",
"p_id": "",
"p_ext_sys_guid": "23465485",
"p_plan_inbound_id": "10004227",
"p_plan_inbound_esg": "",
"p_goods_id": "1010862",
"p_goods_ext_sys_guid": "",
"p_goods_mu_id": "1010864",
"p_goods_munit_esg": "",
"p_qty": 24,
"p_serialnumbe": "",
"p_manuf_date_min": "13.07.2020",
"p_manuf_date_max": "13.07.2020",
"p_exp_date_min": "",
"p_exp_date_max": "",
"p_part_number": "131119",
"p_price": "",
"p_total_price": "",
"p_goods_qu_id": "1",
"p_order_id": "",
"p_barcode": "",
"p_container_barcode": "3000100025478",
"p_goods_chars": [
{
"id": null,
"ext_sys_guid": "API_sandbox_Goods_Char",
"str_value": "Метро"
}
]
}
Ответ:
{
"response": {
"id": 157590
},
"status": {
"code": "ok",
"message": null
}
}
POST PlanInboundCancel
Метод используется для отмены документа плана прихода товара. Отмена плана прихода возможна, если документ приёма не содержит завершенных строк.
https://cloudcommerce.zd.ua/API/CloudWarehouse/PlanInboundCancel
Параметры
Запрос:
"p_api_key": <string> - API ключ*
"p_id": <string> - внутренний идентификатор документа (обязательный, если не используется p_ext_sys_guid; если заполнены p_id и p_ext_sys_guid, используется p_id)
"p_ext_sys_guid": <number> - внешний идентификатор документа (обязательный, если не используется p_id)
Ответ:
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
Запрос:
{
"p_api_key": "8ABA6F71D6D83FB8E055000000000001",
"p_id": 10004227,
"p_ext_sys_guid": null
}
Ответ:
{
"response": {},
"status": {
"code": "ok",
"message": null
}
}
POST ProcReqModify
Метод используется для создания и редактирования заявки на обработку товара.
https://cloudcommerce.zd.ua/API/CloudWarehouse/ProcReqModify
Параметры
Запрос:
"p_api_key": <string> - API ключ*
"p_doc_date": <string> - дата документа
"p_operation_type_id": <number> - тип операции (метод DocStatusList)*
"p_wh_id": <number> - идентификатор склада (метод WarehouseList)*
"p_ext_sys_docnum": <string> - внешний номер документа
"p_ext_sys_guid": <string> - внешний идентификатор документа*
"p_items_fr": <array> - массив данных о товаре до обработки
"p_ext_sys_guid": <string> - внешний идентификатор строки
"p_goods_id": <string> - внутренний идентификатор товара
"p_goods_ext_sys_guid": <string> - внешний идентификатор товара*
"p_goods_munit_id": <string> - внутренний идентификатор единицы измерения
"p_goods_munit_esg": <string> - внешний идентификатор единицы измерения*
"p_qty": <number> - количество*
"p_serialnumber": <string> - серийный номер
"p_goods_batch_id": <string> - внутренний идентификатор партии
"p_goods_batch_esg": <string> - внешний идентификатор партии
"p_manuf_date": <string> - дата производства
"p_exp_date": <string> - дата завершения срока реализации
"p_part_number": <string> - номер партии
"p_goods_qu_id": <number> - качество (метод QualityList)*
"p_container_barcode": <string> - штрих код контейнера (метод GoodsStock)
"p_goods_chars": "array" - массив характеристик товара (методы GoodsStock, GoodsCharsList)
"id": <number> - внутренний идентификатор характеристики
"ext_sys_guid": <string> - внешний идентификатор характеристики
"str_value": <string> - значение характеристики
"p_items_to": <array> - массив данных о товаре после обработки
"p_ext_sys_guid": <string> - внешний идентификатор строки
"p_goods_id": <string> - внутренний идентификатор товара
"p_goods_ext_sys_guid": <string> - внешний идентификатор товара
"p_goods_munit_id": <string> - внутренний идентификатор единицы измерения
"p_goods_munit_esg": <string> - внешний идентификатор единицы измерения
"p_qty": <number> - количество
"p_serialnumber": <string> - серийный номер
"p_goods_batch_id": <string> - внутренний идентификатор партии
"p_goods_batch_esg": <string> - внешний идентификатор партии
"p_manuf_date": <string> - дата производства
"p_exp_date": <string> - дата завершения срока реализации
"p_part_number": <string> - номер партии
"p_goods_qu_id": <number> - качество (метод QualityList)
"p_goods_chars": <array> - массив характеристик товара (метод GoodsCharsList)
"id": <number> - внутренний идентификатор характеристики
"ext_sys_guid": <string> - внешний идентификатор характеристики
"str_value": <string> - pначение характеристики
"action_type": <number> - тип операции над характеристикой: 1 – добавить/изменить, 2 – удалить
Ответ:
"id": <number> - внутренний идентификатор заявки на обработку
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное сообщение
Успешно
Запрос:
Ответ:
8. Отчеты
GET GoodsTurns
Метод позволяет получить отчет по обороту и остаткам товаров за выбранный период.
https://cloudcommerce.zd.ua/API/CloudWarehouse/GoodsTurns?APIKEY={{API_KEY}}&{{DATE_FROM}}&{{DATE_TO}}
Параметры
Запрос:
*APIKEY=<string> - индивидуальный API ключ клиента
*DATE_FROM=<date> - дата, с которой сформировать отчет
*DATE_TO=<date> - дата, до которой сформировать отчет
Ответ:
"date_from": <string> - дата с…
"date_to": <string> - дата по…
"wh_id": <number> - внутренний идентификатор склада
"wh_name": <string> - наименование склада
"goods_id": <number> - внутренний идентификатор товара
"goods_sku": <string> - артикул товара
"goods_name": <string> - наименование товара
"goods_ext_sys_guid": <string> - внешний идентификатор товара
"goods_munit_id": <number> - внутренний идентификатор единицы измерения
"goods_munit_name": <string> - наименование единицы измерения
"goods_munit_ext_sys_guid": <string> - внешний идентификатор единицы измерения
"goods_batch_id": <number> - внутренний идентификатор партии
"goods_batch_name": <string> - наименование партии
"goods_barcode_id": <number> - внутренний идентификатор штрих кода товара
"goods_barcode": <string> - штрих-код товара
"goods_quality_id": <number> - внутренний идентификатор качества
"goods_quality_name": <string> - наименование качества
"goods_chars_id": <number> - внутренний идентификатор характеристики
"goods_chars_name": <string> - наименование характеристики
"qty_remn": <number> - остаток на утро начальной даты
"qty_debit": <number> - приход
"qty_credit": <number> - расход
"qty_res": <number> - остаток на конец дня конечной даты
"goods_chars": <array> - характеристики товара
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное cообщение
Успешно
{
"response": {
"goods_turns":[
{
"date_from": "01.06.2019",
"date_to": "30.06.2019",
"wh_id":8,
"wh_name": "Склад КЗ Марк",
"goods_id": 1062544,
"goods_sku": "1000",
"goods_name": "Сок Jaffik 0,5",
"goods_ext_sys_guid": "10002",
"goods_munit_id": 1062545,
"goods_munit_name": "кор",
"goods_munit_ext_sys_guid": "10003",
"goods_batch_id": 1062551,
"goods_batch_name": "26.06.2019\/12.01.2020",
"goods_barcode_id": 1062552,
"goods_barcode": "3000100018744",
"goods_quality_id": 1,
"goods_quality_name": "Ликвид",
"goods_chars_id": null,
"goods_chars_name": null,
"qty_remn": 0,
"qty_debit": 4511,
"qty_credit": 419,
"qty_res": 4092,
"goods_chars": [ ]
},
{
"date_from": "01.06.2019",
"date_to": "30.06.2019",
"wh_id": 8,
"wh_name": "Склад КЗ Марк",
"goods_id": 1062544,
"goods_sku": "1000",
"goods_name": "Сок Jaffik 0,5",
"goods_ext_sys_guid": "10002",
"goods_munit_id": 1062545,
"goods_munit_name": "кор",
"goods_munit_ext_sys_guid": "10003",
"goods_batch_id": 1062564,
"goods_batch_name": "25.06.2019\/11.01.2020",
"goods_barcode_id": 1062565,
"goods_barcode": "3000100018752",
"goods_quality_id": 1,
"goods_quality_name": "Ликвид",
"goods_chars_id": null,
"goods_chars_name": null,
"qty_remn": 0,
"qty_debit": 531,
"qty_credit": 61,
"qty_res": 470,
"goods_chars":[ ]
},
]
},
"status": {
"code":"ok",
"message":null
}
}
GET GoodsStock
Метод позволяет получить отчет по текущим остаткам товаров.
https://cloudcommerce.zd.ua/API/CloudWarehouse/GoodsStock?APIKEY={{API_KEY}}&{{DATE_FROM}}&{{DATE_TO}}
Параметры
Запрос:
*APIKEY=<string> - индивидуальный API ключ клиента
GOODS_ID: <string> - внутренний идентификатор товара
GOODS_EXTGUID: <string> - внешний идентификатор товара
Ответ:
"goods_stock": <array> - список товаров с остатками
"goods_id": <number> - внутренний идентификатор товара
"goods_sku": <string> - артикул товара
"goods_name": <string> - название товара
"goods_ext_sys_guid": <string> - внешний идентификатор товара
"goods_munit_id": <number> - внутренний идентификатор единицы измерения (метод для получения справочника MeasurementUnitList)
"goods_munit_name": <string> - название единицы измерения товара
"goods_munit_ext_sys_guid": <string> - внешний идентификатор единицы измерения товара
"goods_batch_id": <number> - внутренний идентификатор партии
"goods_batch_name": <string> - название партии
"goods_barcode_id": <number> - внутренний идентификатор штрих кода товара
"goods_barcode_name": <string> - название штрих кода товара
"quality": <number> - внутренний идентификатор качества
"quality_name": <string> - название качества
"qty": <number> - количество товара
"qty_base": <number> - количество товара в базовой единице измерения
"manufacturer_id": <number> - внутренний идентификатор производителя
"manufacturer_esg": <number> - внешний идентификатор производителя
"goods_chars_id": <number> - внутренний идентификатор значения характеристики
"goods_chars_name": <string> - наименование значения характеристики
"barcode_container": <string> - штрих код контейнера
"goods_chars": <array> - характеристики товара
"id": <number> - внутренний идентификатор характеристики
"ext_sys_guid": <string> - внешний идентификатор характеристики
"name": <string> - наименование характеристики
"str_value": <string> - значение характеристик
"status": <object> - статус запроса
"code": <string> - код статуса выполнения
"message": <string> - информационное cообщение
Успешно
{
"response": {
"goods_stock":[
{
"goods_id": 1003828,
"goods_sku": "1009-50201-12743/3111/30:34",
"goods_name": "1009-50201-12743/3111/30:34",
"goods_ext_sys_guid": null,
"goods_munit_id": 1004774,
"goods_munit_name": "шт",
"goods_munit_ext_sys_guid": null,
"goods_batch_id": null,
"goods_batch_name": null,
"goods_barcode_id": 1006114,
"goods_barcode_name": "8680890342644",
"quality": 1,
"quality_name": "Кондиция",
"qty": 1,
"manufacturer_id": null,
"manufacturer_esg": null
}
]
},
"status": {
"code": "ok",
"message": ""
}
}