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 suppliercurrent boolean Текущий поставщик товара Не обязательное поле. 1 - устанавливает поставщика как текущего поставщика товара
39 categories string Дополнительные категории продукта Не обязательное поле. productcategoryid1 - "Категория 1"
productcategoryid2 - "Категория 2"
productcategoryid3 - "Категория 3"
productcategoryid4 - "Категория 4"
productcategoryid5 - "Категория 5"
productcategoryid6 - "Категория 6"
40 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 suppliercurrent boolean Текущий поставщик товара Не обязательное поле. 1 - устанавливает поставщика как текущего поставщика товара
37 divisibility float Дробимость товара Не обязательное поле. Сюда можно указать дробимость товара
38 syncpricesup boolean Синхронизировать цену с поставщиками и складами Не обязательное поле. 1 - позиция поставщика активна, 0 - позиция не активна. По умолчанию, позиция не активна
39 syncavailsup boolean Синхронизировать наличие с поставщиками и складами Не обязательное поле. 0 - товар, который не синхронизируется по наличию с поставщиками и складами
1 - товар, который синхронизируется по наличию с поставщиками и складами
40 priceold decimal Старая цена товара Не обязательное поле.  
41 discount integer Скидка, % Не обязательное поле.  
42 categories string Дополнительные категории продукта Не обязательное поле. productcategoryid1 - "Категория 1"
productcategoryid2 - "Категория 2"
productcategoryid3 - "Категория 3"
productcategoryid4 - "Категория 4"
productcategoryid5 - "Категория 5"
productcategoryid6 - "Категория 6"
43 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, с помощью которого браузер осуществляет запрос веб-страницы