1b.app
Скопійоване посилання -
Ми використовуємо файли cookies для оптимізації контенту та швидкодії сайту. Продовжуючи відвідування сайту, ви погоджуєтесь на використання файлів cookies.
ru en de pl
RU EN DE PL
Вхід/Реєстрація
  1. OneBox
    2. ›
  2. OneBox Rest API
    3. ›
  3. API замовлення (Orders)

API замовлення (Orders)

Навіщо це потрібно клієнтам? Як правило це лише кілька речей - передати замовлення, товар, категорії, бренди в BOX. Для цього використовується кілька методів. Детальніше нижче



Додавання замовлення, метод: /api/orders/add/

Параметри

Приклад:

http://myboxurl/api/orders/add/?login=LOGIN&password=PASSWORD&clientnamefirst=Василь&clientnamelast=Іванов&clientemail=vasyas33@test.ru&clientphone=+380639370442&clientcode=31333&clientaddress=Київ&managername=Інна Леонова&ordercode=1333&sum=320&comments=зробив передоплату&source=мій магазин&payed=1&productArray[0][id]=100500&productArray[0][name]=Тестовий ТОВАР1&productArray[0][price]=102&productArray[0][count]=1&productArray[1][id]=123131&productArray[1][name]=Новий% 20тестовий% 20продукт2&productArray[1][price]=122&productArray[1][count]=2

Перед створенням замовлення контакт створювати не потрібно, система BOX створить його сама, якщо це буде необхідно .
Додавання проекту або завдання за допомогою REST API здійснюється аналогічно додаванню замовлення. Для цього обов'язковим параметром при передачі запиту є параметр workflowname, за допомогою якого передається назва Бізнес-процесу, в якому Ви хочете створити проект / замовлення / завдання. У разі якщо Ви вказуєте назву Бізнес-процесу - обов'язково перевірте щоб він був створений в вашому OneBox. У випадку якщо не вказати Бізнес-процес, то вибереться Бізнес-процес за умовчанням для замовлень.


№ Поле Тип Опис Обов'язкове чи ні Коментар
1 login string Логін в системі BOX Обов'язкове поле.  
2 password string Пароль в форматі md5 Обов'язкове поле. Напишіть в техпідтримку і ми видамо вам hash для API
3 ordercode string id замовлення з вашої системи Обов'язкове поле. Це унікальний ідентифікатор замовлення з вашої системи (з вашого магазину). Якщо замовлення з таким id існує API видасть помилку
4 workflowname string Ім'я Бізнес процесу для замовлень Не обов'язкове поле. Вкажіть ім'я БП в який ви хочете додати замовлення. Якщо ви вказуєте БП то перевірте щоб він обов'язково був створений в вашому BOX. Якщо не вказати то вибереться БП за замовчуванням для замовлень.
5 statusname string статус замовлення Не обов'язкове поле. Вкажіть статус з БП в який ви хочете додати замовлення. Якщо ви не вкажіть статус то за замовчуванням виберестся стартовий.
6 source string Канал замовлення Не обов'язкове поле.  
7 cdate datetime дата замовлення Не обов'язкове поле. Дата створення замовлення, повинна бути в форматі (Ymd H: i: s) Приклад: 2015-12-15 23:11:00
8 name string Ім'я замовлення Не обов'язкове поле.  
9 clientcode string id клієнта з замовлення Не обов'язкове поле. У це поле ви можете написати id користувача з замовлення з вашої системи.
10 clientnamefirst string Ім'я клієнта з замовлення Не обов'язкове поле.  
11 clientnamelast string Прізвище клієнта з замовлення Не обов'язкове поле.  
12 clientnamemiddle string батькові клієнта з замовлення Не обов'язкове поле.  
13 clientphone integer Телефон клієнта з замовлення Або email або телефон клієнта обов'язково Бажано в форматі 380XXXXXXXXX
14 clientemail string Email клієнта з замовлення  
15 clientaddress string Адреса клієнта з замовлення Не обов'язкове поле.  
16 managercode string id менеджера з замовлення Не обов'язкове поле. У це поле ви можете написати id менеджера з замовлення з вашої системи.
17 managername string Ім'я менеджера з замовлення Не обов'язкове поле.  
18 managerphone integer Телефон менеджера з замовлення Не обов'язкове поле. Бажано в форматі 380XXXXXXXXX
19 manageremail string Email менеджера з замовлення Не обов'язкове поле.  
20 comments string Коментар в замовлення Не обов'язкове поле. У це поле ви можете написати будь-яку потрібну вам інформацію про замовленні
21 deliveryid integer id способу доставки замовлення Не обов'язкове поле. Якщо у вашій системі WebProduction BOX тобто додавання способи доставки, то вкажіть id потрібного способу доставки
22 deliverynote string Коментар до доставки замовлення Не обов'язкове поле.  
23 sum float сума замовлення Не обов'язкове поле.  
24 payed true / false Оплачено чи замовлення Не обов'язкове поле. Якщо замовлення оплачений, то передавайте в це поле true і в BOX додасться оплата даного замовлення і розділі фінансів і в самому замовленні.
25 productArray array (id, name, price, count) Масив товарів з замовлення Не обов'язкове поле.
id - id товару з BOX, якщо такий є те система його зв'яже із замовленням
code1c - id товару з вашої системи, якщо такий є те система його зв'яже із замовленням
articul - артикул товару з системи, якщо такий є те система його зв'яже із замовленням
name - ім'я товару
price - ціна товару за одиницю
count - кількість даного товару в замовленні
currency - валюта товару в замовленні (UAH, RUB, USD, EUR та тд..)
discount_percent - Відсоток знижки для продукту процесу
supplierid - ID постачальника в системі
suppliercode1c - Зовнішній ID постачальника в системі
custom_{key} - Custom-е поле. Замість {key} потрібно підставляти ключ додаткового поля з продукту замовлення
26 workflowid integer ID Бізнес процесу Не обов'язкове поле. Вкажіть id БП в який ви хочете додати замовлення / завдання / проект. Якщо ви вказуєте БП то перевірте щоб він обов'язково був створений в вашому OneBox.
27 statusid integer ID Статусa замовлення Не обов'язкове поле. Вкажіть ID статусу на який ви хочете перевести БП. Якщо ви не вкажіть статус то за замовчуванням виберестся стартовий.
28 type string Тип БП Не обов'язкове поле. Якщо не вказувати БП то вказуйте тип БП для додавання
29 utm_date string UTL мітка utm_date Не обов'язкове поле.  
30 utm_campaign string UTL мітка utm_campaign Не обов'язкове поле.  
31 utm_source string UTL мітка utm_source Не обов'язкове поле.  
32 utm_content string UTL мітка utm_content Не обов'язкове поле.  
33 utm_referrer string UTL мітка utm_referrer Не обов'язкове поле.  
34 utm_medium string UTL мітка utm_medium Не обов'язкове поле.  
35 utm_term string UTL мітка utm_term Не обов'язкове поле.  
36 custom_{key} string Custom-е поле Замість {key} потрібно підставляти ключ додаткового поля з замовлення При передачі посилання на файл для додаткового поля з типом" Файл" - він буде завантажений в систему і ID записаний в додаткове поле
37 customuser_{key} string Custom-е поле клієнта Замість {key} потрібно підставляти ключ додаткового поля з картки контакту При передачі посилання на файл для додаткового поля з типом" Файл" - він буде завантажений в систему і ID записаний в додаткове поле
38 dateto datetime Дата запланована замовлення (завдання) Не обов'язкове поле. Дата запланована замовлення, повинна бути в форматі (Ymd H: i: s) Приклад: 2015-12-15 23:11:00
39 deliveryprice float вартість доставки Не обов'язкове поле.  
40 discountid integer ID знижки з системи OneBox Не обов'язкове поле.  
41 discountname string Ім'я знижки з системи OneBox Не обов'язкове поле.  
42 discountsum float Сума знижки Не обов'язкове поле.  
43 contractorid integer Юридична особа замовлення Не обов'язкове поле.  
44 paymentid integer ID способу оплати Не обов'язкове поле. id способу оплати з системи OneBox
45 paymentname string Ім'я способу оплати Не обов'язкове поле. Якщо вказати цей параметр, то система спробує знайти даний спосіб оплати в OneBox і поднятнуть його
46 country string Країна Не обов'язкове поле.  
47 region string Регіон (область) Не обов'язкове поле.  
48 district string Район Не обов'язкове поле.  
49 city string Назва населеного пункту Не обов'язкове поле.  
50 street string Вулиця Не обов'язкове поле.  
51 street_number string Номер будинку Не обов'язкове поле.  
52 apartment string Квартира Не обов'язкове поле.  
53 currencyrate_{key} string Курс валюти для замовлення Замість {key} потрібно підставляти назва валюти  
54 documenttemplateid int ID шаблону документа Не обов'язкове поле. Після створення процесу буде зроблено спробу формування документа згідно із зазначеним шаблоном документів.
55 documentpdf base64 encoded string Вміст створюваного PDF документа в кодуванні base64. Не обов'язкове поле. Після формування документа по documenttemplateid вміст PDF документа буде декодовано і додано як скан-копія до створеного документу.
56 dataFromBody boolean Брати дані не з аргументів, а з body Не обов'язкове поле. Якщо переданий dataFromBody = 1, то дані будуть брати не з аргументів, а з тіла запиту. В тіло має бути переданий json, в якому ключами повинні бути параметри, описані вище. login і password пі цьому повинні посилаті як зазвичай
57 typesex string Тип клієнта процесу Не обов'язкове поле. Ви можете надсилати назву або ключ типу контактів з налаштувань системи" Типи контактів"
58 parentid integer id батьківського процесу Не обов'язкове поле. id процесу, який потрібно призначити батьківським, поточний процес стане його підпроцесом
59 company string Назва компанії клієнта Не обов'язкове поле. Якщо компанія з такою назвою не буде знайдена, вона буде створена
60 files string|array Файли до опису процесу Не обов'язкове поле. Посилання або масив посилань на файли, які необхідно завантажити і додати до опису процесу
61 restoreSource boolean Відновити віддалений джерело Не обов'язкове поле. Якщо передається джерело видалений, він буде відновлений. Дата створення джерела буде оновлено до поточної.

Видалення замовлення, метод: /api/orders/delete/

Параметри

Приклад:

http://myboxurl/api/orders/delete/?login=LOGIN&password=PASSWORD&orderid=660

№ Поле Тип Опис Обов'язкове чи ні Коментар
1 login string Логін в системі BOX Обов'язкове поле.  
2 password string Пароль в форматі md5 Обов'язкове поле. Напишіть в техпідтримку і ми видамо вам hash для API
3 orderid string Іднетіфікатор замовлення Обов'язкове поле. У це поле ви можете передати або id замовлення яке повернуло вам наше API при його створенні. Або ж передати туди зовнішніх ідентифікатор замовлення (поле ordercode при створенні замовлення . Система спробує знайти замовлення з таким зовнішнім ID і видалить його.

Редагування замовлення, метод: /api/orders/update/

Параметри

Приклад:

http://myboxurl/api/orders/update/?login=LOGIN&password=PASSWORD&orderid=660&&name=Міняю ім'я замовлення&workflowname=Замовлення&statusname=Доставлений&payed=1

№ Поле Тип Опис Обов'язкове чи ні Коментар
1 login string Логін в системі BOX Обов'язкове поле.  
2 password string Пароль в форматі md5 Обов'язкове поле. Напишіть в техпідтримку і ми видамо вам hash для API
3 orderid string Іднетіфікатор замовлення Обов'язкове поле. У це поле ви можете передати або id замовлення яке повернуло вам наше API при його створенні. Або ж передати туди зовнішніх ідентифікатор замовлення (поле ordercode при створенні замовлення). Система спробує знайти замовлення з таким зовнішнім ID.
4 name string Ім'я замовлення Не обов'язкове поле.  
5 comments string Коментар до замовлення Не обов'язкове поле.  
6 sum float сума замовлення Не обов'язкове поле.  
7 deliverynote string Коментарі по доставці Не обов'язкове поле.  
8 workflowname string Бізнес процес замовлення Не обов'язкове поле. Ви можете через API змінити БП замовлення на інший
9 statusname string Статус замовлення по даній БП Не обов'язкове поле. Задати інший статус замовлення
10 payed boolean Провести чи оплату за замовленням Не обов'язкове поле. Оплачено чи замовлення
11 productArray array Додати товари в замовлення Не обов'язкове поле. Ви можете додати товари вже в існуючий замовлення. При цьому його сума автоматично перерахується
id - id товару з BOX, якщо такий є те система його зв'яже із замовленням
code1c - id товару з вашої системи, якщо такий є те система його зв'яже із замовленням
articul - артикул товару з системи, якщо такий є те система його зв'яже із замовленням
name - ім'я товару
price - ціна товару за одиницю
count - кількість даного товару в замовленні
currency - валюта товару в замовленні (UAH, RUB, USD, EUR та тд..)
storagecode1c - Зовнішній ID складу, на якому BOX спробує зарезервувати товар, якщо він ще не зарезервований
storagefromcode1c - зовнішній ID складу.
suplierid - ID постачальника в системі
supliercode1c - Зовнішній ID постачальника
custom_{key} - Custom-е поле. Замість {key} потрібно підставляти ключ додаткового поля з продукту замовлення
12 workflowid integer Id Бізнес процесу замовлення Не обов'язкове поле. Ви можете через API змінити БП замовлення на інший
13 statusid integer Id статусу з даного БП Не обов'язкове поле. Задати інший статус по id
14 deleteproducts 0/1 Видалити товари з замовлення Не обов'язкове поле. Якщо 1 - видаляє всі товари в редагованому замовленні
15 dataFromBody boolean Брати дані не з аргументів, а з body Не обов'язкове поле. Якщо переданий dataFromBody = 1, то дані будуть брати не з аргументів, а з тіла запиту. В тіло має бути переданий json, в якому ключами повинні бути параметри, описані вище. login і password пі цьому повинні посилаті як зазвичай
16 paymentid integer ID способу оплати процесу Не обов'язкове поле.  
17 customuser_[key] optional Додаткове поле клієнта процесу Не обов'язкове поле. Замість [key] необхідно підставляти ідентифікатор додаткового поля клієнта
17 customorder_[key] optional Додаткове поле процесу Не обов'язкове поле. Замість [key] необхідно підставляти ідентифікатор додаткового поля процесу
При передачі посилання на файл для додаткового поля з типом" Файл" - він буде завантажений в систему і ID записаний в додаткове поле.
18 clientemail string Email клієнта процесу Не обов'язкове поле. Записується в процес і додається клієнту процесу. У разі відсутності клієнта процесу використовується для пошуку (і створення) клієнта.
19 clientphone string Телефон клієнта процесу Не обов'язкове поле. Записується в процес і додається клієнту процесу. У разі відсутності клієнта процесу використовується для пошуку (і створення) клієнта.
20 clientname string Ім'я клієнта з замовлення Не обов'язкове поле. Використовується для поновлення клієнта процесу (і створення в разі його відсутності)
21 clientnamelast string Прізвище клієнта з замовлення Не обов'язкове поле. Використовується для поновлення клієнта процесу (і створення в разі його відсутності)
22 clientnamemiddle string батькові клієнта з замовлення Не обов'язкове поле. Використовується для поновлення клієнта процесу (і створення в разі його відсутності)
23 clienttypesex string Стать клієнта з замовлення Не обов'язкове поле. Використовується для поновлення клієнта процесу (і створення в разі його відсутності)
24 clientexternalid string Зовнішній ID клієнта з замовлення Не обов'язкове поле. Використовується для поновлення клієнта процесу (і створення в разі його відсутності)
25 clientcode string Код (ЄДРПОУ/ІПН) клієнта з замовлення Не обов'язкове поле. Використовується для поновлення клієнта процесу (і створення в разі його відсутності)
26 clientcompany string Компанія клієнта з замовлення Не обов'язкове поле. Використовується для поновлення клієнта процесу (і створення в разі його відсутності)
27 searchclient boolean Шукати клієнта використовуючи контактні дані, навіть якщо в замовленні є клієнт Не обов'язкове поле.
28 country string Країна Не обов'язкове поле. Використовується для поновлення адреси клієнта процесу
29 region string Регіон (область) Не обов'язкове поле. Використовується для поновлення адреси клієнта процесу
30 district string Район Не обов'язкове поле. Використовується для поновлення адреси клієнта процесу
31 city string Назва населеного пункту Не обов'язкове поле. Використовується для поновлення адреси клієнта процесу
32 street string Вулиця Не обов'язкове поле. Використовується для поновлення адреси клієнта процесу
33 street_number string Номер будинку Не обов'язкове поле. Використовується для поновлення адреси клієнта процесу
34 apartment string Квартира Не обов'язкове поле. Використовується для поновлення адреси клієнта процесу
35 deliveryid integer id способу доставки замовлення Не обов'язкове поле. Якщо у вашій системі WebProduction BOX тобто додавання способи доставки, то вкажіть id потрібного способу доставки
36 novaposhtadeliverynote string Номер ТТН Нової пошти Не обов'язкове поле.
37 novaposhtaredeliverynote string Номер ТТН зворотної доставки Нової пошти Не обов'язкове поле.
38 novaposhtaServiceType string Спосіб достувкі Нова Пошта Не обов'язкове поле. Доступні значення:
WarehouseWarehouse - Cскарб-Склад WarehouseDoors - Cскарб-Двері DoorsWarehouse - Двері-Склад DoorsDoors - Двері-Двері
39 utm_XXX (де замість ХХХ посдставляете потрібну вам мітку, наприклад utm_source, utm_date) string UTM мітки процесу Не обов'язкове поле.
40 files string|array Файли до опису процесу Не обов'язкове поле. Посилання або масив посилань на файли, які необхідно завантажити і додати до опису процесу

Отримання одного замовлення і отримання всіх замовлень, метод: /api/orders/get/

Параметри
Параметри отримання одного замовлення:

Приклад:

http://myboxurl/api/orders/get/?login=LOGIN&password=PASSWORD&orderid=7927

№ Поле Тип Опис Обов'язкове чи ні Коментар
1 login string Логін в системі BOX Обов'язкове поле.  
2 password string Пароль в форматі md5 Обов'язкове поле. Напишіть в техпідтримку і ми видамо вам hash для API
3 supplierhash string Ключ постачальника Не обов'язкове поле. Доступний в картці клієнта, який є контактом постачальника.
Доступний при наявності логіна і пароля від системи і рівня доступу" клієнт".
Ця функція дозволяє обмежити доступ до отримання процесів згідно з цим додаткового поля процесу з ключем постачальника (див. Налаштування" Перевірки і унікальність") або тільки там, де даний контакт є клієнтом-постачальником.
4 orderid string Іднетіфікатор замовлення Обов'язкове поле. Якщо вам потрібен конкретний замовлення то ви в це поле передаєте або id замовлення яке повернуло вам наше API при його створенні. Або ж передати туди зовнішніх ідентифікатор замовлення (поле ordercode при створенні замовлення). Система спробує знайти замовлення з таким зовнішнім ID.
Так-же, присутня можливість отримання замовлення за додатковими полями замовлення. Для цього слід передавати ідентифікатор доп. поля (відображається в настройках) з приставкою' customorder_' і вказати дані значення, наприклад customorder_idKeydoppolya = value

Значення повертаються полів
orderid - id Замовлення
ordercode - зовнішній id замовлення,
ordername - Ім'я замовлення,
clientId - id клієнта в системі BOX,
clientcode - зовнішній id клієнта в системі BOX,
clientname - ім'я клієнта,
clientemail - email клієнта,
clientphone - телефон клієнта,
clientaddress - адреса клієнта,
managerid - id менеджера замовлення,
managername - Ім'я менеджера замовлення,
managerrole - Роль менеджера замовлення,
cdate - дата замовлення,
dateto - дата запланована замовлення,
deliveriID - id способу доставки,
deliverinote - коментарі доставки,
deliveriprice - вартість доставки,
sum - сума замовлення,
sumbase - базова сума замовлення,
currency - валюта замовлення,
statusname - статус замовлення,
workflowname - ім'я БП замовлення,
contractorid - id юридичної особи замовлення,
contractorname - назва юридичної особи замовлення,
weight - загальна вага замовлення,
gabarite - загальний обсяг замовлення,
products - масив продуктів з замовлення, складається з:
  • id - ідентифікатор продукту
  • name - Назва продукту
  • count - кількість продукту
  • price - ціна продукту
  • discountsum - знижка сумою
  • discountpercent - знижка у відсотках
  • pricewithdiscount - ціна продукту зі знижкою
  • storageId - ідентифікатор складу продукту
  • storageExternalId - зовнішній ідентифікатор складу продукту
  • productsource - тип продукту (повертає product або service)
  • pricewithvat - Ціна з ПДВ
  • pricewithoutvat - Ціна без ПДВ
  • productpricewithvat - Вартість з ПДВ
  • productpricewithoutvat - Вартість без ПДВ
  • producttaxvalue - ПДВ (%)
  • supplierid - ID постачальника в системі
  • suppliercode1c - Зовнішній ID постачальника в системі
  • suppliername - Назва постачальника в системі
  • customfields - додаткові поля продукту замовлення, які складаються з:
    • key - ключ_дополнітельного_поля
    • name - назва додаткового поля
    • value - значення додаткового поля
customfields - масив додаткових полів в замовленні, які складаються з:
  • key - ключ_дополнітельного_поля
  • name - назва додаткового поля
  • value - значення додаткового поля
5 sumoutbonuse bool Кількість списаних бонусів в процесі Не обов'язкове поле.  
6 suminbonuse bool Кількість нарахованих бонусів в процесі Не обов'язкове поле.  
7 getcomments bool Отримання коментарів щодо процесу Не обов'язкове поле. Повертає масив з усіма коментарями по процесу

Кожен елемент масиву буде містити
id - id коментаря,
cdate - дата створення коментаря,
type - тип коментаря,
content - текст коментаря,
showtoclient - показується чи коментар клієнту,
userid - id контакту, який залишив коментар,
usercode - зовнішній id контакту,
username - ім'я контакту,
useremail - email контакту,
userphone - Телефон контакту,
8 unescapedunicode bool Чи не кодувати символи Unicode Не обов'язкове поле. При передачі значення 1 даного параметра в результуючому JSON символи Unicode НЕ будуть кодуватися, наприклад, кириличне" а" буде передано як" а", а не як" \u0430"
9 getnovaposhtastatus bool Отримувати статуси ттн Нової пошти Не обов'язкове поле. При передачі значення 1 даного параметра в списку полів додатково будуть статус ттн і статус зворотного ттн Нової пошти


Параметри отримання всіх замовлень:

Приклад:

http://myboxurl/api/orders/get/?login=LOGIN&password=PASSWORD&part=1
http://myboxurl/api/orders/get/?login=LOGIN&password=PASSWORD&part=2

№ Поле Тип Опис Обов'язкове чи ні Коментар
1 login string Логін в системі BOX Обов'язкове поле.  
2 password string Пароль в форматі md5 Обов'язкове поле. Напишіть в техпідтримку і ми видамо вам hash для API
3 supplierhash string Ключ постачальника Не обов'язкове поле. Доступний в картці клієнта, який є контактом постачальника.
Доступний при наявності логіна і пароля від системи і рівня доступу" клієнт".
Ця функція дозволяє обмежити доступ до отримання процесів згідно з цим додаткового поля процесу з ключем постачальника (див. Налаштування" Перевірки і унікальність") або тільки там, де даний контакт є клієнтом-постачальником.
4 workflowname string Ім'я Бізнес процесу для замовлень Не обов'язкове поле. Вкажіть ім'я Бізнес процесу по якому ви хочете відфільтрувати замовлення / завдання / проекти
5 workflowid string ID Бізнес процесу Не обов'язкове поле. Вкажіть id Бізнес процесу по якому ви хочете відфільтрувати замовлення / завдання / проекти. Якщо ви вказуєте БП то перевірте щоб він обов'язково був створений в вашому OneBox.
6 type string Тип БП Не обов'язкове поле. Вкажіть тип Бізнес процесу, що б відфільтрувати замовлення / завдання / проекти із заданим типом
7 statusname string статус замовлення Не обов'язкове поле. Вкажіть ім'я статусу БП за яким ви хочете відфільтрувати замовлення / завдання / проекти.
8 statusid string ID Статусa замовлення Не обов'язкове поле. Вкажіть ID статусу БП за яким ви хочете відфільтрувати замовлення / завдання / проекти.
9 cdate date Дата створення замовлення Не обов'язкове поле. Вкажіть дату створення і в підсумкову вибірку потраплять тільки ті замовлення, у які дата створення більше або дорівнює заданої
10 udate date Дата і час останнього оновлення замовлення Не обов'язкове поле. УУкажіте дату останнього оновлення і в підсумкову вибірку потраплять тільки ті замовлення, в яких дата останнього зміна більше або дорівнює заданої
11 clientId string ID клієнта в системі BOX Не обов'язкове поле. Вкажіть ID клієнта за яким ви хочете відфільтрувати процеси.
12 clientcode string зовнішній id клієнта в системі BOX Не обов'язкове поле. Вкажіть зовнішній ID клієнта за яким ви хочете відфільтрувати процеси.
13 sumoutbonuse bool Кількість списаних бонусів в процесі Не обов'язкове поле.  
14 suminbonuse bool Кількість нарахованих бонусів в процесі Не обов'язкове поле.  
15 typesex string Тип контакту клієнта процесу Не обов'язкове поле. Для фільтрації процесів за типом контакту клієнта процесу необхідно передавати ключ типу контакту (наприклад company)
16 customorder_[ключ] optional Фільтрація процесів за додатковими полями процесу Не обов'язкове поле. Для додаткових полів з типом "Число ціле", "Число з плаваючою точкою", "Дата і час", "Дата", "Час" доступна фільтрація за інтервалом значень ВІД і ДО шляхом передачі параметрів customorder_[ключ]_from та customorder_[ключ]_to
17 customuser_[ключ] optional Фільтрація процесів за додатковими полями клієнта процесу Не обов'язкове поле. Для додаткових полів з типом "Число ціле", "Число з плаваючою точкою", "Дата і час", "Дата", "Час" доступна фільтрація за інтервалом значень ВІД і ДО шляхом передачі параметрів customuser_[ключ]_from та customuser_[ключ]_to
18 part integer Частина замовлень Обов'язкове поле. API видає в 1й частини до 1000 замовлень, щоб отримати такі 1000 замовлень передайте туди 2 (виходить частина 2) і тд.

Значення повертаються полів
orderid - id Замовлення
ordernumber - номер замовлення
ordercode - зовнішній id замовлення,
ordername - Ім'я замовлення,
clientId - id клієнта в системі BOX,
clientcode - зовнішній id клієнта в системі BOX,
clientname - ім'я клієнта,
clientemail - email клієнта,
clientphone - телефон клієнта,
clientaddress - адреса клієнта,
managerid - id менеджера замовлення,
managername - Ім'я менеджера замовлення,
managerrole - Роль менеджера замовлення,
cdate - дата замовлення,
deliveriID - id способу доставки,
deliverinote - коментарі доставки,
deliveriprice - вартість доставки,
sum - сума замовлення,
sumbase - базова сума замовлення,
currency - валюта замовлення,
statusname - статус замовлення,
workflowname - ім'я БП замовлення,
contractorid - id юридичної особи замовлення,
contractorname - назва юридичної особи замовлення,
products - масив продуктів з замовлення, складається з:
  • id - ідентифікатор продукту
  • name - Назва продукту
  • count - кількість продукту
  • price - ціна продукту
  • storageId - ідентифікатор складу продукту
  • storageExternalId - зовнішній ідентифікатор складу продукту
  • productsource - тип продукту (повертає product або service)
  • pricewithvat - Ціна з ПДВ
  • pricewithoutvat - Ціна без ПДВ
  • productpricewithvat - Вартість з ПДВ
  • productpricewithoutvat - Вартість без ПДВ
  • producttaxvalue - ПДВ (%)
  • supplierid - ID постачальника в системі
  • suppliercode1c - Зовнішній ID постачальника в системі
  • suppliername - Назва постачальника в системі
  • customfields - додаткові поля продукту замовлення, які складаються з:
    • key - ключ_дополнітельного_поля
    • name - назва додаткового поля
    • value - значення додаткового поля
customfields - масив додаткових полів в замовленні, які складаються з:
  • key - ключ_дополнітельного_поля
  • name - назва додаткового поля
  • value - значення додаткового поля


Так само доступна фільтрація процесів по повертається полях, а так же полях клієнтів процесів.
Необхідно передати параметр рівний назвою повертається змінної і значення для фільтрації по полю змінної.
Наприклад, при передачі параметра contactCountry = Україна - будуть отфильтрованием процеси, у яких у клієнтів в адресу країною вказано" Україна".
Або ж при передачі параметра contractorid = 1 - будуть отфильтрованием процеси, у яких зазначено юридичну особу з id = 1
19 getcomments bool Отримання коментарів щодо процесу Не обов'язкове поле. Повертає масив з усіма коментарями по процесу

Кожен елемент масиву буде містити
id - id коментаря,
cdate - дата створення коментаря,
type - тип коментаря,
content - текст коментаря,
showtoclient - показується чи коментар клієнту,
userid - id контакту, який залишив коментар,
usercode - зовнішній id контакту,
username - ім'я контакту,
useremail - email контакту,
userphone - Телефон контакту,
20 unescapedunicode bool Чи не кодувати символи Unicode Не обов'язкове поле. При передачі значення 1 даного параметра в результуючому JSON символи Unicode НЕ будуть кодуватися, наприклад, кириличне" а" буде передано як" а", а не як" \u0430"
21 getnovaposhtastatus bool Отримувати статуси ттн Нової пошти Не обов'язкове поле. При передачі значення 1 даного параметра в списку полів додатково будуть статус ттн і статус зворотного ттн Нової пошти

Отримання коментарів щодо процесу, метод: /api/order/comments/get/

Параметри
Параметри отримання одного замовлення:

Приклад:

http://myboxurl/api/order/comments/get/?login=LOGIN&password=PASSWORD&id=7927

У відповідь буде видано JSON з масивом даних по коментарю і автору коментаря.


№ Поле Тип Опис Обов'язкове чи ні Коментар
1 login string Логін в системі BOX Обов'язкове поле.  
2 password string Пароль в форматі md5 Обов'язкове поле. Напишіть в техпідтримку і ми видамо вам hash для API
3 id string Іднетіфікатор процесу Обов'язкове поле. ID процесу в OneBox. По ньому буде проведена спробі знайти процес.
3 code string Зовнішній ідентифікатор процесу Не обов'язкове поле. Зовнішній ID процесу в OneBox. По ньому буде проведена спробі знайти процес.
3 type array Масив типів коментарів Не обов'язкове поле. Доступні типи:
comment - Коментар:
commentresult - результат:
change - зміна:
email - лист
call - дзвінок
notify - повідомлення

Можливі варіанти відповіді на запит

Детальніше
№ Статус Повідомлення Опис повідомлення
1 ok orderid Повертає id доданого замовлення
2 fail login_empty Відсутня логін
3 fail password_empty Відсутня пароль
4 fail clientnamefirst_empty Відсутня прізвище клієнта
5 fail Bad user level! Низький рівень користувача, для виконання даної дії (потрібен level 2 і вище)
6 fail Login or password not correct! Логін або пароль введені невірно
7 fail orderId_empty Відсутня id замовлення
8 fail Order is already! Замовлення вже існує
9 fail Not workflow status by name Не існує статусу БП з таким ім'ям
10 fail Not workflow by name Немає бізнес процесу з таким ім'ям
11 fail Please create Finance Account Створіть фінансовий аккаунт
12 fail Order with this Code does not found! Замовлення з таким кодом не найден
13 fail clientphone_and_clientemail_empty Телефон і пошта клієнта відсутні

Також можуть виникати помилки:

502 Bad Gateway - Якщо виникла ця помилка необхідно:
1. Перевірити, чи є доступ до Інтернету (зайти на будь-який інший сайт).
2. Якщо проблем з доступом немає — можна видалити файли cookies.
Якщо вказане вище не допомогло — проблема на стороні сервера. Слід звернутися до системного адміністратора сайту.

503 (Service Temporarily Unavailable) - дана помилка може виникати в результаті занадто великої кількості запитів до сервера. Якщо ви побачили таку помилку, варто почекати пару хвилин і спробувати знову.

504 Gateway Timeout - cкорее за все справа в зрослої навантаженні на сайт, при якій Apache не встигає віддавати HTTP-відповіді, і нові запити встають в чергу. Щоб вирішити проблему, можна додати ресурсів сервера, зокрема оперативної пам'яті, і збільшити кількість процесів httpd (Apache).
Інша можлива причина виникнення помилки 504 - виконуваний скрипт не вкладається у відведений ліміт часу. Це буває, коли запит занадто важкий. Спробуйте розбити свій запит на кілька більш маленьких.

Помилка 505 HTTP Version not supported означає, що веб-сайт не підтримує версію протоколу HTTP, за допомогою якого браузер здійснює запит веб-сторінки
Операційна система для бізнесу
Email Messenger Форум Facebook Instagram Twitter YouTube Telegram LinkedIn
Visa Mastercard/
Copyright © OneBox 2024