API PARTS SOFT V3 - для программ учета и внутренней автоматизации

Base URL: /api/v3, Version: 1.0

Используя наше API вы можете реализовать интеграцию с сторонним ПО Это могут быть - Конфигурации 1С - Облачные складские системы - CRM - и т.п. Авторизация осуществляется с использованием HTTP Base авторизации (https://en.wikipedia.org/wiki/Basic_access_authentication). Для авторизации используется логин и пароль от вашей учетной записи в админ панели. Внимание при использовании API права доступа к данным аналогичны правам учетной записи в панели администрирования. Поэтому вероятнее всего вам нужно будет использовать учетную запись с правами администратора для получения доступа ко всем нужным ресурсам.

Default request content-types: application/json
Default response content-types: application/json
Schemes: http

Summary

Tag: Контрагенты

Работа с контрагентами

Operation Description
GET /customers.json

Список контрагентов

GET /customers/1.json

Получение контрагента по ID

GET /customers/1/statistic_data.json

Получение статистику контрагента по ID

POST /customers

Создание контрагента

PUT /customers/743

Обновление контрагента по ID

DELETE /customers/743

Удаление контрагента по ID

Tag: Регионы

Позволяет получить информацию о созданных в системе регионах. Редактирование регионов возможно строго через веб-интерфейс.

Operation Description
GET /regions.json

Список регионов1

GET /regions/28.json

Получение региона по ID1

Tag: Типы оплат

Operation Description
GET /payment_types.json

Получение списка типов оплат12

POST /payment_types.json

Создание типа оплат

GET /payment_types/1.json

Получение типа оплат по ID7

PUT /payment_types/1.json

Редактирование типа оплат

DELETE /payment_types/1.json

Удаление типа оплаты5

Tag: Атрибуты продукции

Operation Description
GET /product_attributes.json

Получение списка всех атрибутов продукции

POST /product_attributes.json

Создание атрибута

PUT /product_attributes/1.json

Обновление атрибута

DELETE /product_attributes/1.json

Удаление атрибута по его ID

Tag: Категории продукции

Operation Description
GET /product_categories.json

Получение списка всех категорий

POST /product_categories.json

Создание категории

PUT /product_categories/1.json

Обновление категории

DELETE /product_categories/1.json

Удаление категории по её ID

Tag: Продукции

Operation Description
POST /products/load_recommendeds.json

Загрузка рекомендуемых товаров из файла

GET /products.json

Получение списка всех товаров

POST /products.json

Создание товара

PUT /products/1.json

Обновление продукции

DELETE /products/1.json

Удаление продукции по её ID

Tag: Формы

Operation Description
GET /web_forms.json

Получение списка всех форм

GET /web_forms/1.json

Получение формы по ID

GET /web_forms/1/form_fields

Получение списка всех полей определённой формы

GET /web_forms/1/form_records

Получение списка всех записей определённой формы

Tag: Заменяемые ссылки

Operation Description
GET /product_urls.json

Получение списка всех заменяемых ссылок

POST /product_urls/

Создание ссылки

PUT /product_urls/1

Обновление ссылки

DELETE /product_urls/1

Удаление ссылки по её ID

POST /product_urls_uploader

Создание ссылок

Tag: Фискальные кассы

Operation Description
GET /cash_boxes

Список касс

POST /cash_boxes

Создание кассы

GET /cash_boxes/1.json

Получение кассы по ID

PUT /cash_boxes/1.json

Редактирование кассы

DELETE /cash_boxes/1.json

Удаление кассы

Tag: Фискальные чеки

Operation Description
GET /cash_box_checks

Список чеков

POST /cash_box_checks

Создание чека

GET /cash_box_checks/1.json

Получение чека по ID

PUT /cash_box_checks/1.json

Редактирование чека

DELETE /cash_box_checks/1.json

Удаление чека

POST /cash_box_checks/1/fiscalization

Отправление чека на фискализацию

POST /cash_box_checks/1/update_status

Обновление статуса чека от внешней системы фискализации

GET /cash_box_checks/1/logs

Получение логов чека

Tag: Движение по балансу

Operation Description
GET /balances.json

Движение по балансу

POST /balances.json

Добавления нового движения баланса

GET /customers/1/balances

Просмотр баланса клиента

GET /customers/:customer_id/balances/:id.json

Получение записи движения баланса по ID

PUT /customers/:customer_id/balances/:id.json

редактирование записи движения баланса по ID

DELETE /customers/:customer_id/balances/:id.json

Удаление записи движения баланса по ID

GET /balances/income_type_report.json

Получение отчета по движениям баланса

Tag: Возвраты

Operation Description
GET /product_return_reason_requests.json

Получение списка возвратов

POST /order_items/:order_item_id/product_return_reason_requests.json

Новый возврат

GET /order_items/:order_item_id/product_return_reason_requests/:id.json

Получение возврата по ID

DELETE /order_items/:order_item_id/product_return_reason_requests/:id.json

Удаление возврата по ID

PUT /order_items/:order_item_id/product_return_reason_requests/:id.json

Редактирование возврата по ID

Tag: Группы скидок

Operation Description
GET /discount_types.json

Список групп скидок2

GET /discount_types/55.json

Получение группы скидок по ID2

Tag: Счета

Operation Description
GET /bills.json

Получение списка счетов

POST /bills.json

Новый счет

GET /bills/:id.json

Получение данных счета по ID

DELETE /bills/:id.json

Удаление счета по ID

PUT /bills/:id.json

Редактирование данных счета

GET /bills/:id/barcode.json

Получение QR Code счета по ID

POST /bills/:id/deposit.json

Авторизацию платежа счета по ID

GET /bills/:id/pay.json

Оплата платежа счета по ID

POST /bills/delete_bill_item.json

Удаление позиции счета по ID

Tag: Пользователи

Operation Description
GET /users.json

Список пользователей3

GET /users/1.json

Получение пользователя по ID3

Tag: Группы заказов

Работа с заказами

Operation Description
GET /orders.json

Список группы заказов4

POST /orders.json

Отправка корзины в заказ

GET /orders/1.json

Получение бланка заказа по ID4

PUT /orders/1.json

Редактирование заказа

DELETE /orders/1.json

Удаление группы заказов

POST /orders/make_join

Объединить выбранные заказы

GET /orders/1/vin_check.json

Отправить письмо клиенту о проверке по VIN номеру

POST /orders/manual.json

Tag: Корзины

Operation Description
GET /baskets.json

Получение списка корзин5

POST /baskets.json

Создание корзины

DELETE /baskets/1.json

Удаление корзины

GET /baskets/1.json

Просмотр корзины6

PUT /baskets/1.json

Редактирование корзины

POST /baskets/create_manual

Добавление позиций в корзину в ручную

POST /baskets/1/change_cost.json

Изменение цены корзины

Tag: Позиции заказа

Operation Description
GET /order_items.json

Получение списка позиций заказа7

PUT /order_items/1.json

Редактирование позиции заказа

POST /order_items/change_status

Изменение статуса позиции заказа

GET /order_items/1/prices.json

Получение прайсов для перезаказа позиции заказа8

POST /order_items/1/reorder.json

Перезаказ позиции заказа

POST /order_items/bill.json

Создание счета из произвольных позиций

Tag: Статусы заказов

Operation Description
GET /order_status_types.json

Получение списка статусов9

POST /order_status_types.json

Создание статуса заказов

GET /order_status_types/1.json

Получение статуса по ID5

PUT /order_status_types/1.json

Редактирование статуса заказа

DELETE /order_status_types/1.json

Удаление статуса заказа2

Tag: Типы доставок

Operation Description
GET /delivery_types.json

Получение списка типов доставки10

POST /delivery_types.json

Создание типа доставки

GET /delivery_types/1.json

Получение типа доставки по ID

PUT /delivery_types/1.json

Редактирование типа доставки

DELETE /delivery_types/1.json

Удаление типа доставки3

Tag: Пункты доставок

Operation Description
GET /delivery_points.json

Получение списка пунтков доставок11

POST /delivery_points.json

Создание пункта доставки

GET /delivery_points/1.json

Получение пункта доставки по ID6

PUT /delivery_points/1.json

Редактирование пункта доставки

DELETE /delivery_points/1.json

Удаление пункта доставки4

Security

auth

Type: basic
Description:

Для доступа к демо серверу используйте логин "admin" пароль "qwerty"

Paths

Движение по балансу

GET /balances.json

Tags: Движение по балансу

Получение списка зачислений/списаний с баланса клиентов. В ответе будут возвращены список движений баланса.

По умолчанию система будет отдавать по 10 в каждом запросе:

если просто отправить запрос без никаких параметров вы получаете первые 10 только для того, чтобы получить следующие 10 нужно добавить параметр page page = 2 если хотите получать не по 10, а по 20 (не больше 100) допустим, добавьте параметр per_page в каждом запросе per_page = 20

search[customer_id_eq]

Параметр фильтрации списка. ID клиента по которому нужно получить список движений по балансу

formData integer (int32)
page

Параметр пагинации списка - нумерация списка получаемых в запросе

formData integer (int32)
per_page

Параметр пагинации списка - кол-во данных в списке в каждом запросе

formData integer (int32)

application/json

200 OK
Добавления нового движения баланса

POST /balances.json

Tags: Движение по балансу

Добавление новой записи в движении балансов

customer_id

ID клиента на баланс которого вносится запись

formData string
balance[description]

Обоснование

formData string
balance[income_type]

Метод

formData string
balance[sum]

Сумма

formData string
balance[created_at(1i)]

Время движения. Год

formData integer (int32)
balance[created_at(2i)]

Время движения. Месяц

formData integer (int32)
balance[created_at(3i)]

Время движения. Число

formData integer (int32)
balance[created_at(4i)]

Время движения. Часы

formData integer (int32)
balance[created_at(5i)]

Время движения. Минуты

formData integer (int32)

application/json

200 OK
Получение отчета по движениям баланса

GET /balances/income_type_report.json

Tags: Движение по балансу

Получение отчета по движениям баланса разделенный по методам оплат

application/json

200 OK
Получение списка корзин5

GET /baskets.json

Tags: Корзины

В ответе будут возвращены список корзин пользователя с чьим логином и паролем происходит авторизация.

По умолчанию система будет отдавать по 10 в каждом запросе:

  • если просто отправить запрос без никаких параметров вы получаете первые 10 только
  • для того, чтобы получить следующие 10 нужно добавить параметр page
    • page = 2
  • если хотите получать не по 10, а по 20 (не больше 100) допустим, добавьте параметр per_page в каждом запросе
    • per_page = 20

application/json

200 OK
Создание корзины

POST /baskets.json

Tags: Корзины

TODO: Add Description

application/x-www-form-urlencoded

price_result[min_qnt]

минимальное кол. к заказу

formData integer (int32)
price_result[oem]

номенклатурный номер, артикул позиции

formData integer (int32)
price_result[make_name]

производитель

formData string
price_result[hash_key]

hash ключ защиты для добавления в корзину

formData string
price_result[sys_info]

служебная информация, json строка

formData string
price_result[price_id]

ID прайс листа

formData integer (int32)
price_result[min_delivery_day]

минимальный срок доставки

formData integer (int32)
price_result[max_delivery_day]

максимальный срок доставки

formData integer (int32)
price_result[detail_name]

название детали

formData string
qnt

количество к заказу

formData integer (int32)
discount_type_id

ID группы скидок

formData integer (int32)

application/json

200 OK
Удаление корзины

DELETE /baskets/1.json

Tags: Корзины

Замените 1 на ID корзины, которую нужно удалить

application/json

200 OK
Просмотр корзины6

GET /baskets/1.json

Tags: Корзины

Замените 1 на ID корзины, которую нужно посмотреть

application/json

200 OK
Редактирование корзины

PUT /baskets/1.json

Tags: Корзины

Замените 1 на ID корзины, которую нужно редактировать

Аттрибуты модели Basket которых нужно редактировать, нужно передавать через параметр basket

Например:

  • basket[qnt] = 3

В данный момент можно редактировать только аттрибут qnt количество

application/x-www-form-urlencoded

basket[qnt]

количество

formData integer (int32)

application/json

200 OK
Изменение цены корзины

POST /baskets/1/change_cost.json

Tags: Корзины

Обязательный параметр:

  • cost - новая цена

application/x-www-form-urlencoded

cost

новая цена

formData integer (int32)

application/json

200 OK
Добавление позиций в корзину в ручную

POST /baskets/create_manual

Tags: Корзины

Параметры каждой позиции корзины передаются через нумерацию в параметре items, для первой позиции это будет 0, для второй 1, для третьей позиции это будет 2 и так далее для всех последующих позиций. Например:

  • basket_manual[items][0][oem] - Артикул 1-й позиции
  • basket_manual[items][1][oem] - Артикул 2-й позиции
  • basket_manual[items][2][oem] - Артикул 3-й позиции

application/x-www-form-urlencoded

basket_manual[items][0][oem]

Артикул позиции

formData integer (int32)
basket_manual[items][0][make_name]

Производитель

formData string
basket_manual[items][0][detail_name]

Название детали

formData string
basket_manual[items][0][min_delivery_day]

Мин. срок доставки

formData integer (int32)
basket_manual[items][0][max_delivery_day]

Макс. срок доставки

formData integer (int32)
basket_manual[items][0][comment]

Комментарий позиции

formData string
basket_manual[items][0][first_cost]

Закупка

formData integer (int32)
basket_manual[items][0][cost]

Продажа

formData integer (int32)
basket_manual[items][0][qnt]

Количество

formData integer (int32)
basket_manual[items][0][price_id]

ID прайса

formData integer (int32)

application/json

200 OK
Получение списка счетов

GET /bills.json

Tags: Счета

Получение списка счетов

search[order_id_eq]

Пример параметра фильтрации списка. ID заказа по которому фильтруется список

formData integer (int32)
page

Параметр пагинации списка - нумерация списка получаемых в запросе

formData integer (int32)
per_page

Параметр пагинации списка - кол-во данных в списке в каждом запросе

formData integer (int32)

application/json

200 OK
Новый счет

POST /bills.json

Tags: Счета

Создание нового счета

bill[validate_bill_items]

Валидация счета (0 или 1)

formData integer (int32)
bill[customer_id]

ID клиента

formData integer (int32)
bill[order_id]

ID заказа

formData integer (int32)
bill[bill_items_attributes][0][oem]

Артикул 1-й позиции заказа

formData integer (int32)
bill[bill_items_attributes][0][make_name]

Производитель 1-й позиции заказа

formData integer (int32)
bill[bill_items_attributes][0][detail_name]

Название 1-й позиции заказа

formData integer (int32)
bill[bill_items_attributes][0][cost]

Цена 1-й позиции заказа

formData integer (int32)
bill[bill_items_attributes][0][qnt]

Количество 1-й позиции заказа

formData integer (int32)
bill[bill_items_attributes][0][is_excise]

Товары облагаются акцизом (0 или 1)

formData integer (int32)

application/json

200 OK
Удаление счета по ID

DELETE /bills/:id.json

Tags: Счета

Замените :id на ID счета

application/json

200 OK
Получение данных счета по ID

GET /bills/:id.json

Tags: Счета

Замените :id на ID счета

application/json

200 OK
Редактирование данных счета

PUT /bills/:id.json

Tags: Счета

Замените :id на ID счета

bill[validate_bill_items]

Валидация счета (0 или 1)

formData integer (int32)
bill[customer_id]

ID клиента

formData integer (int32)
bill[order_id]

ID заказа

formData integer (int32)
bill[bill_items_attributes][0][oem]

Артикул 1-й позиции заказа

formData integer (int32)
bill[bill_items_attributes][0][make_name]

Производитель 1-й позиции заказа

formData integer (int32)
bill[bill_items_attributes][0][detail_name]

Название 1-й позиции заказа

formData integer (int32)
bill[bill_items_attributes][0][cost]

Цена 1-й позиции заказа

formData integer (int32)
bill[bill_items_attributes][0][qnt]

Количество 1-й позиции заказа

formData integer (int32)
bill[bill_items_attributes][0][is_excise]

Товары облагаются акцизом (0 или 1)

formData integer (int32)

application/json

200 OK
Получение QR Code счета по ID

GET /bills/:id/barcode.json

Tags: Счета

Замените :id на ID счета

application/json

200 OK
Авторизацию платежа счета по ID

POST /bills/:id/deposit.json

Tags: Счета

Замените :id на ID счета

application/json

200 OK
Оплата платежа счета по ID

GET /bills/:id/pay.json

Tags: Счета

Замените :id на ID счета

application/json

200 OK
Удаление позиции счета по ID

POST /bills/delete_bill_item.json

Tags: Счета

Удаление позиции счета по ID

bill_item_id

ID позиции счета

formData integer (int32)

application/json

200 OK
Список чеков

GET /cash_box_checks

Tags: Фискальные чеки

Получение списка чеков

application/json

200 OK
Создание чека

POST /cash_box_checks

Tags: Фискальные чеки

Добавление нового чека для фискализации (На примере Комтет кассы)

application/x-www-form-urlencoded

cash_box_check[subject_item_type]

Тип объекта чека (Счета: Bill, Баланс: Balance, Возврат: ProductReturnReasonRequest, Заказ: Order)

formData string
cash_box_check[subject_item_id]

ID объекта чека

formData integer (int32)
cash_box_check[vat_rate]

Ставка налога

formData string
cash_box_check[customer_info]

Номер телефона ил эл. почта клиента

formData string
cash_box_check[customer_id]

ID клиента

formData integer (int32)
cash_box_check[cash_box_id]

ID кассы

formData integer (int32)
cash_box_check[print_paper_check]

Распечатать чек. Возвможные значения = 0 или 1, true или false

formData integer (int32)
cash_box_check[tax_system]

Система налогообложения

formData string
cash_box_check[print_settings][intent]

Направление платежа

formData string
cash_box_check[print_settings][calculation_method]

Способ рассчета

formData string
cash_box_check[payments][0][type]

Оплаты. Тип 1-й оплаты. Возможное значение для комтета - Электронными: card, Наличными: cash, Сумма предоплатой: prepayment, Сумма постоплатой: credit, Сумма встречным предложением: counter_provisioning

formData string
cash_box_check[payments][0][sum]

Оплаты. Сумма 1-й оплаты

formData number (double)
cash_box_check[cash_box_check_items_attributes][0][oem]

Артикул 1-й позиции чека

formData string
cash_box_check[cash_box_check_items_attributes][0][make_name]

Производитель 1-й позиции чека

formData string
cash_box_check[cash_box_check_items_attributes][0][detail_name]

Название 1-й позиции чека

formData string
cash_box_check[cash_box_check_items_attributes][0][cost]

Цена 1-й позиции чека

formData number (double)
cash_box_check[cash_box_check_items_attributes][0][qnt]

Кол-во 1-й позиции чека

formData integer (int32)
cash_box_check[cash_box_check_items_attributes][0][vat_rate]

Ставка налога 1-й позиции чека

formData string
cash_box_check[cash_box_check_items_attributes][0][calculation_subject]

Предмет расчета 1-й позиции чека

formData string

application/json

200 OK
Удаление чека

DELETE /cash_box_checks/1.json

Tags: Фискальные чеки

Замените 1 на ID чека, которого нужно удалить

application/json

200 OK
Получение чека по ID

GET /cash_box_checks/1.json

Tags: Фискальные чеки

Замените 1 на ID чека, которого нужно посмотреть

application/json

200 OK
Редактирование чека

PUT /cash_box_checks/1.json

Tags: Фискальные чеки

Замените 1 на ID чека, которого нужно редактировать

application/x-www-form-urlencoded

cash_box_check[subject_item_type]

Тип объекта чека (Счета: Bill, Баланс: Balance, Возврат: ProductReturnReasonRequest, Заказ: Order)

formData string
cash_box_check[subject_item_id]

ID объекта чека

formData integer (int32)
cash_box_check[vat_rate]

Ставка налога

formData string
cash_box_check[customer_info]

Номер телефона ил эл. почта клиента

formData string
cash_box_check[customer_id]

ID клиента

formData integer (int32)
cash_box_check[cash_box_id]

ID кассы

formData integer (int32)
cash_box_check[print_paper_check]

Распечатать чек. Возвможные значения = 0 или 1, true или false

formData integer (int32)
cash_box_check[tax_system]

Система налогообложения

formData string
cash_box_check[print_settings][intent]

Направление платежа

formData string
cash_box_check[print_settings][calculation_method]

Способ рассчета

formData string
cash_box_check[payments][0][type]

Оплаты. Тип 1-й оплаты. Возможное значение для комтета - Электронными: card, Наличными: cash, Сумма предоплатой: prepayment, Сумма постоплатой: credit, Сумма встречным предложением: counter_provisioning

formData string
cash_box_check[payments][0][sum]

Оплаты. Сумма 1-й оплаты

formData number (double)
cash_box_check[cash_box_check_items_attributes][0][oem]

Артикул 1-й позиции чека

formData string
cash_box_check[cash_box_check_items_attributes][0][make_name]

Производитель 1-й позиции чека

formData string
cash_box_check[cash_box_check_items_attributes][0][detail_name]

Название 1-й позиции чека

formData string
cash_box_check[cash_box_check_items_attributes][0][cost]

Цена 1-й позиции чека

formData number (double)
cash_box_check[cash_box_check_items_attributes][0][qnt]

Кол-во 1-й позиции чека

formData integer (int32)
cash_box_check[cash_box_check_items_attributes][0][vat_rate]

Ставка налога 1-й позиции чека

formData string
cash_box_check[cash_box_check_items_attributes][0][calculation_subject]

Предмет расчета 1-й позиции чека

formData string

application/json

200 OK
Отправление чека на фискализацию

POST /cash_box_checks/1/fiscalization

Tags: Фискальные чеки

Замените 1 на ID чека, которого отправить на фискализацию

application/json

200 OK
Получение логов чека

GET /cash_box_checks/1/logs

Tags: Фискальные чеки

Замените 1 на ID чека, логи которого нужно получить. Логи создаются при отправке запросов на внешнюю систему фискализации или при получении ответов

application/json

200 OK
Обновление статуса чека от внешней системы фискализации

POST /cash_box_checks/1/update_status

Tags: Фискальные чеки

Замените 1 на ID чека, статус которого нужно обновить

application/json

200 OK
Список касс

GET /cash_boxes

Tags: Фискальные кассы

Получение списка касс

application/json

200 OK
Создание кассы

POST /cash_boxes

Tags: Фискальные кассы

Добавление новой кассы для фискализации чеков (На примере Комтет кассы)

application/x-www-form-urlencoded

cash_box[name]

Служебное название

formData string
cash_box[type]

Типа кассы (нпр: CashBox::Komtet)

formData string
cash_box[login]

Логин для авторизации во внешнем сервиса

formData string
cash_box[password]

Пароль для авторизации во внешнем сервиса

formData string
cash_box[print_if_online_payment]

Печатать чек при онлайн оплате, возможное значение - 0 или 1

formData integer (int32)
cash_box[tax_system]

Система налогообложения при онлайн оплатах( Для Комтеты кассы: ОСН: 0, УСН доход: 1, УСН доход - расход: 2, ЕНВД: 3, ЕСН: 4, Патент: 5 )

formData string
cash_box[vat_rate]

Ставка налога ( Для Комтеты кассы: no, 0, 10, 18, 20, 110, 118, 120 )

formData string
cash_box[queue_id]

ID очереди (Актуален только для Комтет кассы)

formData string
cash_box[active]

Активен при онлайн оплатах, возможное значение - 0 или 1

formData integer (int32)
cash_box[region_id]

Регион

formData integer (int32)

application/json

200 OK
Удаление кассы

DELETE /cash_boxes/1.json

Tags: Фискальные кассы

Замените 1 на ID кассы, которого нужно удалить

application/json

200 OK
Получение кассы по ID

GET /cash_boxes/1.json

Tags: Фискальные кассы

Замените 1 на ID кассы, которого нужно посмотреть

application/json

200 OK
Редактирование кассы

PUT /cash_boxes/1.json

Tags: Фискальные кассы

Замените 1 на ID кассы, которого нужно редактировать

application/x-www-form-urlencoded

cash_box[name]

Служебное название

formData string
cash_box[type]

Типа кассы (нпр: CashBox::Komtet)

formData string
cash_box[login]

Логин для авторизации во внешнем сервиса

formData string
cash_box[password]

Пароль для авторизации во внешнем сервиса

formData string
cash_box[print_if_online_payment]

Печатать чек при онлайн оплате, возможное значение - 0 или 1

formData integer (int32)
cash_box[tax_system]

Система налогообложения при онлайн оплатах( Для Комтеты кассы: ОСН: 0, УСН доход: 1, УСН доход - расход: 2, ЕНВД: 3, ЕСН: 4, Патент: 5 )

formData string
cash_box[vat_rate]

Ставка налога ( Для Комтеты кассы: no, 0, 10, 18, 20, 110, 118, 120 )

formData string
cash_box[queue_id]

ID очереди (Актуален только для Комтет кассы)

formData string
cash_box[active]

Активен при онлайн оплатах, возможное значение - 0 или 1

formData integer (int32)
cash_box[region_id]

Регион

formData integer (int32)

application/json

200 OK
Создание контрагента

POST /customers

Tags: Контрагенты

Запрос создает контрагента. Поля валидируются в зависимости от настроек валидации в разделе Служебные

application/x-www-form-urlencoded

customer[region_id]

ID региона в котором работает пользователь

formData integer (int32)
customer[ur_type]

Тип клиента 0 юр. лицо 1 физ. лицо

formData integer (int32)
customer[discount_type_id]

ID типа скидки

formData integer (int32)
customer[email]

Email адрес клиента (основной)

formData string
customer[pay_delay]

Отсрочка платежа

formData integer (int32)
customer[credit_limit]

Кредитный лимит клиента

formData integer (int32)
customer[name]

Имя клиента

formData string
customer[second_name]

Отчество клиента

formData string
customer[family_name]

Фамилия клиента

formData string
customer[nds]

Ставка НДС клиента

formData integer (int32)
customer[essential_attributes][company_name]

Название компании

formData string
customer[essential_attributes][company_type]

Правовая форма компании

formData string
customer[essential_attributes][inn]

ИНН

formData integer (int64)
customer[essential_attributes][kpp]

КПП

formData integer (int64)
customer[essential_attributes][bik]

БИК

formData integer (int32)
customer[essential_attributes][bank]

Банк

formData string
customer[essential_attributes][city]

Город банка

formData string
customer[essential_attributes][loro_account]

Счет

formData number (double)
customer[essential_attributes][korr_schet]

Корр. счет

formData integer (int64)
customer[contact_attributes][phone]

Контактный телефон

formData string
customer[contact_attributes][cell_phone]

Допольнительный телефон

formData string
customer[delivery_address_attributes][zip_code]

Индекс

formData integer (int32)
customer[delivery_address_attributes][country]

Страна клиента

formData string
customer[delivery_address_attributes][region]

Регион клиента

formData string
customer[delivery_address_attributes][city]

Город клиента

formData string
customer[delivery_address_attributes][street]

Улица клиента

formData string
customer[delivery_address_attributes][house]

Дом клиента

formData integer (int32)
customer[delivery_address_attributes][korpus]

Корпус дома клиента

formData string
customer[delivery_address_attributes][flat]

Офис/Квартира клиента

formData string
customer[official_address_attributes][zip_code]

Индекс

formData integer (int32)
customer[official_address_attributes][country]

Страна клиента

formData string
customer[official_address_attributes][region]

Регион клиента

formData string
customer[official_address_attributes][city]

Город клиента

formData string
customer[official_address_attributes][street]

Улица клиента

formData string
customer[official_address_attributes][house]

Дом клиента

formData integer (int32)
customer[official_address_attributes][korpus]

Корпус дома клиента

formData string
customer[send_sms]

Отправлять SMS

formData boolean
customer[send_email]

Отправлять Email

formData boolean
customer[user_id]

ID клиентского менеджера

formData integer (int32)

application/json; charset=utf-8

200 OK
Example for application/json; charset=utf-8
[object Object]
X-Frame-Options string SAMEORIGIN
X-XSS-Protection string 1; mode=block
X-Content-Type-Options string nosniff
ETag string W/"4edf47b9d78e19eda3dab665f34b80e0"
Cache-Control string max-age=0, private, must-revalidate
X-Request-Id string 85d9ad80-0fd2-42b8-bf4f-b0ec0b29d0ca
X-Runtime string 0.304926
Transfer-Encoding string chunked
Список контрагентов

GET /customers.json

Tags: Контрагенты

Запрашивая список контрагентов вы можете фильтровать его по любому полю из модели customer. Для фильтрации вы можете передать параметр вида

  1. Равно search[attribute_eq]=value
  2. Больше search[attribute_gt]=value
  3. Меньше search[attribute_lt]=value

Где attribute требуемое вам поле, а value значение. Например фильтр по значению почты

application/json; charset=utf-8

200 OK
Example for application/json; charset=utf-8
[object Object]
X-Frame-Options string SAMEORIGIN
X-XSS-Protection string 1; mode=block
X-Content-Type-Options string nosniff
ETag string W/"b9a0b71b80122eb50b189a992a9dcd8a"
Cache-Control string max-age=0, private, must-revalidate
X-Request-Id string f6550bc7-9631-40d9-a222-aa84e0953a56
X-Runtime string 0.135789
Transfer-Encoding string chunked
Получение контрагента по ID

GET /customers/1.json

Tags: Контрагенты

Получаем контрагента по его ID. Вместо 1 указываем ID нужного вам контрагента

application/json; charset=utf-8

200 OK
Example for application/json; charset=utf-8
[object Object]
X-Frame-Options string SAMEORIGIN
X-XSS-Protection string 1; mode=block
X-Content-Type-Options string nosniff
ETag string W/"53f95575369d97b72ce1606ed06e2b66"
Cache-Control string max-age=0, private, must-revalidate
X-Request-Id string 688870c8-a991-4e59-8d21-9ba0cf6cf550
X-Runtime string 0.138883
Transfer-Encoding string chunked
Просмотр баланса клиента

GET /customers/1/balances

Tags: Движение по балансу

Замените 1 на ID клиента чьи записи движения баланса нужно получить

application/json

200 OK
Получение статистику контрагента по ID

GET /customers/1/statistic_data.json

Tags: Контрагенты

Получаем статистику по клиенту. Вместо 1 вставляем его ID

application/json; charset=utf-8

200 OK
Удаление контрагента по ID

DELETE /customers/743

Tags: Контрагенты

Удаление контрагента по его ID

application/json

200 OK
Обновление контрагента по ID

PUT /customers/743

Tags: Контрагенты

TODO: Add Description

application/x-www-form-urlencoded

customer[region_id]

ID региона в котором работает пользователь

formData integer (int32)
customer[ur_type]

Тип клиента 0 юр. лицо 1 физ. лицо

formData integer (int32)
customer[discount_type_id]

ID типа скидки

formData integer (int32)
customer[email]

Email адрес клиента (основной)

formData string
customer[pay_delay]

Отсрочка платежа

formData integer (int32)
customer[credit_limit]

Кредитный лимит клиента

formData integer (int32)
customer[name]

Имя клиента

formData string
customer[second_name]

Отчество клиента

formData string
customer[family_name]

Фамилия клиента

formData string
customer[nds]

Ставка НДС клиента

formData integer (int32)
customer[essential_attributes][company_name]

Название компании

formData string
customer[essential_attributes][company_type]

Правовая форма компании

formData string
customer[essential_attributes][inn]

ИНН

formData integer (int64)
customer[essential_attributes][kpp]

КПП

formData integer (int64)
customer[essential_attributes][bik]

БИК

formData integer (int32)
customer[essential_attributes][bank]

Банк

formData string
customer[essential_attributes][city]

Город банка

formData string
customer[essential_attributes][loro_account]

Счет

formData number (double)
customer[essential_attributes][korr_schet]

Корр. счет

formData integer (int64)
customer[contact_attributes][phone]

Контактный телефон

formData string
customer[contact_attributes][cell_phone]

Допольнительный телефон

formData string
customer[delivery_address_attributes][zip_code]

Индекс

formData integer (int32)
customer[delivery_address_attributes][country]

Страна клиента

formData string
customer[delivery_address_attributes][region]

Регион клиента

formData string
customer[delivery_address_attributes][city]

Город клиента

formData string
customer[delivery_address_attributes][street]

Улица клиента

formData string
customer[delivery_address_attributes][house]

Дом клиента

formData integer (int32)
customer[delivery_address_attributes][korpus]

Корпус дома клиента

formData string
customer[delivery_address_attributes][flat]

Офис/Квартира клиента

formData string
customer[official_address_attributes][zip_code]

Индекс

formData integer (int32)
customer[official_address_attributes][country]

Страна клиента

formData string
customer[official_address_attributes][region]

Регион клиента

formData string
customer[official_address_attributes][city]

Город клиента

formData string
customer[official_address_attributes][street]

Улица клиента

formData string
customer[official_address_attributes][house]

Дом клиента

formData integer (int32)
customer[official_address_attributes][korpus]

Корпус дома клиента

formData string
customer[send_sms]

Отправлять SMS

formData boolean
customer[send_email]

Отправлять Email

formData boolean
customer[user_id]

ID клиентского менеджера

formData integer (int32)

application/json

200 OK
Удаление записи движения баланса по ID

DELETE /customers/:customer_id/balances/:id.json

Tags: Движение по балансу

Замените :customer_id на ID клиента и :id на ID записи движения баланса, которого нужно удалит

application/json

200 OK
Получение записи движения баланса по ID

GET /customers/:customer_id/balances/:id.json

Tags: Движение по балансу

Замените :customer_id на ID клиента и :id на ID записи движения баланса, которого нужно получить

application/json

200 OK
редактирование записи движения баланса по ID

PUT /customers/:customer_id/balances/:id.json

Tags: Движение по балансу

Замените :customer_id на ID клиента и :id на ID записи движения баланса, которого нужно редактировать

customer_id

ID клиента на баланс которого вносится запись

formData string
balance[description]

Обоснование

formData string
balance[income_type]

Метод

formData string
balance[sum]

Сумма

formData string
balance[created_at(1i)]

Время движения. Год

formData integer (int32)
balance[created_at(2i)]

Время движения. Месяц

formData integer (int32)
balance[created_at(3i)]

Время движения. Число

formData integer (int32)
balance[created_at(4i)]

Время движения. Часы

formData integer (int32)
balance[created_at(5i)]

Время движения. Минуты

formData integer (int32)

application/json

200 OK
Получение списка пунтков доставок11

GET /delivery_points.json

Tags: Пункты доставок

TODO: Add Description

application/json

200 OK
Создание пункта доставки

POST /delivery_points.json

Tags: Пункты доставок

TODO: Add Description

application/x-www-form-urlencoded

delivery_point[name]

Название

formData string
delivery_point[active]

Активный, возможное значение - 0 или 1

formData integer (int32)
delivery_point[address]

Адрес

formData string
delivery_point[description]

Описание

formData string
delivery_point[work_mode]

Режим работы

formData string
delivery_point[oem_postfix]

Постфикс артикула доставки

formData string
delivery_point[delivery_bill_name]

Название в заказе

formData string
delivery_point[cost]

Стоимость доставки

formData string
delivery_point[add_to_bill]

Добавлять в счет, возможное значение - 0 или 1

formData integer (int32)
delivery_point[lat]

Широта

formData string
delivery_point[lng]

Долгота

formData string
delivery_point[payment_type]

Типы оплат

formData string
delivery_point[work_mode_sat_sun]

Режим работы в выходные

formData string
delivery_point[description_url]

Ссылка на информацию

formData string

application/json

200 OK
Удаление пункта доставки4

DELETE /delivery_points/1.json

Tags: Пункты доставок

Замените 1 на ID пункта доставки, которого нужно удалить

application/json

200 OK
Получение пункта доставки по ID6

GET /delivery_points/1.json

Tags: Пункты доставок

Замените 1 на ID пункта доставки, которого нужно посмотреть

application/json

200 OK
Редактирование пункта доставки

PUT /delivery_points/1.json

Tags: Пункты доставок

Замените 1 на ID пункта доставки, которого нужно редактировать

application/x-www-form-urlencoded

delivery_point[name]

Название

formData string
delivery_point[active]

Активный, возможное значение - 0 или 1

formData integer (int32)
delivery_point[address]

Адрес

formData string
delivery_point[description]

Описание

formData string
delivery_point[work_mode]

Режим работы

formData string
delivery_point[oem_postfix]

Постфикс артикула доставки

formData string
delivery_point[delivery_bill_name]

Название в заказе

formData string
delivery_point[cost]

Стоимость доставки

formData string
delivery_point[add_to_bill]

Добавлять в счет, возможное значение - 0 или 1

formData integer (int32)
delivery_point[lat]

Широта

formData string
delivery_point[lng]

Долгота

formData string
delivery_point[payment_type]

Типы оплат

formData string
delivery_point[work_mode_sat_sun]

Режим работы в выходные

formData string
delivery_point[description_url]

Ссылка на информацию

formData string

application/json

200 OK
Получение списка типов доставки10

GET /delivery_types.json

Tags: Типы доставок

TODO: Add Description

application/json

200 OK
Создание типа доставки

POST /delivery_types.json

Tags: Типы доставок

TODO: Add Description

application/x-www-form-urlencoded

delivery_type[name]

Название

formData string
delivery_type[show_index]

Запросить Индекс, возможные значения - 0 или 1

formData string
delivery_type[show_address]

Запросить Адрес, возможные значения - 0 или 1

formData string
delivery_type[show_name]

Запросить Имя и фамилия, возможные значения - 0 или 1

formData string
delivery_type[active]

Активен, возможные значения - 0 или 1

formData string
delivery_type[description]

Описание

formData string
delivery_type[select_warehouse]

Выбрать склад, возможные значения - 0 или 1

formData string
delivery_type[default]

По умолчанию, возможные значения - 0 или 1

formData string
delivery_type[customers_ur_type]

Для типов пользователей (Юр. Лица - 0, Физ. Лица - 1)

formData string
delivery_type[show_pasport]

Запросить Паспортные данные, возможные значения - 0 или 1

formData string
delivery_type[ask_delivery_point]

Запросить пункт самовывоза, возможные значения - 0 или 1

formData string
delivery_type[oem_postfix]

Постфикс артикула доставки

formData string
delivery_type[delivery_bill_name]

Название в заказе

formData string
delivery_type[cost]

Стоимость доставки

formData string
delivery_type[add_to_bill]

Добавлять в счет, возможные значения - 0 или 1

formData string
delivery_type[delivery_service_type]

Запросить атрибуты службы доставки, передается ID службы доставки

formData string
delivery_type[delivery_point_ids][]

ID Пункта самовывоза. Этот параметр может повторятся, если пунктов несколько

formData string
delivery_type[payment_type_ids][]

ID способов оплаты

formData string
delivery_type[enable_for_customers]

Включить для клиентов, строка с ID клиентов через запятую, например: "712,711"

formData string
delivery_type[disable_for_customers]

Исключить для клиентов, строка с ID клиентов через запятую, например: "712,711"

formData string
delivery_type[enable_for_discount_types][]

Включить для клиентов, строка с ID клиентов через запятую, например: "712,711"

formData string
delivery_type[disable_for_discount_types][]

Исключить для группы скидок, ID группы скидок. Этот параметр может быть несколько

formData string

application/json

200 OK
Удаление типа доставки3

DELETE /delivery_types/1.json

Tags: Типы доставок

Замените 1 на ID типа доставки, которого нужно удалить

application/json

200 OK
Получение типа доставки по ID

GET /delivery_types/1.json

Tags: Типы доставок

Замените 1 на ID типа доставки, данные которого хотите получить

delivery_type_id path string

application/json

200 OK
Редактирование типа доставки

PUT /delivery_types/1.json

Tags: Типы доставок

Замените 1 на ID типа доставки, которого нужно редактировать

application/x-www-form-urlencoded

delivery_type[name]

Название

formData string
delivery_type[show_index]

Запросить Индекс, возможные значения - 0 или 1

formData string
delivery_type[show_address]

Запросить Адрес, возможные значения - 0 или 1

formData string
delivery_type[show_name]

Запросить Имя и фамилия, возможные значения - 0 или 1

formData string
delivery_type[active]

Активен, возможные значения - 0 или 1

formData string
delivery_type[description]

Описание

formData string
delivery_type[select_warehouse]

Выбрать склад, возможные значения - 0 или 1

formData string
delivery_type[default]

По умолчанию, возможные значения - 0 или 1

formData string
delivery_type[customers_ur_type]

Для типов пользователей (Юр. Лица - 0, Физ. Лица - 1)

formData string
delivery_type[show_pasport]

Запросить Паспортные данные, возможные значения - 0 или 1

formData string
delivery_type[ask_delivery_point]

Запросить пункт самовывоза, возможные значения - 0 или 1

formData string
delivery_type[oem_postfix]

Постфикс артикула доставки

formData string
delivery_type[delivery_bill_name]

Название в заказе

formData string
delivery_type[cost]

Стоимость доставки

formData string
delivery_type[add_to_bill]

Добавлять в счет, возможные значения - 0 или 1

formData string
delivery_type[delivery_service_type]

Запросить атрибуты службы доставки, передается ID службы доставки

formData string
delivery_type[delivery_point_ids][]

ID Пункта самовывоза. Этот параметр может повторятся, если пунктов несколько

formData string
delivery_type[enable_for_customers]

Включить для клиентов, строка с ID клиентов через запятую, например: "712,711"

formData string
delivery_type[disable_for_customers]

Исключить для клиентов, строка с ID клиентов через запятую, например: "712,711"

formData string
delivery_type[enable_for_discount_types][]

Включить для клиентов, строка с ID клиентов через запятую, например: "712,711"

formData string
delivery_type[disable_for_discount_types][]

Исключить для группы скидок, ID группы скидок. Этот параметр может быть несколько

formData string

application/json

200 OK
Список групп скидок2

GET /discount_types.json

Tags: Группы скидок

Доступные поля могут отличаться в зависимости от доступа пользователя

application/json; charset=utf-8

200 OK
Example for application/json; charset=utf-8
[object Object]
X-Frame-Options string SAMEORIGIN
X-XSS-Protection string 1; mode=block
X-Content-Type-Options string nosniff
ETag string W/"710aadefc49b3a0cce46262f2abc35d5"
Cache-Control string max-age=0, private, must-revalidate
X-Request-Id string bf0bfbc2-c8a4-409b-8113-e9898a54e66d
X-Runtime string 0.121473
Transfer-Encoding string chunked
Получение группы скидок по ID2

GET /discount_types/55.json

Tags: Группы скидок

TODO: Add Description

application/json; charset=utf-8

200 OK
Example for application/json; charset=utf-8
[object Object]
X-Frame-Options string SAMEORIGIN
X-XSS-Protection string 1; mode=block
X-Content-Type-Options string nosniff
ETag string W/"b0b812dbea95e915c997208a79a7ce69"
Cache-Control string max-age=0, private, must-revalidate
X-Request-Id string 34f08ad8-9c8c-4c57-893f-885aa07db9a2
X-Runtime string 0.909157
Transfer-Encoding string chunked
Получение списка позиций заказа7

GET /order_items.json

Tags: Позиции заказа

В ответе будут возвращены список позиций заказа.

По умолчанию система будет отдавать по 10 в каждом запросе:

  • если просто отправить запрос без никаких параметров вы получаете первые 10 только
  • для того, чтобы получить следующие 10 нужно добавить параметр page
    • page = 2
  • если хотите получать не по 10, а по 20 (не больше 100) допустим, добавьте параметр per_page в каждом запросе
    • per_page = 20

application/json

200 OK
Редактирование позиции заказа

PUT /order_items/1.json

Tags: Позиции заказа

Замените 1 в запросе на ID позиции заказа, которую нужно редактировать

application/x-www-form-urlencoded

order_item[detail_name]

название детали

formData string
order_item[cost]

цена продажи

formData string
order_item[qnt_income]

пришло

formData string
order_item[min_delivery_day]

минимальный срок доставки

formData string
order_item[max_delivery_day]

максимальный срок доставки

formData string
order_item[comment]

коментарий

formData string
order_item[company_comment]

комментарий компании

formData string
order_item[gtd]

код ГТД

formData string
order_item[country]

страна

formData string
order_item[expected_delivery_date]

ожидаемая дата доставки

formData string
order_item[qnt]

количество

formData string

application/json

200 OK
Получение прайсов для перезаказа позиции заказа8

GET /order_items/1/prices.json

Tags: Позиции заказа

Замените 1 в запросе на ID позиции заказа, которую нужно перезаказать.

  • В ответе будет параметр price_items с прайсами проценки

application/json

200 OK
Перезаказ позиции заказа

POST /order_items/1/reorder.json

Tags: Позиции заказа

Замените значение перменной orderItemId на ID позиции заказа, которую нужно перезаказать

Параметры (из полученных прайсов от запроса "Получение прайсов для перезаказа позиции заказа")

параметр описание значения
min_delivery_day мин. кол-во дней доставки прайса
max_delivery_day макс. кол-во дней доставки прайса
first_cost закупочная цена прайса
raw_cost изначальная цена, обычно такое же как first_cost
price_id ID прайса
sys_info служебная информация прайса

application/x-www-form-urlencoded

min_delivery_day

мин. кол-во дней доставки прайса

formData integer (int32)
max_delivery_day

макс. кол-во дней доставки прайса

formData integer (int32)
first_cost

закупочная цена прайса

formData number (double)
raw_cost

изначальная цена, обычно такое же как first_cost

formData number (double)
price_id

ID прайса

formData integer (int32)
sys_info

служебная информация прайса

formData string

application/json

200 OK
Новый возврат

POST /order_items/:order_item_id/product_return_reason_requests.json

Tags: Возвраты

Создание нового возврата. Замените :order_item_id на ID позиции заказа

product_return_reason_request[order_item_id]

ID позиции заказа

formData integer (int32)
product_return_reason_request[user_d]

ID менеджера

formData integer (int32)
product_return_reason_request[qnt]

Кол-во позиций заказа

formData integer (int32)
product_return_reason_request[product_return_reason_id]

ID условия возврата

formData integer (int32)
product_return_reason_request[photo1]

Файл изображения №1

formData string
product_return_reason_request[photo2]

Файл изображения №2

formData string
product_return_reason_request[photo3]

Файл изображения №3

formData string
product_return_reason_request[photo4]

Файл изображения №4

formData string
product_return_reason_request[document]

Файл документа

formData string
product_return_reason_request[comment]

Комментарий

formData string

application/json

200 OK
Удаление возврата по ID

DELETE /order_items/:order_item_id/product_return_reason_requests/:id.json

Tags: Возвраты

Замените :order_item_id на ID позиции заказа, :id на ID возврата

application/json

200 OK
Получение возврата по ID

GET /order_items/:order_item_id/product_return_reason_requests/:id.json

Tags: Возвраты

Замените :order_item_id на ID позиции заказа, :id на ID возврата

application/json

200 OK
Редактирование возврата по ID

PUT /order_items/:order_item_id/product_return_reason_requests/:id.json

Tags: Возвраты

Замените :order_item_id на ID позиции заказа, :id на ID возврата

product_return_reason_request[order_item_id]

ID позиции заказа

formData integer (int32)
product_return_reason_request[user_d]

ID менеджера

formData integer (int32)
product_return_reason_request[qnt]

Кол-во позиций заказа

formData integer (int32)
product_return_reason_request[product_return_reason_id]

ID условия возврата

formData integer (int32)
product_return_reason_request[photo1]

Файл изображения №1

formData string
product_return_reason_request[photo2]

Файл изображения №2

formData string
product_return_reason_request[photo3]

Файл изображения №3

formData string
product_return_reason_request[photo4]

Файл изображения №4

formData string
product_return_reason_request[document]

Файл документа

formData string
product_return_reason_request[comment]

Комментарий

formData string

application/json

200 OK
Создание счета из произвольных позиций

POST /order_items/bill.json

Tags: Позиции заказа

Есть только 1 обязательный параметр - order_item_ids

Значение order_item_ids это строка с ID позиций заказов разделенные пробелом, на которые создается счет.

  • например: order_item_ids = "11808 11807"

application/x-www-form-urlencoded

order_item_ids

строка с ID позиций заказов разделенные пробелом, на которые создается счет. Например: "11808 11807"

formData string

application/json

200 OK
Изменение статуса позиции заказа

POST /order_items/change_status

Tags: Позиции заказа

Нужно передать 2 обязательных параметра:

  1. order_item_ids
  2. status_id

Значение order_item_ids это строка с ID позиций заказов разделенные пробелом, например - "11808 11807". Значение status_id это ID статуса на которую нужно изменить.

например:

  • order_item_ids = "11808 11807"
  • status_id = 59

application/x-www-form-urlencoded

order_item_ids

строка с ID позиций заказов разделенные пробелом, например - "11808 11807"

formData string
status_id

ID статуса на которую нужно изменить

formData integer (int32)

application/json

200 OK
Получение списка статусов9

GET /order_status_types.json

Tags: Статусы заказов

TODO: Add Description

application/json

200 OK
Создание статуса заказов

POST /order_status_types.json

Tags: Статусы заказов

Создание нового статуса заказов

application/x-www-form-urlencoded

order_status_type[name]

Название

formData string
order_status_type[code]

Группа статусов, принимается только эти значения: processing, commit, v-zakaze, supplier-commit, transit, supplier-accept, prishlo, vydano, otkaz, snyat, vozvrat

formData string
order_status_type[description]

Описание

formData string
order_status_type[color]

Цвет, например: d4ffaa

formData string
order_status_type[confirmation_body]

Текст уведомления

formData string
order_status_type[send_confirm]

Отправлять уведомления, возможные значения: 1 или 0

formData string
order_status_type[font_color]

Цвет шрифта, например: 000000

formData string
order_status_type[sms]

Текст SMS уведомления, например можно так: "Вы заказывали #detail_name #oem #make_name, статус заказа изменился на #status_name, кол. заказано #qnt, актуальное кол. #current_qnt"

formData string
order_status_type[send_sms]

Отправлять СМС, возможные значения: 1 или 0

formData integer (int32)
order_status_type[notify_overdue_reaction]

Отправлять уведомления о просрочке, возможные значения: 1 или 0

formData string
order_status_type[notify_overdue_reaction_day]

Период просрочки в днях

formData string
order_status_type[overdue_sms_template]

SMS уведомление о просроченном статусе, например можно так: "Вы заказывали #detail_name #oem #make_name, статус заказа изменился на #status_name, кол. заказано #qnt, актуальное кол. #current_qnt"

formData string
order_status_type[send_overdue_sms]

Отправлять СМС о просрочке, возможные значения: 1 или 0

formData string
order_status_type[admin_notify_overdue_reaction]

Уведомлять менеджера о просрочке, возможные значения: 1 или 0

formData string
order_status_type[destroy_overdue_reaction]

Снимать заказы

formData string
order_status_type[destroy_overdue_reaction_day]

Период снятия заказа. Заказ зависший в статусе более n дней автоматически переводится в статус Снято

formData string
order_status_type[wait_group_overdue]

Ждать сбора заказа

formData string
order_status_type[destroy_status_comment]

Комментарий при снятии

formData string
order_status_type[is_priority]

Приоритетный статус, возможные значения: 1 или 0

formData string
order_status_type[send_to_outdated]

При назначении статуса отмечать номер как устаревший

formData string
order_status_type[is_set_on_accept_product_return] formData boolean
order_status_type[disable_check_status]

Запретить отслеживать статусы, возможные значения: 1 или 0

formData string
order_status_type[sms_discount_groups][]

Отправлять SMS только для клиентов из групп скидок, возможное значение - ID группы скидок. Этого параметра может быть несколько

formData integer (int32)

application/json; charset=utf-8

200 OK
Example for application/json; charset=utf-8
[object Object]
X-Frame-Options string SAMEORIGIN
X-XSS-Protection string 1; mode=block
X-Content-Type-Options string nosniff
ETag string W/"9dee9e4dfba0302c737087bd274bd8a9"
Cache-Control string max-age=0, private, must-revalidate
X-Request-Id string 010ceb6d-4155-4553-a5df-3805e04e0673
X-Runtime string 0.089556
Transfer-Encoding string chunked
Удаление статуса заказа2

DELETE /order_status_types/1.json

Tags: Статусы заказов

Замените 1 на ID статуса заказа, которого нужно удалить

application/json

200 OK
Получение статуса по ID5

GET /order_status_types/1.json

Tags: Статусы заказов

Замените 1 на ID статуса заказа, которого нужно получить

application/json

200 OK
Редактирование статуса заказа

PUT /order_status_types/1.json

Tags: Статусы заказов

Замените 1 на ID статуса заказа, которого нужно редактировать

application/x-www-form-urlencoded

order_status_type[name]

Название

formData string
order_status_type[code]

Группа статусов, принимается только эти значения: processing, commit, v-zakaze, supplier-commit, transit, supplier-accept, prishlo, vydano, otkaz, snyat, vozvrat

formData string
order_status_type[description]

Описание

formData string
order_status_type[color]

Цвет, например: d4ffaa

formData string
order_status_type[confirmation_body]

Текст уведомления

formData string
order_status_type[send_confirm]

Отправлять уведомления, возможные значения: 1 или 0

formData string
order_status_type[font_color]

Цвет шрифта, например: 000000

formData string
order_status_type[sms]

Текст SMS уведомления, например можно так: "Вы заказывали #detail_name #oem #make_name, статус заказа изменился на #status_name, кол. заказано #qnt, актуальное кол. #current_qnt"

formData string
order_status_type[send_sms]

Отправлять СМС, возможные значения: 1 или 0

formData string
order_status_type[notify_overdue_reaction]

Отправлять уведомления о просрочке, возможные значения: 1 или 0

formData string
order_status_type[notify_overdue_reaction_day]

Период просрочки в днях

formData string
order_status_type[overdue_sms_template]

SMS уведомление о просроченном статусе, например можно так: "Вы заказывали #detail_name #oem #make_name, статус заказа изменился на #status_name, кол. заказано #qnt, актуальное кол. #current_qnt"

formData string
order_status_type[send_overdue_sms]

Отправлять СМС о просрочке, возможные значения: 1 или 0

formData string
order_status_type[admin_notify_overdue_reaction]

Уведомлять менеджера о просрочке, возможные значения: 1 или 0

formData string
order_status_type[destroy_overdue_reaction]

Снимать заказы

formData string
order_status_type[destroy_overdue_reaction_day]

Период снятия заказа. Заказ зависший в статусе более n дней автоматически переводится в статус Снято

formData string
order_status_type[wait_group_overdue]

Ждать сбора заказа

formData string
order_status_type[destroy_status_comment]

Комментарий при снятии

formData string
order_status_type[is_priority]

Приоритетный статус, возможные значения: 1 или 0

formData string
order_status_type[send_to_outdated]

При назначении статуса отмечать номер как устаревший

formData string
order_status_type[is_set_on_accept_product_return] formData boolean
order_status_type[disable_check_status]

Запретить отслеживать статусы, возможные значения: 1 или 0

formData string

application/json

200 OK
Список группы заказов4

GET /orders.json

Tags: Группы заказов

Запрашивая список группы заказов вы можете фильтровать его по любому полю из модели Order. Для фильтрации вы можете передать параметр вида

  1. Равно search[attribute_eq]=value
  2. Больше search[attribute_gt]=value
  3. Меньше search[attribute_lt]=value

Где attribute требуемое вам поле, а value значение. Например:

  • search[id_eq]=10880
  • search[id_1c]="site-10880-Filippov Petr Danilovich (712)"
  • search[customer_email_eq]=info@parts-soft.ru

По умолчанию система будет отдавать по 10 в каждом запросе:

  • если просто отправить запрос без никаких параметров, вы получаете первые 10 только
  • для того, чтобы получить следующие 10 нужно добавить параметр page
    • page = 2
  • если хотите получать не по 10, а по 20 (не больше 100) допустим, добавьте параметр per_page в каждом запросе
    • per_page = 20

application/json

200 OK
Отправка корзины в заказ

POST /orders.json

Tags: Группы заказов

TODO: Add Description

application/x-www-form-urlencoded

baskets[3684][check]

где 3684 это ID корзины, значение - true. Например: baskets[3682][check] = true

formData boolean
baskets[3684][qnt]

количество

formData integer (int32)
baskets[3684][cost]

Цена

formData number (double)
order[customer_id]

ID клиента

formData integer (int32)
order[delivery_type_id]

ID типа доставки заказа

formData string
order[payment_type_id]

ID типа оплаты заказа

formData string
order[delivery_point_id]

ID пункта доставки заказа

formData string
order[order_address_attributes][zip_code]

индекс адреса доставки заказа

formData string
order[order_address_attributes][city]

город адреса доставки заказа

formData string
order[order_address_attributes][street]

улица адреса доставки заказа

formData string
order[order_address_attributes][house]

дом, здание адреса доставки заказа

formData string
order[order_address_attributes][flat]

квартира, офис адреса доставки заказа

formData string
order[order_address_attributes][pasport_series]

серия паспорта в адресе доставки заказа

formData string
order[order_address_attributes][pasport_number]

номер паспорта в адресе доставки заказа

formData string
order[order_address_attributes][pasport_issued]

кем выдан паспорт в адресе доставки заказа

formData string
order[order_address_attributes][pasport_subdivision_code]

код подразделения выдавшего паспорт в адресе доставки заказа

formData string
order[comment]

комментарий к заказу

formData string

application/json

200 OK
Удаление группы заказов

DELETE /orders/1.json

Tags: Группы заказов

Удаление группы заказов по ID.

application/json

200 OK
Получение бланка заказа по ID4

GET /orders/1.json

Tags: Группы заказов

Получаем бланк заказа (в виде html) по ID группы заказов. Вместо 1 указываем ID нужного вам группы заказов

application/json

200 OK
Редактирование заказа

PUT /orders/1.json

Tags: Группы заказов

Обязательные параметры

  • 1 - ID группы заказов
  • ключ order, и после него указываем аттрибут заказа, которую нужно изменить:
    • order[customer_id] = 714

application/x-www-form-urlencoded

order[customer_id]

ID клиента

formData integer (int32)

application/json

200 OK
Отправить письмо клиенту о проверке по VIN номеру

GET /orders/1/vin_check.json

Tags: Группы заказов

TODO: Add Description

application/json

200 OK
Объединить выбранные заказы

POST /orders/make_join

Tags: Группы заказов

Нужно передать 2 обязательных параметра:

  1. order_ids
  2. main_order_id

Значение order_ids это строка с ID группы заказов разделенные пробелом, например - "10878 10875" Значение main_order_id это ID группы заказов в которую оббъединяются заказы, обязательно это ID из параметра order_ids

например:

  • order_ids = "10878 10875"
  • main_order_id = 10878

application/x-www-form-urlencoded

order_ids

строка с ID группы заказов разделенные пробелом, например - "10878 10875"

formData string
main_order_id

ID группы заказов в которую объединяются заказы, обязательно это ID из параметра order_ids. Например: 10878

formData integer (int32)

application/json

200 OK

POST /orders/manual.json

Tags: Группы заказов

Передаваемые параметры для создания заказа:

  • order[customer_id] - ID клиента (обязательное поле)
  • Параметры каждой позиции передаются через нумерацию в параметре order_items_attributes, для первой позиции это будет 0, для второй 1, для третьей позиции это будет 2 и так далее для всех последующих позиций. Например:
    • order[order_items_attributes][0][oem] - Артикул 1-й позиции
    • order[order_items_attributes][1][oem] - Артикул 2-й позиции
    • order[order_items_attributes][2][oem] - Артикул 3-й позиции

application/x-www-form-urlencoded

order[customer_id]

ID клиента

formData integer (int32)
order[external_crm_id]

ID заказа в внешней системе учета

formData string
order[disable_balance_recalc]

Отключить учет баланса по данному заказу

formData boolean
order[order_items_attributes][0][oem]

Артикул позиции

formData integer (int32)
order[order_items_attributes][0][make_name]

Производитель

formData string
order[order_items_attributes][0][detail_name]

Название детали

formData string
order[order_items_attributes][0][min_delivery_day]

Мин. срок

formData integer (int32)
order[order_items_attributes][0][max_delivery_day]

Макс. срок

formData integer (int32)
order[order_items_attributes][0][comment]

Комментарий

formData string
order[order_items_attributes][0][company_comment]

Комментарий компании

formData string
order[order_items_attributes][0][first_cost]

Закупка

formData integer (int32)
order[order_items_attributes][0][cost]

Продажа

formData integer (int32)
order[order_items_attributes][0][qnt]

Количество

formData integer (int32)
order[order_items_attributes][0][price_id]

ID прайса

formData string

application/json

200 OK
Получение списка типов оплат12

GET /payment_types.json

Tags: Типы оплат

TODO: Add Description

application/json

200 OK
Создание типа оплат

POST /payment_types.json

Tags: Типы оплат

Add Description

application/x-www-form-urlencoded

payment_type[name]

Название

formData string
payment_type[active]

Активна, возможное значение - 0 или 1

formData integer (int32)
payment_type[default]

По умолчанию, возможное значение - 0 или 1

formData integer (int32)
payment_type[for_customers]

Для типов пользователей (Юр. Лица - 0, Физ. Лица - 1)

formData integer (int32)

application/json

200 OK
Удаление типа оплаты5

DELETE /payment_types/1.json

Tags: Типы оплат

Замените 1 на ID типа оплат, которого нужно удалить

application/json

200 OK
Получение типа оплат по ID7

GET /payment_types/1.json

Tags: Типы оплат

Замените 1 на ID типа оплат, которого нужно посмотреть

application/json

200 OK
Редактирование типа оплат

PUT /payment_types/1.json

Tags: Типы оплат

Замените 1 на ID типа оплат, которого нужно редактировать

application/x-www-form-urlencoded

payment_type[name]

Название

formData string
payment_type[active]

Активна, возможное значение - 0 или 1

formData integer (int32)
payment_type[default]

По умолчанию, возможное значение - 0 или 1

formData integer (int32)
payment_type[for_customers]

Для типов пользователей (Юр. Лица - 0, Физ. Лица - 1)

formData integer (int32)

application/json

200 OK
Получение списка всех атрибутов продукции

GET /product_attributes.json

Tags: Атрибуты продукции

Получение списка атрибутов продукции

application/json; charset=utf-8

200 OK
Example for application/json; charset=utf-8
[object Object]
X-Frame-Options string SAMEORIGIN
X-XSS-Protection string 1; mode=block
X-Content-Type-Options string nosniff
ETag string W/"b9a0b71b80122eb50b189a992a9dcd8a"
Cache-Control string max-age=0, private, must-revalidate
X-Request-Id string f6550bc7-9631-40d9-a222-aa84e0953a56
X-Runtime string 0.135789
Transfer-Encoding string chunked
Создание атрибута

POST /product_attributes.json

Tags: Атрибуты продукции

Создание одного атрибута продукции

multipart/form-data

product_attribute[name]

Название атрибута

formData string
product_attribute[description]

Описание атрибута

formData string
product_attribute[product_category_ids][]

Массив ID категорий в которые входит атрибут

formData integer[]
product_attribute[any_value]

Произвольное значение

formData boolean
product_attribute[spec_show]

Спец. размещение

formData boolean
product_attribute[enable_top]

Включить показ популярных

formData boolean
product_attribute[enable_filter]

Фильтр чекбоксов

formData boolean
product_attribute[get_value_from_1c]

Получение значений из 1С

formData boolean
product_attribute[top_count]

Количество в топе

formData integer (int32)

application/json; charset=utf-8

200 OK
Example for application/json; charset=utf-8
[object Object]
X-Frame-Options string SAMEORIGIN
X-XSS-Protection string 1; mode=block
X-Content-Type-Options string nosniff
ETag string W/"b9a0b71b80122eb50b189a992a9dcd8a"
Cache-Control string max-age=0, private, must-revalidate
X-Request-Id string f6550bc7-9631-40d9-a222-aa84e0953a56
X-Runtime string 0.135789
Transfer-Encoding string chunked
Удаление атрибута по его ID

DELETE /product_attributes/1.json

Tags: Атрибуты продукции

Удаление атрибута по его ID

application/json

200 OK
Обновление атрибута

PUT /product_attributes/1.json

Tags: Атрибуты продукции

Замените 1 на ID атрибута, который нужно редактировать

multipart/form-data

product_attribute[name]

Название атрибута

formData string
product_attribute[description]

Описание атрибута

formData string
product_attribute[product_category_ids][]

Массив ID категорий в которые входит атрибут

formData integer[]
product_attribute[any_value]

Произвольное значение

formData boolean
product_attribute[spec_show]

Спец. размещение

formData boolean
product_attribute[enable_top]

Включить показ популярных

formData boolean
product_attribute[enable_filter]

Фильтр чекбоксов

formData boolean
product_attribute[get_value_from_1c]

Получение значений из 1С

formData boolean
product_attribute[top_count]

Количество в топе

formData integer (int32)

application/json; charset=utf-8

200 OK
Example for application/json; charset=utf-8
[object Object]
X-Frame-Options string SAMEORIGIN
X-XSS-Protection string 1; mode=block
X-Content-Type-Options string nosniff
ETag string W/"b9a0b71b80122eb50b189a992a9dcd8a"
Cache-Control string max-age=0, private, must-revalidate
X-Request-Id string f6550bc7-9631-40d9-a222-aa84e0953a56
X-Runtime string 0.135789
Transfer-Encoding string chunked
Получение списка всех категорий

GET /product_categories.json

Tags: Категории продукции

Получение списка категорий

application/json; charset=utf-8

200 OK
Example for application/json; charset=utf-8
[object Object]
X-Frame-Options string SAMEORIGIN
X-XSS-Protection string 1; mode=block
X-Content-Type-Options string nosniff
ETag string W/"b9a0b71b80122eb50b189a992a9dcd8a"
Cache-Control string max-age=0, private, must-revalidate
X-Request-Id string f6550bc7-9631-40d9-a222-aa84e0953a56
X-Runtime string 0.135789
Transfer-Encoding string chunked
Создание категории

POST /product_categories.json

Tags: Категории продукции

Создание одной категории продукции

multipart/form-data

product_category[name]

Название категории

formData string
product_category[active]

Активна

formData boolean
product_category[on_main_page]

На главной

formData boolean
product_category[show_product_in_sub_category]

Показывать товары подкатегорий

formData boolean
product_category[slug]

SLUG запись

formData string
product_category[yandex_category_id]

Соответвует Яндекс.Маркет/Google Merchant категориям

formData integer (int32)
product_category[yandex_market_manufacturer_warranty]

Гарантия производителя - Яндекс Маркет

formData boolean
product_category[is_excise_products]

Товары облагаются акцизом. При выставленнии счета товары из данной категории будут отмечаться как акцизные

formData boolean
product_category[sub_url]

Замена URL

formData string
product_category[description]

Описание

formData string
product_category[promo_title]

Заголовок промо

formData string
product_category[promo_vin_title]

Заголовок подбора в форме вин запроса

formData string
product_category[promo_example]

Текст примера

formData string
product_category[promo_description]

Описание промо

formData string
product_category[seo_h1]

Заголовок (H1)

formData string
product_category[meta_title]

Заголовок (title)

formData string
product_category[meta_description]

Описание (meta description)

formData string
product_category[meta_keywords]

Ключевые слова (meta keywords)

formData string
product_category[seo_text]

Текст под контентом

formData string

application/json; charset=utf-8

200 OK
Example for application/json; charset=utf-8
[object Object]
X-Frame-Options string SAMEORIGIN
X-XSS-Protection string 1; mode=block
X-Content-Type-Options string nosniff
ETag string W/"b9a0b71b80122eb50b189a992a9dcd8a"
Cache-Control string max-age=0, private, must-revalidate
X-Request-Id string f6550bc7-9631-40d9-a222-aa84e0953a56
X-Runtime string 0.135789
Transfer-Encoding string chunked
Удаление категории по её ID

DELETE /product_categories/1.json

Tags: Категории продукции

Удаление категории по её ID

application/json

200 OK
Обновление категории

PUT /product_categories/1.json

Tags: Категории продукции

Замените 1 на ID категории, которую нужно редактировать

multipart/form-data

product_category[name]

Название категории

formData string
product_category[active]

Активна

formData boolean
product_category[on_main_page]

На главной

formData boolean
product_category[show_product_in_sub_category]

Показывать товары подкатегорий

formData boolean
product_category[slug]

SLUG запись

formData string
product_category[yandex_category_id]

Соответвует Яндекс.Маркет/Google Merchant категориям

formData integer (int32)
product_category[yandex_market_manufacturer_warranty]

Гарантия производителя - Яндекс Маркет

formData boolean
product_category[is_excise_products]

Товары облагаются акцизом. При выставленнии счета товары из данной категории будут отмечаться как акцизные

formData boolean
product_category[sub_url]

Замена URL

formData string
product_category[description]

Описание

formData string
product_category[promo_title]

Заголовок промо

formData string
product_category[promo_vin_title]

Заголовок подбора в форме вин запроса

formData string
product_category[promo_example]

Текст примера

formData string
product_category[promo_description]

Описание промо

formData string
product_category[seo_h1]

Заголовок (H1)

formData string
product_category[meta_title]

Заголовок (title)

formData string
product_category[meta_description]

Описание (meta description)

formData string
product_category[meta_keywords]

Ключевые слова (meta keywords)

formData string
product_category[seo_text]

Текст под контентом

formData string

application/json; charset=utf-8

200 OK
Example for application/json; charset=utf-8
[object Object]
X-Frame-Options string SAMEORIGIN
X-XSS-Protection string 1; mode=block
X-Content-Type-Options string nosniff
ETag string W/"b9a0b71b80122eb50b189a992a9dcd8a"
Cache-Control string max-age=0, private, must-revalidate
X-Request-Id string f6550bc7-9631-40d9-a222-aa84e0953a56
X-Runtime string 0.135789
Transfer-Encoding string chunked
Получение списка возвратов

GET /product_return_reason_requests.json

Tags: Возвраты

Получение списка возвратов

search[order_item_id_eq]

Пример параметра фильтрации списка. ID заказа возврата по которому фильтруется список

formData integer (int32)
page

Параметр пагинации списка - нумерация списка получаемых в запросе

formData integer (int32)
per_page

Параметр пагинации списка - кол-во данных в списке в каждом запросе

formData integer (int32)

application/json

200 OK
Получение списка всех заменяемых ссылок

GET /product_urls.json

Tags: Заменяемые ссылки

Получение списка заменяемых ссылок

application/json; charset=utf-8

200 OK
Example for application/json; charset=utf-8
[object Object]
X-Frame-Options string SAMEORIGIN
X-XSS-Protection string 1; mode=block
X-Content-Type-Options string nosniff
ETag string W/"b9a0b71b80122eb50b189a992a9dcd8a"
Cache-Control string max-age=0, private, must-revalidate
X-Request-Id string f6550bc7-9631-40d9-a222-aa84e0953a56
X-Runtime string 0.135789
Transfer-Encoding string chunked
Создание ссылки

POST /product_urls/

Tags: Заменяемые ссылки

Создание одной заменяемой ссылки

multipart/form-data

product_url[make_name]

Бренд товара (make_name)

formData string
product_url[oem]

Номер товара (oem)

formData string
product_url[path]

Ссылка на которую заменяется (path)

formData string

application/json; charset=utf-8

200 OK
Example for application/json; charset=utf-8
[object Object]
X-Frame-Options string SAMEORIGIN
X-XSS-Protection string 1; mode=block
X-Content-Type-Options string nosniff
ETag string W/"b9a0b71b80122eb50b189a992a9dcd8a"
Cache-Control string max-age=0, private, must-revalidate
X-Request-Id string f6550bc7-9631-40d9-a222-aa84e0953a56
X-Runtime string 0.135789
Transfer-Encoding string chunked
Удаление ссылки по её ID

DELETE /product_urls/1

Tags: Заменяемые ссылки

Удаление ссылки по её ID

application/json

200 OK
Обновление ссылки

PUT /product_urls/1

Tags: Заменяемые ссылки

Замените 1 на ID ссылки, которую нужно редактировать

product_url[make_name]

Бренд товара (make_name)

formData string
product_url[oem]

Номер товара (oem)

formData string
product_url[path]

Ссылка на которую заменяется (path)

formData string

application/json; charset=utf-8

200 OK
Example for application/json; charset=utf-8
[object Object]
X-Frame-Options string