Перейти к содержимому

Все методы API

Каталог методов https://ВАШ_ДОМЕН/api/integrations/v1.
Обозначения полей и сумм: Структура и обозначения.
Права: Авторизация.

Единственный публичный REST интеграций. Legacy /api/b2b и /api/1c сняты.

Сводка по сущностям

СущностьЧитатьСоздатьИзменитьУдалитьСтраница
Пользователидадададапользователи и организации
Заказыдадаполя, статус, meta, архивдаработа с заказами
Позиции заказададаqty/цена/коммент, статус, архивдаработа с заказами
Статусысправочникстатусы
ПроценкаPOST /pricing/searchпроценка
Товарыдапакетная загрузкапакетная загрузкадеактивациякаталог и остатки
Категориипакетная загрузкапакетная загрузкадеактивациякаталог и остатки
Остатки / ценыпакетная загрузкапакетная загрузкакаталог и остатки
Прайс-файлстатус задачизагрузкапрайс-листы
Платежидадададаплатежи
Оплата / доставкаGET /modulesсправочники
Точки выдачиданетнетнетсправочники
Организацииданетнетнетпользователи и организации
Документыданеттолько внешний IDнетдокументы

Полный список методов

Заказы

МетодПутьПраво
GET/ordersorders.read
GET/orders/{id}orders.read
POST/ordersorders.write
PATCH/orders/{id}orders.write
DELETE/orders/{id}orders.delete
POST/orders/{id}/statusorders.write_status
POST/orders/{id}/metaorders.write_meta
POST/orders/{id}/archiveorders.archive
POST/orders/{id}/unarchiveorders.unarchive
GET/orders/{orderId}/items/{itemId}orders.read
POST/orders/{orderId}/itemsorder_items.write
PATCH/orders/{orderId}/items/{itemId}order_items.write
DELETE/orders/{orderId}/items/{itemId}order_items.delete
POST/orders/{orderId}/items/{itemId}/statusorders.write_status
POST/orders/{orderId}/items/{itemId}/archiveorder_items.archive
POST/orders/{orderId}/items/{itemId}/unarchiveorder_items.unarchive

Статусы

МетодПутьПраво
GET/statuses/ordersstatuses.read
GET/statuses/order-itemsstatuses.read

Пользователи, организации, платежи, документы

МетодПутьПраво
GET/users, /users/{id}users.read
POST/usersusers.write
PATCH/users/{id}users.write
DELETE/users/{id}users.delete
POST/users/{id}/metausers.write_meta
GET/organizationsorganizations.read
GET/payments, /payments/{id}payments.read
POST/paymentspayments.write
PATCH/payments/{id}payments.write
DELETE/payments/{id}payments.delete
GET/documentsdocuments.read
POST/documents/{id}/external-refdocuments.write_external_ref

Каталог, проценка, прайсы, справочники

МетодПутьПраво
GET/productsproducts.read
GET/products/{id}products.read
POST/products/batch-upsertproducts.write
POST/products/deleteproducts.delete
POST/categories/batch-upsertcategories.write
POST/categories/deletecategories.delete
POST/stocks/batch-updatestocks.write
POST/pricing/searchpricing.read
POST/price-lists/uploadprice_lists.write
POST/price-lists/statusprice_lists.write
GET/modulesmodules.read
GET/pickup-pointspickup_points.read
POST/integrations/{package}/syncintegrations.trigger_sync

Входящий webhook модуля

МетодПутьАвторизация
POST/integrations/inbound/{package}/{instance}Подпись модуля (X-Integration-Signature), не Bearer API

См. Платформа интеграций → Inbound.

Чего API намеренно не делает

  • Не создаёт и не правит точки выдачи и организации — только чтение.
  • Не создаёт и не правит содержимое документов (PDF/номер) — только список и внешний ID.
  • Не заменяет готовые модули интеграций — у них свои подключения в панели управления.

Пагинация списков

Большинство GET-списков — cursor-пагинация:

ПараметрОписание
per_page1–100, по умолчанию 50
cursorкурсор следующей страницы
sinceфильтр по updated_at (где поддерживается)

В ответе: data, per_page, next_cursor, next_page_url, …

Общие коды ошибок

HTTPКогда
401Нет/неверный Bearer
403Нет права или чужая точка
404Сущность не найдена
422Ошибка валидации (message + errors)

Дальше

База знаний для EMS-платформы PlatParts.