1b.app
Скопійоване посилання -

API товари (Product)

Додавання товару, метод: /api/product/add/

Параметри

Приклад:

http://myboxurl/api/product/add/?login=LOGIN&password=PASSWORD&name=Product&image[0]=/PATH/TO/PICTURE1.JPG&image[1]=/PATH/TO/PICTURE2.JPG&filter[0][filterid]=1&filter[0][filtervalue]=1&customfield_key1=customvalue1&customfield_key2=2016-01-01

Поле Тип Опис Обов'язкове чи ні Коментар
1 login string Логін в системі BOX Обов'язкове поле.  
2 password string Пароль в форматі md5 Обов'язкове поле. Напишіть в техпідтримку і ми видамо вам hash для API
3 name string ім'я товару Обов'язкове поле.  
4 description string Опис товару Не обов'язкове поле.  
5 name+language_code string Ім'я товару (на інших мовах) Не обов'язкове поле. Ключ потрібно вказувати з Двосимвольні кодом іншої мови,
який підключений в модулі багатомовності,
наприклад nameua, nameen
6 description+language_code string Опис товару (на інших мовах) Не обов'язкове поле. Ключ потрібно вказувати з Двосимвольні кодом іншої мови,
який підключений в модулі багатомовності,
наприклад descriptionua, descriptionen
7 price decimal ціна товару Не обов'язкове поле.  
8 pricebase decimal Базова ціна товару Не обов'язкове поле.  
9 currencyname string Назва валюти Не обов'язкове поле.  
10 categorycode string id категорії з вашої системи Не обов'язкове поле. Це унікальний ідентифікатор категорії з вашої системи (з вашого магазину). Якщо категорія з таким id існує - API видасть помилку
11 categoryid integrer id Категорії Не обов'язкове поле. Код категорії в системі BOX.
12 brandname string Назва бренду Не обов'язкове поле. Якщо такого бренду немає, то движок самостійно його створить
13 articul string Артикул товару Не обов'язкове поле.  
14 unit string Одиниці виміру Не обов'язкове поле.  
15 avail boolean Наявність товару Не обов'язкове поле. За замовчуванням, товару немає в наявності (avail = 0)
16 hidden boolean Прихований продукт Не обов'язкове поле. За замовчуванням, товару не прихований (hidden = 0)
17 code1c string Код товару Не обов'язкове поле. Ідентифікатор товару з вашої системи (з вашого магазину)
18 model string Модель Не обов'язкове поле.  
19 seriesname string Модельний ряд товару (серія, колекція) Не обов'язкове поле.  
20 imagegrouped boolean Використовувати зображення і картку як головну в модельному ряду Не обов'язкове поле.  
21 image array Масив зображень категорії Не обов'язкове поле. Зображення слід передавати масивом із зазначенням повного шляху до них. Система працює з такими форматами зображень: jpg, png
22 filter array (filterid, filtervalue, filteractual, filteruse, filteroption) Масив фільтрів для товара Не обов'язкове поле.
filterid - id фільтра для товару з BOX
filtervalue - значення фільтра
filteractual - висновок значення цієї характеристики в таблиці характеристик продукту. За замовчуванням, не є (filteractual = 0)
filteruse - доступ цього фільтра при фільтрації. За замовчуванням, не є (filteruse = 0)
filteroption - опція замовлення цього товару. За замовчуванням, немає (filteroption = 0)
23 prices array (priceid, pricename, pricevalue) Масив додаткових цін для товару Не обов'язкове поле.
priceid - id ціни для товару з BOX
pricename - найменування ціни
pricevalue - значення ціни
24 divisibility float подрібнюваністю товару Не обов'язкове поле. Сюди можна вказати дробильність товару
25 priceold decimal Стара ціна товару Не обов'язкове поле.  
26 discount integer Знижка, % Не обов'язкове поле.  
27 taxvalue float розмір ПДВ Не обов'язкове поле.  
28 barcode string Штрихкод Не обов'язкове поле.  
29 supplierName string Ім'я постачальника Не обов'язкове поле. Або ім'я або id постачальника повинен бути в запиті, якщо ви хочете оновити інформацію про постачальника
30 supplierid interger id постачальника Не обов'язкове поле. Або ім'я або id постачальника повинен бути в запиті, якщо ви хочете оновити інформацію про постачальника
31 suppliercode string Код постачальника товару (артикул) Не обов'язкове поле.  
32 suppliercode1c string Код постачальника товару (артикул) Не обов'язкове поле.  
33 supplierprice float Ціна постачальника Не обов'язкове поле.  
34 suppliercurrency string Валюта постачальника Не обов'язкове поле. (UAH або RUB або USD або EUR.... і тд)
35 supplieravail boolean Наявність постачальника Не обов'язкове поле. 1 - є в наявності, 0 - немає в наявності
36 supplieravailtext string Текст наявності постачальника Не обов'язкове поле. Сюди можна вказати скільки даного товару є у постачальника, або текст наявності
37 supplieractive boolean Активність постачальника Не обов'язкове поле. 1 - позиція постачальника активна, 0 - позиція не активна. За замовчуванням, позиція активна
38 supplierrrc float Ціна постачальника (ррц) Не обов'язкове поле.
39 supplierrrccurrency string Валюта постачальника (ррц) Не обов'язкове поле. (UAH або RUB або USD або EUR.... і тд)
40 suppliercurrent boolean Поточний постачальник товару Не обов'язкове поле. 1 - встановлює постачальника як поточного постачальника товару
41 categories string Додаткові категорії продукту Не обов'язкове поле. productcategoryid1 - "Категорія 1"
productcategoryid2 - "Категорія 2"
productcategoryid3 - "Категорія 3"
productcategoryid4 - "Категорія 4"
productcategoryid5 - "Категорія 5"
productcategoryid6 - "Категорія 6"
42 customfield_key mixed Додаткові поля продукту Не обов'язкове поле. Параметром слід передавати: customfield_*ключ_дополнітельного_поля*

Видалення продукту, метод: /api/product/delete/

Параметри

Приклад:

http://myboxurl/api/product/delete/?login=LOGIN&password=PASSWORD&id=666

Поле Тип Опис Обов'язкове чи ні Коментар
1 login string Логін в системі BOX Обов'язкове поле.  
2 password string Пароль в форматі md5 Обов'язкове поле. Напишіть в техпідтримку і ми видамо вам hash для API
3 id integer ідентифікатори товару Або id або code або артикул товару обов'язково Код товару в системі BOX
4 code string Іднетіфікатор товару Ідентифікатор товару з вашої системи (з вашого магазину)
5 articul string Артикул товару Артикул товару з вашої системи (з вашого магазину)

Редагування товару, метод: /api/product/update/

Параметри
Поле Тип Опис Обов'язкове чи ні Коментар
1 login string Логін в системі BOX Обов'язкове поле.  
2 password string Пароль в форматі md5 Обов'язкове поле. Напишіть в техпідтримку і ми видамо вам hash для API
3 id integer ідентифікатори товару Або id або code або артикул товару обов'язково Код товару в системі BOX
4 code string Іднетіфікатор товару Ідентифікатор товару з вашої системи (з вашого магазину)
5 articul string Артикул товару Артикул товару з вашої системи (з вашого магазину)
6 name string ім'я товару Обов'язкове поле.  
7 description string Опис товару Не обов'язкове поле.  
9 name+language_code string Ім'я товару (на інших мовах) Не обов'язкове поле. Ключ потрібно вказувати з Двосимвольні кодом іншої мови,
який підключений в модулі багатомовності,
наприклад nameua, nameen
10 description+language_code string Опис товару (на інших мовах) Не обов'язкове поле. Ключ потрібно вказувати з Двосимвольні кодом іншої мови,
який підключений в модулі багатомовності,
наприклад descriptionua, descriptionen
11 price decimal ціна товару Не обов'язкове поле.  
12 pricebase decimal Базова ціна товару Не обов'язкове поле.  
13 currencyname string Назва валюти Не обов'язкове поле.  
14 categorycode string id категорії з вашої системи Не обов'язкове поле. Це унікальний ідентифікатор категорії з вашої системи (з вашого магазину). Якщо категорія з таким id існує - API видасть помилку
15 categoryid integrer id Категорії Не обов'язкове поле. Код категорії в системі BOX.
16 brandname string Назва бренду Не обов'язкове поле. Якщо такого бренду немає, то движок самостійно його створить
17 unit string Одиниці виміру Не обов'язкове поле.  
18 avail boolean Наявність товару Не обов'язкове поле. За замовчуванням, товару немає в наявності (avail = 0)
19 hidden boolean Прихований продукт Не обов'язкове поле. За замовчуванням, товару не прихований (hidden = 0)
20 model string Модельний ряд товару Не обов'язкове поле.  
21 image array Масив зображень категорії Не обов'язкове поле. Зображення слід передавати масивом із зазначенням повного шляху до них. Система працює з такими форматами зображень: gif, jpeg, png, pjpeg
22 filter array (filterid, filtercode1c, filtervalue, filteractual, filteruse, filteroption) Масив фільтрів для товара Не обов'язкове поле.
filterid - id фільтра для товару з BOX
filtercode1c - Зовнішній id фільтра для товару з BOX, при наявності даного параметра пошук фільтра буде здійснюватися по ньому, а не по filterid
filtervalue - значення фільтра
filteractual - висновок значення цієї характеристики в таблиці характеристик продукту. За замовчуванням, не є (filteractual = 0)
filteruse - доступ цього фільтра при фільтрації. За замовчуванням, не є (filteruse = 0)
filteroption - опція замовлення цього товару. За замовчуванням, немає (filteroption = 0)
23 prices array (priceid, pricename, pricevalue) Масив додаткових цін для товару Не обов'язкове поле.
priceid - id ціни для товару з BOX
pricename - найменування ціни
pricevalue - значення ціни
24 taxvalue float розмір ПДВ Не обов'язкове поле.  
25 barcode string Штрихкод Не обов'язкове поле.  
26 storaged integer Кількість доступного товару Не обов'язкове поле.  
27 supplierName string Ім'я постачальника Не обов'язкове поле. Або ім'я або id постачальника повинен бути в запиті, якщо ви хочете оновити інформацію про постачальника
28 supplierid interger id постачальника Не обов'язкове поле. Або ім'я або id постачальника повинен бути в запиті, якщо ви хочете оновити інформацію про постачальника
29 suppliercode string Код постачальника товару (артикул) Не обов'язкове поле.  
30 suppliercode1c string Код постачальника товару (артикул) Не обов'язкове поле.  
31 supplierprice float Ціна постачальника Не обов'язкове поле.  
32 suppliercurrency string Валюта постачальника Не обов'язкове поле. (UAH або RUB або USD або EUR.... і тд)
33 supplieravail boolean Наявність постачальника Не обов'язкове поле. 1 - є в наявності, 0 - немає в наявності
34 supplieravailtext string Текст наявності постачальника Не обов'язкове поле. Сюди можна вказати скільки даного товару є у постачальника, або текст наявності
35 supplieractive boolean Активність постачальника Не обов'язкове поле. 1 - позиція постачальника активна, 0 - позиція не активна. За замовчуванням, позиція активна
36 supplierrrc float Ціна постачальника (ррц) Не обов'язкове поле.
37 supplierrrccurrency string Валюта постачальника (ррц) Не обов'язкове поле. (UAH або RUB або USD або EUR.... і тд)
38 suppliercurrent boolean Поточний постачальник товару Не обов'язкове поле. 1 - встановлює постачальника як поточного постачальника товару
39 divisibility float подрібнюваністю товару Не обов'язкове поле. Сюди можна вказати дробильність товару
40 syncpricesup boolean Синхронізувати ціну з постачальниками і складами Не обов'язкове поле. 1 - позиція постачальника активна, 0 - позиція не активна. За замовчуванням, позиція не активна
41 syncavailsup boolean Синхронізувати наявність з постачальниками і складами Не обов'язкове поле. 0 - товар, що не синхронізується за наявністю з постачальниками і складами
1 - товар, який синхронізується за наявністю з постачальниками і складами
42 priceold decimal Стара ціна товару Не обов'язкове поле.  
43 discount integer Знижка, % Не обов'язкове поле.  
44 categories string Додаткові категорії продукту Не обов'язкове поле. productcategoryid1 - "Категорія 1"
productcategoryid2 - "Категорія 2"
productcategoryid3 - "Категорія 3"
productcategoryid4 - "Категорія 4"
productcategoryid5 - "Категорія 5"
productcategoryid6 - "Категорія 6"
45 customfield_key mixed Додаткові поля продукту Не обов'язкове поле. Параметром слід передавати: customfield_*ключ_дополнітельного_поля*

Отримання одного товару і отримання всіх товарів, метод: /api/product/get/

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

Приклад:

http://myboxurl/api/product/get/?login=LOGIN&password=PASSWORD&id=666&customfields=true

Поле Тип Опис Обов'язкове чи ні Коментар
1 login string Логін в системі BOX Обов'язкове поле.  
2 password string Пароль в форматі md5 Обов'язкове поле. Напишіть в техпідтримку і ми видамо вам hash для API
3 id integer ідентифікатори товару в системі BOX Або id або code або артикул товару обов'язково Значення повертаються полів
id - id товару,
name - найменування,
description - опис,
image - зображення товару,
price - ціна товару,
currencyid - id валюти товару,
categoryid - id категорії в системі BOX,
brandid - id бренду в системі BOX,
articul - артикул товару,
unit - одиниці виміру,
avail - наявність товару,
hidden - прихований товар,
code1c - id товару з вашої системи (з вашого магазину),
pricebase - базова ціна товару,
supplierid - id постачальника в системі BOX,
model - модельний ряд товару,
filterArray - масив фільтрів товару,
customfieldArray - масив доп.полів товару,
analogArray - масив аналогів товару,
relatedArray - масив пов'язаних товарів,
storagedArray - масив залишків товарів,
additionalImagesArray - масив додаткових зображень продукту,
additionalFilesArray - масив додаткових файлів продукту,
cropimage - зображення товару зі зміненим розміром
4 code string Іднетіфікатор товару з вашої системи (з вашого магазину)
5 articul string Артикул товару з вашої системи (з вашого магазину)
6 customfields boolean Покажчик на необхідність передачі додаткових полів Чи не обов'язкові поля
7 related boolean Покажчик на необхідність передачі пов'язаних продуктів
8 analogs boolean Покажчик на необхідність передачі аналогів продуктів
9 storagebalances boolean Покажчик на необхідність передачі залишків продуктів
10 imageadditional boolean Покажчик на необхідність передачі додаткових зображень продуктів
11 filesadditional boolean Покажчик на необхідність передачі додаткових файлів продуктів
12 width integer Покажчик на необхідність змінити формат (width) зображення продуктів
13 height integer Покажчик на необхідність змінити формат (height) зображення продуктів


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

Приклад:

http://myboxurl/api/product/get/?login=LOGIN&password=PASSWORD&part=1&customfields=true
http://myboxurl/api/product/get/?login=LOGIN&password=PASSWORD&part=2&related=true

Поле Тип Опис Обов'язкове чи ні Коментар
1 login string Логін в системі BOX Обов'язкове поле.  
2 password string Пароль в форматі md5 Обов'язкове поле. Напишіть в техпідтримку і ми видамо вам hash для API
3 name string Назва продукту Не обов'язкове поле. Вкажіть назву і в вибірку потраплять продукти які в своїй назві містять цей параметр
4 categorycode string Код категорії з зовнішньої системи Не обов'язкове поле. Вкажіть категорію з якої ви хочете отримати товари
5 categoryid string Внутрішній код категорії Не обов'язкове поле. Вкажіть категорію з якої ви хочете отримати товари
6 brandname string Назва бренду Не обов'язкове поле. Вкажіть назву бренду товарів, за яким буде відбуватися фільтрація
7 avail boolean Наявність товару Не обов'язкове поле. Показувати тільки:
0 - товари в наявності
1 - товари, яких немає в наявності
8 hidden boolean Товар прихований Не обов'язкове поле. Показувати тільки:
0 - не приховані товари
1 - приховані товари
9 suppliered boolean В наявності у постачальника Не обов'язкове поле. Показувати тільки:
0 - товари, які не в наявності у постачальника
1 - товари, які в наявності у постачальника
10 syncpricesup boolean Синхронізувати ціну з постачальниками і складами Не обов'язкове поле. Показувати тільки:
0 - товари, що не синхронізуються за ціною з постачальниками і складами
1 - товари, які синхронізуються за ціною з постачальниками і складами
11 syncavailsup boolean Синхронізувати наявність з постачальниками і складами Не обов'язкове поле. Показувати тільки:
0 - товари, що не синхронізуються за наявністю з постачальниками і складами
1 - товари, які синхронізуються за наявністю з постачальниками і складами
12 customproduct_[key] string Додаткове поле продукту Не обов'язкове поле. Отримати продукти тільки з зазначеним значення додаткового поля продукту.
Приклад: customproduct_idkey = 123
13 part integer Частина товарів Обов'язкове поле.

API видає в 1й частини до 1000 товарів, щоб отримати такі 1000 товарів передайте туди 2 (виходить частина 2) і тд.

Значення повертаються полів
id - id товару,
name - найменування,
description - опис,
image - зображення товару,
price - ціна товару,
currencyid - id валюти товару,
categoryid - id категорії в системі BOX,
brandid - id бренду в системі BOX,
articul - артикул товару,
unit - одиниці виміру,
avail - наявність товару,
hidden - прихований товар,
code1c - id товару з вашої системи (з вашого магазину),
pricebase - базова ціна товару,
supplierid - id постачальника в системі BOX,
model - модельний ряд товару,
filterArray - масив фільтрів товару,
customfieldArray - масив доп.полів товару,
analogArray - масив аналогів товару,
relatedArray - масив пов'язаних товарів,
storagedArray - масив залишків товарів,
additionalImagesArray - масив додаткових зображень продукту,
additionalFilesArray - масив додаткових файлів продукту,
cropimage - зображення товару зі зміненим розміром

14 customfields boolean Покажчик на необхідність передачі додаткових полів Чи не обов'язкові поля
15 related boolean Покажчик на необхідність передачі пов'язаних продуктів
16 analogs boolean Покажчик на необхідність передачі аналогів продуктів
17 storagebalances boolean Покажчик на необхідність передачі залишків продуктів
18 imageadditional boolean Покажчик на необхідність передачі додаткових зображень продуктів
19 filesadditional boolean Покажчик на необхідність передачі додаткових файлів продуктів
20 width integer Покажчик на необхідність змінити формат (width) зображення продуктів
21 height integer Покажчик на необхідність змінити формат (height) зображення продуктів

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

Детальніше
Статус Повідомлення Опис повідомлення
1 ok productid Повертає id доданого / зміненого продукту
2 fail Login is empty! Відсутня логін
3 fail Password is empty! Відсутня пароль
4 fail Product name is empty! Назва продукту відсутній
5 fail Bad user level! Низький рівень користувача, для виконання даної дії (потрібен level 2 і вище)
6 fail Login or password not correct! Логін або пароль введені невірно
7 fail Product with this Code1c exist! Продукт з таким кодом відсутня
8 fail Product with this Articul exist! Продукт з таким артикулом відсутня
9 fail ID of category is not corectly! id категорії продукту не коректне
10 fail 'Code of category is not corectly!' Код категорії продукту не коректне
11 fail You don't available product for delete! Ви не обрали продукт для видалення
12 fail Product with this ID does not exists! Продукту з таким id не існує
13 fail Product with this Code does not exists! Продукту з таким кодом не існує
14 fail Product with this Articul does not exists! Продукту з таким артикулом не існує
15 fail Product with this Id does not found! Продукт з таким id не найден
16 fail Product with this Articul does not found! Продукт з таким артикулом не найден
17 fail Product with this Code does not found! Продукт з таким кодом не найден
18 fail Product name is empty! Відсутня ім'я продукту
19 fail You don't available product for update! Ви не обрали продукт для поновлення
20 fail Product not found by id/code1c/articul Продукт не найден по id / коду / артикулу
21 fail dublicate articul Продукт з таким артикулом вже існує
22 fail dublicate code1c Продукт з таким кодом вже існує

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

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, за допомогою якого браузер здійснює запит веб-сторінки