Заказы
Получить список заказов
Возвращает заказы клиента из X-Client-ID: товары, статусы и pagination.
Пагинация — page / per_page. Доступны фильтры по статусу, складам, датам создания, номеру заказа number и артикулу article. Строковый number отличается от числового order_id.
query Parameters
pageНомер страницы
per_pageКоличество элементов на странице
order_byСортировка по:
number- по номеруdate_insert- по дате созданияdate_update- по дате обновленияstatus- по статусуstorage- по складуprice- по суммеtotal_products- по количествуcomment- по комментарии
sortТип сортировки:
asc- по возрастаниюdesc- по убыванию
storageФильтр по складу (может быть несколько)
statusФильтр по статусу
Статус заказа:
-
confirmed- Подтверждён -
in_delivery- На поставку -
under_review- На рассмотрении -
shipment_creation- Создание отгрузки -
shipment_under_review- Отгрузка в обработке -
collecting- Собирается -
cancelled- Отменен -
shipped- Отгружен -
rejected- Отклонен -
fix_required- Требует исправления -
processing_error- Нет остатков/цен
date_fromФильтр по дате создания (от)
date_toФильтр по дате создания (до)
numberФильтр по номеру заказа
articleФильтр по артикулу товара в заказе
Headers
X-Client-IDИдентификатор клиента, от имени которого выполняется операция
Получить список заказов › Responses
Список заказов успешно получен
Метаданные пагинации
Создать заказ
Создаёт оптовый заказ для клиента из X-Client-ID. Передайте storage_id и products с артикулом code, количеством quantity и ценой price. Схема также требует products[].id, но при создании сервис назначает ID сам; можно использовать 0, как в руководстве.
Ответ содержит числовой id и статус under_review. Общая стоимость рассчитывается как сумма price × quantity; подтверждение заказа и резерва происходит отдельно.
Сохраните id как order_id. После таймаута проверьте список заказов: повторный POST может создать ещё один заказ.
Headers
X-Client-IDИдентификатор клиента, от имени которого выполняется операция
Создать заказ › Request Body
storage_idИдентификатор склада
Список товаров в заказе
commentКомментарий к заказу
Создать заказ › Responses
Заказ успешно создан
date_insertДата создания
statusСтатус заказа:
-
confirmed- Подтверждён -
in_delivery- На поставку -
under_review- На рассмотрении -
shipment_creation- Создание отгрузки -
shipment_under_review- Отгрузка в обработке -
collecting- Собирается -
cancelled- Отменен -
shipped- Отгружен -
rejected- Отклонен -
fix_required- Требует исправления -
processing_error- Нет остатков/цен
client_idИдентификатор клиента
storage_idИдентификатор склада
total_priceОбщая сумма заказа
Список товаров в заказе
idИдентификатор заказа
bx_idИдентификатор заказа bitrix
numberНомер заказа
date_updateДата обновления
is_activeПроведен true (да) или false (нет).
consignee_idИдентификатор грузополучателя
operation_typeТип операции
seller_idИдентификатор организации продавца
contract_idИдентификатор договора
is_shipment_blockedБлок отгрузки: true (да) или false (нет)
reservation_expires_atДата и время истечения резерва
keep_reservation_openНе закрывать резерв автоматически: true (да) или false (нет)
total_productsКоличество товаров
Информация об отгрузке
Информация о водителе
Информация о траспортной компании
commentКомментарий к заказу
Получить заказ по идентификатору
Возвращает заказ клиента из X-Client-ID: товары, суммы, статус и связанную отгрузку, если она есть.
В order_id передавайте числовой id из ответа создания или списка, не строковый number. Метод используется для проверки обработки заказа.
path Parameters
order_idИдентификатор заказа
Headers
X-Client-IDИдентификатор клиента, от имени которого выполняется операция
Получить заказ по идентификатору › Responses
Заказ успешно получен
date_insertДата создания
statusСтатус заказа:
-
confirmed- Подтверждён -
in_delivery- На поставку -
under_review- На рассмотрении -
shipment_creation- Создание отгрузки -
shipment_under_review- Отгрузка в обработке -
collecting- Собирается -
cancelled- Отменен -
shipped- Отгружен -
rejected- Отклонен -
fix_required- Требует исправления -
processing_error- Нет остатков/цен
client_idИдентификатор клиента
storage_idИдентификатор склада
total_priceОбщая сумма заказа
Список товаров в заказе
idИдентификатор заказа
bx_idИдентификатор заказа bitrix
numberНомер заказа
date_updateДата обновления
is_activeПроведен true (да) или false (нет).
consignee_idИдентификатор грузополучателя
operation_typeТип операции
seller_idИдентификатор организации продавца
contract_idИдентификатор договора
is_shipment_blockedБлок отгрузки: true (да) или false (нет)
reservation_expires_atДата и время истечения резерва
keep_reservation_openНе закрывать резерв автоматически: true (да) или false (нет)
total_productsКоличество товаров
Информация об отгрузке
Информация о водителе
Информация о траспортной компании
commentКомментарий к заказу
Обновить заказ
Обновляет комментарий к заказу клиента, указанного в заголовке X-Client-ID.
Комментарий можно изменить в любом статусе заказа.
Поле comment обновляется только при его передаче в запросе.
Если поле не передано, текущий комментарий сохраняется.
path Parameters
order_idИдентификатор заказа
Headers
X-Client-IDИдентификатор клиента, от имени которого выполняется операция
Обновить заказ › Responses
Заказ успешно обновлён
date_insertДата создания
statusСтатус заказа:
-
confirmed- Подтверждён -
in_delivery- На поставку -
under_review- На рассмотрении -
shipment_creation- Создание отгрузки -
shipment_under_review- Отгрузка в обработке -
collecting- Собирается -
cancelled- Отменен -
shipped- Отгружен -
rejected- Отклонен -
fix_required- Требует исправления -
processing_error- Нет остатков/цен
client_idИдентификатор клиента
storage_idИдентификатор склада
total_priceОбщая сумма заказа
Список товаров в заказе
idИдентификатор заказа
bx_idИдентификатор заказа bitrix
numberНомер заказа
date_updateДата обновления
is_activeПроведен true (да) или false (нет).
consignee_idИдентификатор грузополучателя
operation_typeТип операции
seller_idИдентификатор организации продавца
contract_idИдентификатор договора
is_shipment_blockedБлок отгрузки: true (да) или false (нет)
reservation_expires_atДата и время истечения резерва
keep_reservation_openНе закрывать резерв автоматически: true (да) или false (нет)
total_productsКоличество товаров
Информация об отгрузке
Информация о водителе
Информация о траспортной компании
commentКомментарий к заказу
Отменить заказ
Устанавливает заказу клиента из X-Client-ID статус cancelled. Ответ содержит id и status; запись остаётся в истории.
Передача отмены в учётную систему выполняется отдельно. Если отгрузка уже началась, согласуйте её остановку.
path Parameters
order_idИдентификатор заказа
Headers
X-Client-IDИдентификатор клиента, от имени которого выполняется операция
Отменить заказ › Responses
Заказ успешно отменён
idstatusСтатус заказа:
-
confirmed- Подтверждён -
in_delivery- На поставку -
under_review- На рассмотрении -
shipment_creation- Создание отгрузки -
shipment_under_review- Отгрузка в обработке -
collecting- Собирается -
cancelled- Отменен -
shipped- Отгружен -
rejected- Отклонен -
fix_required- Требует исправления -
processing_error- Нет остатков/цен
messageПолучить отгрузку по идентификатору заказа
Возвращает одну отгрузку заказа клиента из X-Client-ID: тип, статус и реквизиты доставки. Ответ — объект, не массив.
order_id — числовой идентификатор заказа. Для списка отгрузок по разным заказам используйте GET /shipments относительно префикса сервиса.
path Parameters
order_idИдентификатор заказа
Headers
X-Client-IDИдентификатор клиента, от имени которого выполняется операция
Получить отгрузку по идентификатору заказа › Responses
Отгрузка успешно получена
idИдентификатор отгрузки
order_idИдентификатор заказа
numberНомер отгрузки
order_numberНомер заказа
typeТип отгрузки
date_insertДата создания
date_updateДата обновления
statusСтатус отгрузки:
-
shipment_creation- Создание отгрузки -
under_review- В обработке -
collecting- Собирается -
transfer_order_created- Создан транспортный заказ -
sending_marking_codes- Отправка кодов маркировки -
marking_of_packages- Отметка грузовых мест -
ready_mark_before_labeling- Отметка готовности перед маркировкой -
marking- Маркировка -
cancelled- Отменено -
shipped- Отгружено -
assembly_expected- Ожидается сборка -
collected- Собрано -
ready_for_shipment- Готово к отгрузке -
loading_control- Контроль погрузки -
packed_in_pallet- Упаковано в палет
addressАдрес доставки
recipientПолучатель
recipient_phoneТелевон получателя
payerПлательщик
delivery_dateЖелаемая дата доставки
commentКомментарий к доставке
upd_numberНомер УПД
planning_dateЗапланированная дата
itinerary_numberНомер маршрута
product_groupКатегория товара
regionРегион/город
История изменения статуса поставки
Создать отгрузку
Создаёт отгрузку заказа клиента из X-Client-ID, если действующей отгрузки ещё нет, а заказ имеет статус under_review, confirmed или part_confirmed.
Для всех типов (delivery, pickup, delivery_tk) обязательны адрес, получатель, телефон, дата и плательщик. Для delivery_tk нужны также transport_company, tk_delivery_cost в копейках и tk_delivery_to_terminal. Для остальных типов эти три поля опустите или передайте null.
Начальный статус — shipment_creation. Если отгрузка уже есть, POST возвращает её без изменения реквизитов. Актуальный статус проверяйте через GET.
path Parameters
order_idИдентификатор заказа
Headers
X-Client-IDИдентификатор клиента, от имени которого выполняется операция
Создать отгрузку › Request Body
typeТип отгрузки
addressАдрес доставки
recipientПолучатель
recipient_phoneТелевон получателя
payerПлательщик
delivery_dateЖелаемая дата доставки
commentКомментарий к доставке
Decision Table
| Variant | Matching Criteria |
|---|---|
| requires: transport_company, tk_delivery_cost, tk_delivery_to_terminal | |
| No specific criteria |
transport_companyНазвание или код выбранной транспортной компании. Обязателен для delivery_tk.
tk_delivery_costСтоимость доставки транспортной компанией в копейках без конвертации.
tk_delivery_to_terminaltrue — доставка до терминала ТК, false — доставка до адреса получателя.
typeСоздать отгрузку › Responses
Возвращена созданная или ранее существовавшая отгрузка. Дальнейший статус проверяйте методом GET.
idИдентификатор отгрузки
order_idИдентификатор заказа
numberНомер отгрузки
order_numberНомер заказа
typeТип отгрузки
date_insertДата создания
date_updateДата обновления
statusСтатус отгрузки:
-
shipment_creation- Создание отгрузки -
under_review- В обработке -
collecting- Собирается -
transfer_order_created- Создан транспортный заказ -
sending_marking_codes- Отправка кодов маркировки -
marking_of_packages- Отметка грузовых мест -
ready_mark_before_labeling- Отметка готовности перед маркировкой -
marking- Маркировка -
cancelled- Отменено -
shipped- Отгружено -
assembly_expected- Ожидается сборка -
collected- Собрано -
ready_for_shipment- Готово к отгрузке -
loading_control- Контроль погрузки -
packed_in_pallet- Упаковано в палет
addressАдрес доставки
recipientПолучатель
recipient_phoneТелевон получателя
payerПлательщик
delivery_dateЖелаемая дата доставки
commentКомментарий к доставке
upd_numberНомер УПД
planning_dateЗапланированная дата
itinerary_numberНомер маршрута
product_groupКатегория товара
regionРегион/город
История изменения статуса поставки
Получить список резервов
Возвращает позиции заказов клиента из X-Client-ID в статусах confirmed и part_confirmed. Это резервы, не свободные остатки склада.
Фильтры: артикул, номер заказа, склады и даты создания заказов. Пагинация — page / per_page; ответ — reserves и pagination.
query Parameters
pageНомер страницы
per_pageКоличество элементов на странице
order_byСортировка по:
number- по номеруdate_insert- по дате созданияdate_update- по дате обновленияstatus- по статусуstorage- по складуprice- по суммеtotal_products- по количествуcomment- по комментарии
sortТип сортировки:
asc- по возрастаниюdesc- по убыванию
storageФильтр по складу (может быть несколько)
date_fromФильтр по дате создания (от)
date_toФильтр по дате создания (до)
numberФильтр по номеру заказа
articleФильтр по номеру заказа
Headers
X-Client-IDИдентификатор клиента, от имени которого выполняется операция
Получить список резервов › Responses
Список резервов успешно получен
Метаданные пагинации
Получить список отгрузок
Возвращает список отгрузок клиента, указанного в заголовке
X-Client-ID, с поддержкой фильтрации, сортировки и пагинации.
Фильтрация отгрузок:
status— по текущему статусу отгрузки.date_from— по дате создания, начиная с указанной даты.date_to— по дате создания, до указанной даты включительно.number— по номеру отгрузки.order_number— по номеру заказа.upd_number— по номеру универсального передаточного документа (УПД).itinerary_number— по номеру маршрута.product_group— по группе товаров:tyres— шины;rims— диски.
Сортировка:
Параметр order_by определяет поле сортировки:
number— номер отгрузки.date_insert— дата создания.date_update— дата последнего обновления.type— тип отгрузки.status— текущий статус.planning_date— плановая дата.
По умолчанию сортировка выполняется по date_insert.
Направление сортировки задаётся параметром sort.
Пагинация:
page— номер страницы.per_page— количество отгрузок на странице.
Особенности:
- Каждая отгрузка имеет уникальный идентификатор
id. - Номер отгрузки (
number) отличается от номера заказа (order_number). - Одному заказу может соответствовать несколько отгрузок.
- Отгрузка может существовать независимо от наличия заказа в системе.
- Статусы отгрузок отличаются от статусов заказов.
- Для получения подробной информации об отдельной отгрузке
используется метод
GET /shipments/{shipment_id}.
Ответ:
Возвращает объект с информацией о пагинации (pagination)
и массивом отгрузок (shipments).
Если по заданным фильтрам отгрузки не найдены,
возвращается пустой массив shipments.
query Parameters
pageНомер страницы
per_pageКоличество элементов на странице
order_byСортировка по:
number- по номеруdate_insert- по дате добавленияdate_update- по дате измененияtype- по типуstatus- по статусуplanning_date- по запланированной дате
sortТип сортировки:
asc- по возрастаниюdesc- по убыванию
statusФильтр по статусу
Статус отгрузки:
-
shipment_creation- Создание отгрузки -
under_review- В обработке -
collecting- Собирается -
transfer_order_created- Создан транспортный заказ -
sending_marking_codes- Отправка кодов маркировки -
marking_of_packages- Отметка грузовых мест -
ready_mark_before_labeling- Отметка готовности перед маркировкой -
marking- Маркировка -
cancelled- Отменено -
shipped- Отгружено -
assembly_expected- Ожидается сборка -
collected- Собрано -
ready_for_shipment- Готово к отгрузке -
loading_control- Контроль погрузки -
packed_in_pallet- Упаковано в палет
date_fromФильтр по дате создания (от)
date_toФильтр по дате создания (до)
numberФильтр по номеру отгрузки
order_numberФильтр по номеру заказа
upd_numberФильтр по номеру УПД
itinerary_numberФильтр по номеру маршрута
product_groupФильтр по группе товаров:
tyres- Шиныrims- диски
Headers
X-Client-IDИдентификатор клиента, от имени которого выполняется операция
Получить список отгрузок › Responses
Список отгрузок успешно получен
Метаданные пагинации
Получить отгрузку по идентификатору
Возвращает подробную информацию об отгрузке по её уникальному
числовому идентификатору shipment_id.
Информация об отгрузке:
- Номер отгрузки (
number). - Номер связанного заказа (
order_number). - Тип доставки (
type). - Текущий статус отгрузки (
status). - Дата создания (
date_insert). - Дата последнего обновления (
date_update). - Плановая дата (
planning_date). - Адрес доставки (
address). - Номер УПД (
upd_number). - Номер маршрута (
itinerary_number). - Группа товаров (
product_group). - Регион доставки (
region). - Другие доступные данные отгрузки.
Товары отгрузки: Метод возвращает список товаров, относящихся к отгрузке, включая доступную информацию о каждом товаре.
Параметр shipment_id:
- Числовой идентификатор отгрузки (
id). - Не является номером отгрузки (
number). - Не является номером заказа (
order_number). - Может быть получен из ответа метода
GET /shipments.
Особенности:
- Доступ к отгрузке ограничивается клиентом, указанным
в заголовке
X-Client-ID. - Отгрузка может существовать независимо от наличия связанного заказа в системе.
- Статусы отгрузок отличаются от статусов заказов.
- Для поиска отгрузок используется метод
GET /shipments.
Метод предназначен для просмотра состава отгрузки, проверки её текущего состояния и отслеживания процесса обработки.
path Parameters
shipment_idИдентификатор отгрузки
Получить отгрузку по идентификатору › Responses
Информация об отгрузке успешно получена
Информация об отгрузке
Список товаров отгрузки