Зачем это нужно клиентам? Как правило это всего несколько вещей – передать заказ, товар, категории, бренды в BOX. Для этого используется несколько методов. Подробнее ниже
№ | Поле | Тип | Описание | Обязательное или нет | Коментарий |
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 | Дата заказа | Не обязательное поле. | Дата создания заказа, должна быть в формате (Y-m-d 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 и тд..)
|
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} нужно подставлять ключ дополнительного поля с заказа | |
37 | customuser_{key} | string | Custom-е поле клиента | Вместо {key} нужно подставлять ключ дополнительного поля с карточки контакта | |
38 | dateto | datetime | Дата запланирования заказа(задачи) | Не обязательное поле. | Дата запланирования заказа, должна быть в формате (Y-m-d 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 | Юридическое лицо заказа/td> | Не обязательное поле. | |
44 | paymentid | integer | ID способа оплаты/td> | Не обязательное поле. | id способа оплаты из системы OneBox |
45 | paymentname | string | Имя способа оплаты/td> | Не обязательное поле. | Если указать данный параметр, то система попытается найти данный способ оплаты в OneBox и поднятнуть его |
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
№ | Поле | Тип | Описание | Обязательное или нет | Коментарий |
1 | login | string | Логин в системе BOX | Обязательное поле. | |
2 | password | string | Пароль в формате md5 | Обязательное поле. | Напишите в техподдержку и мы выдадим вам hash для API |
3 | orderid | string | Иднетификатор заказа | Обязательное поле. | В это поле вы можете передать либо id заказа которое вернуло вам наше API при его создании. Или же передать туда внешный идентификатор заказа (поле ordercode при создании заказа) Движок сам найдёт этот заказ и удалит его. |
Пример:
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 при создании заказа) Движок сам найдёт этот заказ. |
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 | Добавить товары в заказ | Не обязательное поле. | Вы можете добавить товары уже в существующий заказ. При этом его сумма автоматически пересчитается |
12 | workflowid | integer | Id Бизнес процесса заказа | Не обязательное поле. | Вы можете через API изменить БП заказа на другой |
13 | statusid | integer | Id статуса по данному БП | Не обязательное поле. | Задать другой статус по id |
14 | deleteproducts | 0/1 | Удалить товары из заказа | Не обязательное поле. | Если 1 - удаляет все товары в редактируемом заказе |
Пример:
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 при создании заказа) Движок сам найдёт этот вёрнёт его. Значения возвращаемых полей orderid - id заказа ordercode - внешний id заказа, ordername - Имя заказа, clientid - id клиента в системе BOX, clientname - имя клиента, clientemail - email клиента, clientphone - телефон клиента, clientaddress - адрес клиента, managerid - id менеджера заказа, cdate - дата заказа, deliveriID - id способа доставки, deliverinote - комментарии доставки, deliveriprice - стоимость доставки, sum - сумма заказа, sumbase - базовая сумма заказа, currency - валюта заказа, statusname - статус заказа, workflowname - имя БП заказа, products - массив продуктов из заказа, состоит из:
|
Пример:
http://myboxurl/api/orders/get/?login=LOGIN&password=PASSWORD&orderid=7927
№ | Поле | Тип | Описание | Обязательное или нет | Коментарий |
---|---|---|---|---|---|
1 | login | string | Логин в системе BOX | Обязательное поле. | |
2 | password | string | Пароль в формате md5 | Обязательное поле. | Напишите в техподдержку и мы выдадим вам hash для API |
3 | workflowname | string | Имя Бизнес процесса для заказов | Не обязательное поле. | Укажите имя Бизнес процесса по которому вы хотите отфильтровать заказы/задачи/проекты |
4 | workflowid | string | ID Бизнес процесса | Не обязательное поле. | Укажите id Бизнес процесса по которому вы хотите отфильтровать заказы/задачи/проекты. Если вы указываете БП то проверьте чтобы он обязательно был создан в вашем OneBox. |
5 | type | string | Тип БП | Не обязательное поле. | Укажите тип Бизнес процесса, что бы отфильтровать заказы/задачи/проекты с заданным типом |
6 | statusname | string | Статус заказа | Не обязательное поле. | Укажите имя статуса БП по которому вы хотите отфильтровать заказы/задачи/проекты. |
7 | statusid | string | ID Статусa заказа | Не обязательное поле. | Укажите ID статуса БП по которому вы хотите отфильтровать заказы/задачи/проекты. |
8 | cdate | date | Дата создания заказа | Не обязательное поле. | Укажите дату создания и в итоговую выборку попадут только те заказы, у которые дата создания больше или равно заданной |
9 | udate | date | Дата и время последнего обновления заказа | Не обязательное поле. | УУкажите дату последнего обновления и в итоговую выборку попадут только те заказы, в которых дата последнего изменение больше или равно заданной |
10 | part | integer | Часть заказов | Обязательное поле. | API выдаёт в 1й части до 1000 заказов, чтобы получить следующие 1000 заказов передайте туда 2 (получается часть 2) и тд. Значения возвращаемых полей orderid - id заказа ordernumber - номер заказа ordercode - внешний id заказа, ordername - Имя заказа, clientid - id клиента в системе BOX, clientname - имя клиента, clientemail - email клиента, clientphone - телефон клиента, clientaddress - адрес клиента, managerid - id менеджера заказа, cdate - дата заказа, deliveriID - id способа доставки, deliverinote - комментарии доставки, deliveriprice - стоимость доставки, sum - сумма заказа, sumbase - базовая сумма заказа, currency - валюта заказа, statusname - статус заказа, workflowname - имя БП заказа, products - массив продуктов из заказа, состоит из:
|
Пример:
http://myboxurl/api/orders/get/?login=LOGIN&password=PASSWORD&part=1
http://myboxurl/api/orders/get/?login=LOGIN&password=PASSWORD&part=2
и тд..
№ | Статус | Сообщение | Описание сообщения |
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 | Телефон и почта клиента отсутствуют |