### GET /api/{token}/unloadingorders/list/ Source: https://api-doc.wmscelicom.ru/openapi.yaml Возвращает список запланированных заявок на поставку. Поддерживает фильтрацию по ID, статусам и диапазону дат. ```markdown ### Parameters - **token** (string, path, required): Ваш API токен доступа - **ids** (string, query, optional): JSON-массив внутренних ID заявок (example: "[123, 456]") - **status** (string, query, optional): JSON-массив названий статусов (example: "[\"Новая\", \"Ожидает приемки\"]") - **date** (string, query, optional): JSON-массив диапазона дат [от, до] (example: "[\"2024-01-01\", \"2024-12-31\"]") - **page** (integer, query, optional): Номер страницы (для пагинации) - **limit** (integer, query, optional): Количество записей на страницу (max 30) ### Responses #### 200 - Успешный ответ со списком заявок - **status** (string) (example: "OK") - **code** (integer) (example: 200) - **data** (object): Объект заявок, где ключом является ID заявки ### Example Usage ```bash curl -X GET "https://{clientName}//api/{token}/unloadingorders/list/?ids=[123, 456]&status=["Новая", "Ожидает приемки"]&date=["2024-01-01", "2024-12-31"]&page=1&limit=30" ``` ``` -------------------------------- ### GET /api/{token}/dispatchorders/list/ Source: https://api-doc.wmscelicom.ru/openapi.yaml Возвращает список заявок из системы отгрузок. Поддерживает фильтрацию по внутренним ID (ids), статусам и датам. Данные сгруппированы по ID заявки. ```markdown ### Parameters - **token** (string, path, required): Персональный API токен доступа - **ids** (string, query, optional): JSON-массив внутренних ID заявок (например: [101, 102]) - **status** (string, query, optional): JSON-массив статусов: new, combinig, waitingdelivery, ondelivery, waitclientapproval, delivered, combined, waitforcombine, annuled - **date** (string, query, optional): JSON-массив даты [дата от, дата до] (YYYY-MM-DD) (example: "[\"2024-01-01\", \"2024-12-31\"]") - **page** (integer, query, optional): Номер страницы (по умолчанию 1) - **limit** (integer, query, optional): Лимит записей (1-30, по умолчанию 30) ### Responses #### 200 - Список заявок - **status** (string) (example: "OK") - **data** (object) ### Example Usage ```bash curl -X GET "https://{clientName}//api/{token}/dispatchorders/list/?ids=string&status=string&date=["2024-01-01", "2024-12-31"]&page=1&limit=30" ``` ``` -------------------------------- ### GET /api/{token}/orders/list/ Source: https://api-doc.wmscelicom.ru/openapi.yaml Возвращает список заказов, сгруппированных по ID. Поддерживает фильтры по ID заказов, статусам и диапазону дат через JSON-массивы. ```markdown ### Parameters - **token** (string, path, required): Персональный API токен доступа - **ids** (string, query, optional): JSON-массив внутренних ID заказов [123, 124]. Если передан, пагинация игнорируется. - **status** (string, query, optional): JSON-массив статусов: new, combinig, waitingdelivery, ondelivery, waitclientapproval, delivered, combined, waitforcombine, annuled - **date** (string, query, optional): JSON-массив [начало, конец] в формате YYYY-MM-DD (example: "[\"2024-01-01\", \"2024-12-31\"]") - **page** (integer, query, optional): Номер страницы (работает только без фильтра ids) - **limit** (integer, query, optional): Количество заказов на страницу (1-30) ### Responses #### 200 - Успешный ответ - **status** (string) (example: "OK") - **data** (object) ### Example Usage ```bash curl -X GET "https://{clientName}//api/{token}/orders/list/?ids=string&status=string&date=["2024-01-01", "2024-12-31"]&page=1&limit=30" ``` ``` -------------------------------- ### GET /api/{token}/dispatchorders/get Source: https://api-doc.wmscelicom.ru/openapi.yaml Возвращает заявку с детализацией по товарам, внешним ID и кодам маркировки (CIS). ```markdown ### Parameters - **token** (string, path, required): Персональный API токен доступа - **id** (string, query, required): Id заявки. ### Responses #### 200 - Успешный ответ - **status** (string) (example: "OK") - **data** (array (object)) Array items: - **orderid** (integer) (example: 101) - **externalid** (string) (example: "12345678") - **shipmentid** (integer) (example: 550) - **status** (string (new|combinig|waitingdelivery|ondelivery|waitclientapproval|delivered|combined|waitforcombine|annuled|unknown)) (example: "waitingdelivery") ("new"|"combinig"|"waitingdelivery"|"ondelivery"|"waitclientapproval"|"delivered"|"combined"|"waitforcombine"|"annuled"|"unknown") - **items** (array (object)) Array items: - **article** (string) (example: "SKU-99") - **count** (integer) (example: 2) - **cis** (array (string)) ### Example Usage ```bash curl -X GET "https://{clientName}//api/{token}/dispatchorders/get?id=string" ``` ``` -------------------------------- ### GET /api/{token}/items/get/ Source: https://api-doc.wmscelicom.ru/openapi.yaml Возвращает список товаров. Поддерживает поиск по части артикула (LIKE), точный поиск (артикул, ID, штрихкод) и пагинацию. Параметры id, article_prec и barcode принимают как одиночные значения, так и JSON-массивы. ```markdown ### Parameters - **token** (string, path, required): Персональный API токен доступа - **id** (string, query, optional): ID товара или JSON-массив ID (например: 123 или [123, 124]) - **article** (string, query, optional): Частичное совпадение артикула (LIKE). Строка или JSON-массив строк. - **article_prec** (string, query, optional): Точное совпадение артикула или JSON-массив артикулов (например: ["SKU1", "SKU2"]) - **barcode** (string, query, optional): Штрихкод или JSON-массив штрихкодов (например: ["46000", "46001"]) - **page** (integer, query, optional): Номер страницы (по умолчанию 1) - **limit** (integer, query, optional): Количество элементов на странице (макс. 30) ### Responses #### 200 - Список товаров - Array of object - **Id** (integer) (example: 1) - **Name** (string) (example: "Товар №1") - **Count** (integer): Общий остаток (example: 10) - **CountVirtual** (integer): Виртуальный остаток (example: 5) - **Article** (string) (example: "SKU-123") - **Barcodes** (array (string)) (example: ["4600000000000","4600000000001"]) ### Example Usage ```bash curl -X GET "https://{clientName}//api/{token}/items/get/?id=string&article=string&article_prec=string&barcode=string&page=1&limit=30" ``` ``` -------------------------------- ### GET /api/{token}/orders/get Source: https://api-doc.wmscelicom.ru/openapi.yaml Возвращает детали заказа по его OrderId с проверкой прав доступа юридического лица ```markdown ### Parameters - **token** (string, path, required): Персональный API токен доступа (example: "w06rnur337n57ji") - **orderId** (string, query, required): Идентификатор заказа ### Responses #### 200 - Успешный ответ - **status** (string) (example: "OK") - **data** (array (object)) Array items: - **orderid** (string) (example: "12345") - **items** (array (object)) Array items: - **article** (string) (example: "A100") - **count** (integer) (example: 2) - **cis** (string) (example: "01046...\\u001d21...") - **status** (string (new|processing|ondelivery|ondeliverybylogistic|return|canceled|delivered|refused)) (example: "processing") ("new"|"processing"|"ondelivery"|"ondeliverybylogistic"|"return"|"canceled"|"delivered"|"refused") #### 400 - Ошибка валидации - **status** (string) (example: "ERROR") - **message** (string) (example: "orderId is required!") ### Example Usage ```bash curl -X GET "https://{clientName}//api/{token}/orders/get?orderId=string" ``` ``` -------------------------------- ### GET /api/{token}/unloadings/list/ Source: https://api-doc.wmscelicom.ru/openapi.yaml Возвращает подробный список разгрузок с привязкой к заявкам на приемку и самим приемки. Возможны фильтры по диапазону дат, по id, по id заявок и по старусам ```markdown ### Parameters - **token** (string, path, required): Ваш API токен доступа - **ids** (string, query, optional): массив ID разгрузок (example: "[\"105\", \"106\"]") - **status** (string, query, optional): массив названий статусов (Новая, В работе, Принята и т.д.) (example: "[\"Принята\"]") - **unloading_order_ids** (string, query, optional): массив ID родительских заявок на поставку (example: "[\"3260\"]") - **date** (string, query, optional): массив диапазона дат [от, до] (example: "[\"2024-03-01\", \"2024-03-31\"]") - **page** (integer, query, optional) - **limit** (integer, query, optional) ### Responses #### 200 - Успешный возврат списка разгрузок - **status** (string) (example: "OK") - **code** (integer) (example: 200) - **data** (object) ### Example Usage ```bash curl -X GET "https://{clientName}//api/{token}/unloadings/list/?ids=["105", "106"]&status=["Принята"]&unloading_order_ids=["3260"]&date=["2024-03-01", "2024-03-31"]&page=1&limit=30" ``` ``` -------------------------------- ### POST /api/{token}/dispatchorders/add/ Source: https://api-doc.wmscelicom.ru/openapi.yaml ### Метод создает заявку на отгрузу в статусе Новая ### Правила заполнения additinfo: **1. Для YandexGoGlobal (delivery=4):** * `pickup_type`: 'custom_location' (до двери) или 'platform_station' (ПВЗ) — **обязательно**. * `region`: объект с `value` (GeoID) и `textvalue` (Название города) — **обязательно**. * `recipient_name`, `recipient_lname`, `recipient_email` и `recipient_phones`: данные получателя — **обязательно**. * **Если `pickup_type` = 'custom_location':** * `to_location_street` и `to_location_streetnumber` — **обязательно**. * `to_location_streetnumber_corpus`, `to_location_streetnumber_bld`, `to_location_appartment` — опционально. * **Если `pickup_type` = 'platform_station':** * `delivery_point` (код ПВЗ) — **обязательно**. **2. Для CDEK (delivery=1):** * `tariff_code`: код тарифа СДЭК — **обязательно**. * `recipient_name` и `recipient_phones`: ФИО и телефон (минимум 11 цифр) — **обязательно**. * `city`: ID города или его название. **Важно:** Если указан ПВЗ, город можно не передавать (определится автоматически). * **Если тариф 'до склада':** обязателен `delivery_point` (код ПВЗ). * **Если тариф 'до двери':** обязателен `to_location_address` (полный адрес) И город (ID или название). * **Автоматика:** Если вы не передали `region` или `city`, система попытается найти их по коду ПВЗ или названию города. **3. Для Самовывоза (delivery=2):** * Данный тип не требует передачи адреса или ПВЗ. * Рекомендуется передать `recipient_name` и `recipient_phones` для идентификации клиента при выдаче. ```markdown ### Parameters - **token** (string, path, required): Персональный API токен доступа ### Request Body **Content-Type:** multipart/form-data - **delivery** (integer) (required) ("1"|"2"|"4") - **items** (string) (required): JSON-строка с массивом товаров - **additinfo** (string): JSON-строка с доп. информацией - **file[]** (array (string (binary))): Массив файлов (этикетки) **Content-Type:** application/json - **delivery** (integer) (required): 1 - CDEK, 4 - Yandex ("1"|"2"|"4") - **additinfo** (object) - **tariff_code** (object) - **value** (string) (example: "136") - **city** (object) - **region** (object) - **value** (string) (example: "213") - **textvalue** (string) (example: "Москва") - **delivery_point** (object) - **to_location_address** (object) - **recipient_name** (object) - **recipient_phones** (object) - **pickup_type** (object) - **to_location_street** (object) - **to_location_streetnumber** (object) - **items** (array (object)) (required) Array items: - **barcode** (string) - **count** (integer) ### Responses #### 200 - Результат обработки запроса - **status** (string) (example: "OK") - **id** (integer) (example: 12345) - **delivery_info** (object) - **tariff_code** (object) - **value** (string) - **city** (object) - **delivery_point** (object) ### Example Usage ```bash curl -X POST "https://{clientName}//api/{token}/dispatchorders/add/" \ -H "Content-Type: application/json" \ -d '{ "delivery": "0", "items": "string", "additinfo": "string", "file[]": [ "string" ] }' ``` ``` -------------------------------- ### POST /api/{token}/dispatchorders/delete/ Source: https://api-doc.wmscelicom.ru/openapi.yaml Полностью удаляет заявку из системы. При удалении все товары, зарезервированные в заказе, автоматически возвращаются на остатки склада (инвентаризируются обратно). ```markdown ### Parameters - **token** (string, path, required): Персональный API токен доступа ### Request Body **Content-Type:** application/json - **id** (integer) (required): Уникальный идентификатор заявки (orderId) (example: 12345) ### Responses #### 200 - Успешное удаление - **status** (string) (example: "OK") - **message** (string) (example: "Order with ID 12345 has been deleted") #### 400 - Ошибка при удалении (не найден или нет прав) - **status** (string) (example: "ERROR") - **message** (string (orderId is required!|Order with ID 12345 not found!|Permission denied!)) (example: "Permission denied!") ("orderId is required!"|"Order with ID 12345 not found!"|"Permission denied!") ### Example Usage ```bash curl -X POST "https://{clientName}//api/{token}/dispatchorders/delete/" \ -H "Content-Type: application/json" \ -d '{ "id": 12345 }' ``` ``` -------------------------------- ### POST /api/{token}/unloadingorders/add/ Source: https://api-doc.wmscelicom.ru/openapi.yaml Метод создает новую заявку на поставку. Принимает список товаров, файлы и дополнительные метаданные. Валидирует дату поставки и наличие товаров. ```markdown ### Parameters - **token** (string, path, required): Ваш API токен доступа ### Request Body **Content-Type:** multipart/form-data - **delivery_date_time** (string) (required): Дата поставки (YYYY-MM-DD или YYYY-MM-DD HH:MM:SS) (example: "2026-03-27 15:00:00") - **items** (string): JSON-массив товаров (barcode или article + count) (example: "[{\"barcode\":\"564637383243\",\"count\":1}]") - **storage_type** (string (FBO|FBS)): Тип хранения: FBO (склад маркетплейса) или FBS (склад продавца) ("FBO"|"FBS") - **allow_itemless_acceptance** (integer): 0: Состав указан, 1: Принимать по факту, 2: Заполню позже ("0"|"1"|"2") - **comment** (string): Комментарий к заявке (example: "Заказ через API") - **additinfo** (string): Дополнительная информация в формате JSON (example: "{\"external_id\": 12345}") - **file** (array (string (binary))): Прикрепляемые файлы (картинки/документы) ### Responses #### 200 - Заявка успешно создана - **status** (string) (example: "OK") - **unloading_order_id** (integer) (example: 3260) - **delivery_info** (object): Декодированные данные из additinfo #### 400 - Ошибка валидации - **status** (string) (example: "ERROR") - **message** (string) (example: "Delivery date cannot be in the past") ### Example Usage ```bash curl -X POST "https://{clientName}//api/{token}/unloadingorders/add/" \ -H "Content-Type: application/json" \ -d '{ "delivery_date_time": "2026-03-27 15:00:00", "items": "[{\"barcode\":\"564637383243\",\"count\":1}]", "storage_type": "FBO", "allow_itemless_acceptance": "0", "comment": "Заказ через API", "additinfo": "{\"external_id\": 12345}", "file": [ "string" ] }' ``` ``` -------------------------------- ### POST /api/{token}/dispatchorders/send/ Source: https://api-doc.wmscelicom.ru/openapi.yaml Метод подтверждает заявку и переводит её в статус сборки. При вызове создается запись об отгрузке (Shipment) и проверяется заполнение обязательных интеграционных полей. ```markdown ### Parameters - **token** (string, path, required): Персональный API токен доступа ### Request Body **Content-Type:** application/json - **id** (integer) (required): ID заявки на отгрузку (example: 12345) ### Responses #### 200 - Успешная отправка на сборку - **status** (string) (example: "OK") - **message** (string) (example: "Order successfully sent for processing") - **order_id** (integer) (example: 12345) - **shipment_id** (integer): ID созданной отгрузки (example: 6789) #### 400 - Ошибка валидации или прав доступа - **status** (string) (example: "ERROR") - **message** (string) (example: "orderId is required! / Permissions denied!") ### Example Usage ```bash curl -X POST "https://{clientName}//api/{token}/dispatchorders/send/" \ -H "Content-Type: application/json" \ -d '{ "id": 12345 }' ``` ``` -------------------------------- ### POST /api/{token}/unloadingorders/delete/ Source: https://api-doc.wmscelicom.ru/openapi.yaml Удаляет заявку и все её позиции. Удаление возможно только для заявок в статусе 'Новая', при отсутствии привязанных разгрузок и активных резервов в заказах на отгрузку (Dispatch Orders). ```markdown ### Parameters - **token** (string, path, required): Ваш API токен доступа ### Request Body **Content-Type:** application/x-www-form-urlencoded - **id** (integer) (required): Внутренний ID заявки (unloading_order_id) (example: 3260) ### Responses #### 200 - Заявка успешно удалена - **status** (string) (example: "OK") - **message** (string) (example: "Unloading order with ID 3260 has been deleted") #### 400 - Ошибка удаления (статус не позволяет, найдены резервы или разгрузки) - **status** (string) (example: "ERROR") - **message** (string) (example: "Cannot delete the unloading order: active reserves found in dispatch orders.") #### 403 - Ошибка доступа (заявка принадлежит другому юридическому лицу) - **status** (string) (example: "ERROR") - **message** (string) (example: "Permission denied!") ### Example Usage ```bash curl -X POST "https://{clientName}//api/{token}/unloadingorders/delete/" \ -H "Content-Type: application/json" \ -d '{ "id": 3260 }' ``` ``` -------------------------------- ### API Overview: API WMS Celicom Source: https://api-doc.wmscelicom.ru/openapi.yaml ## Общая информация по API Celicom Данное API предназначено для интеграции складской системы с внешними сервисами. ### Основные возможности: * Создание, получение, отправление в сборку заявок на отгрузку (**DispatchOrders**). * Получение товаров. * Интеграция с курьерскими службами (СДЭК, Яндекс Go или самовывоз.). ### Ограничения: * У запросов есть лимит: 150 в минуту. * При запросах из бд за один запрос пожно получить не более 30 элементов. ### Авторизация: Все запросы должны содержать персональный токен доступа в URL: `/api/{token}/...` ```yaml # API WMS Celicom # Version: 1.0.0 ## Общая информация по API Celicom Данное API предназначено для интеграции складской системы с внешними сервисами. ### Основные возможности: * Создание, получение, отправление в сборку заявок на отгрузку (**DispatchOrders**). * Получение товаров. * Интеграция с курьерскими службами (СДЭК, Яндекс Go или самовывоз.). ### Ограничения: * У запросов есть лимит: 150 в минуту. * При запросах из бд за один запрос пожно получить не более 30 элементов. ### Авторизация: Все запросы должны содержать персональный токен доступа в URL: `/api/{token}/...` # Base URL: https://{clientName}/ ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.