мета-данные страницы
Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия Следующая версия Следующая версия справа и слева | ||
|
commercial_api [20.02.2024 14:53] Anatoly |
commercial_api [24.04.2024 13:54] Anatoly |
||
|---|---|---|---|
| Строка 3: | Строка 3: | ||
| ==== Описание API ==== | ==== Описание API ==== | ||
| - | %%API%% позволяет реализовать создание и редактирование заказов, добавление оплаты в заказ, создание и изменение клиентов, получение изменившихся заказов и клиентов и др. | + | %%API%% позволяет реализовать создание и редактирование заказов, добавление оплаты в заказ, создание и изменение клиентов, получение изменившихся заказов и клиентов и др. |
| ---- | ---- | ||
| ==== Схема работы API ==== | ==== Схема работы API ==== | ||
| {{:работа_api.drawio.png?direct&600 |}}\\ | {{:работа_api.drawio.png?direct&600 |}}\\ | ||
| - | + | ---- | |
| - | === Формат команд === | + | ==== Формат команд ==== |
| - | Все значения параметров команд должны быть преобразованы, **через js encodeURIComponent или подобные функции**. | + | Все значения параметров команд должны быть преобразованы, **через js encodeURIComponent, через php urlencode или подобные функции**. |
| **Пример:** | **Пример:** | ||
| Строка 66: | Строка 66: | ||
| ---- | ---- | ||
| ==== Работа с заказами ==== | ==== Работа с заказами ==== | ||
| - | |||
| [[#Сохранение заказа. SaveOrderForAll|Сохранение заказа. SaveOrderForAll]]\\ | [[#Сохранение заказа. SaveOrderForAll|Сохранение заказа. SaveOrderForAll]]\\ | ||
| [[#Изменение заказа. UpdateOrderForAll|Изменение заказа. UpdateOrderForAll]]\\ | [[#Изменение заказа. UpdateOrderForAll|Изменение заказа. UpdateOrderForAll]]\\ | ||
| Строка 76: | Строка 75: | ||
| [[#Квитанция. ReceiptOnline|Квитанция. ReceiptOnline]]\\ | [[#Квитанция. ReceiptOnline|Квитанция. ReceiptOnline]]\\ | ||
| [[#Список заказов за период. OrdersBetweenForAll|Список заказов за период. OrdersBetweenForAll]]\\ | [[#Список заказов за период. OrdersBetweenForAll|Список заказов за период. OrdersBetweenForAll]]\\ | ||
| + | [[api#фотографии_по_заказу_photoonline|Фотографии по заказу. PhotoOnline]]. | ||
| ---- | ---- | ||
| ==== Работа с услугами ==== | ==== Работа с услугами ==== | ||
| Строка 1279: | Строка 1278: | ||
| //doc_date// – дата принятия заказа (формат dd.mm.yyyy), **не обязательный параметр**;\\ | //doc_date// – дата принятия заказа (формат dd.mm.yyyy), **не обязательный параметр**;\\ | ||
| //fast_exec// – ID срочности, **не обязательный параметр**. Берется из команды GetListsOrderTNDForAll, массив строк order_times;\\ | //fast_exec// – ID срочности, **не обязательный параметр**. Берется из команды GetListsOrderTNDForAll, массив строк order_times;\\ | ||
| + | <ifauth @user> | ||
| + | "creater_id": "1234",<- перенести выше в пример в порядке следования описания, убрав отсюда\\ | ||
| + | //creater_id// - ID приемщика заказа, **не обязательный параметр**. По умолчанию используется ID авторизованного пользователя;\\ | ||
| + | </ifauth> | ||
| //sclad_id// – ID склада принятия, **обязательный параметр**;\\ | //sclad_id// – ID склада принятия, **обязательный параметр**;\\ | ||
| //sclad_out_id// – ID склада выдачи, **обязательный параметр**;\\ | //sclad_out_id// – ID склада выдачи, **обязательный параметр**;\\ | ||
| + | <ifauth @user> | ||
| + | "current_sclad_id": "1234",<- перенести выше в пример в порядке следования описания, убрав отсюда\\ | ||
| + | //current_sclad_id// - ID текущего склада заказа, **не обязательный параметр**. По умолчанию используется ID склада принятия заказа;\\ | ||
| + | </ifauth> | ||
| //price_id// – ID прайс-листа, **не обязательный параметр**. По умолчанию 0 - "Розничный прайс лист";\\ | //price_id// – ID прайс-листа, **не обязательный параметр**. По умолчанию 0 - "Розничный прайс лист";\\ | ||
| //date_out// – дата выдачи (формат dd.mm.yyyy HH:MM:SS), **не обязательный параметр**;\\ | //date_out// – дата выдачи (формат dd.mm.yyyy HH:MM:SS), **не обязательный параметр**;\\ | ||
| Строка 1321: | Строка 1328: | ||
| //dirty_id// – ID наценки, **не обязательный параметр**. Берется из команды GetListsOrderTNDForAll, массив строк order_dirties;\\ | //dirty_id// – ID наценки, **не обязательный параметр**. Берется из команды GetListsOrderTNDForAll, массив строк order_dirties;\\ | ||
| //status_id// – ID статус услуги, **не обязательный параметр**. Принимает значения 1 – новый, 3 – в исполнении, 4 – исполненный, 5 – выданный, 7 - отмененный; | //status_id// – ID статус услуги, **не обязательный параметр**. Принимает значения 1 – новый, 3 – в исполнении, 4 – исполненный, 5 – выданный, 7 - отмененный; | ||
| + | <ifauth @user> | ||
| + | "current_sclad_id": "1234",<- перенести выше в пример в порядке следования описания, убрав отсюда\\ | ||
| + | //current_sclad_id// - ID текущего склада услуги, **не обязательный параметр**. По умолчанию используется ID склада принятия заказа;\\ | ||
| + | </ifauth> | ||
| **addons** – массив объектов доп. реквизитов (**обязательный параметр**, если не реквизитов для заполнения, указывается пустым []):\\ | **addons** – массив объектов доп. реквизитов (**обязательный параметр**, если не реквизитов для заполнения, указывается пустым []):\\ | ||
| Строка 1554: | Строка 1565: | ||
| //sclad_id// – ID склада принятия, **не обязательный параметр**;\\ | //sclad_id// – ID склада принятия, **не обязательный параметр**;\\ | ||
| //sclad_out_id// – ID склада выдачи, **не обязательный параметр**;\\ | //sclad_out_id// – ID склада выдачи, **не обязательный параметр**;\\ | ||
| + | <ifauth @user> | ||
| + | "current_sclad_id": "1234",<- перенести выше в пример в порядке следования описания, убрав отсюда\\ | ||
| + | //current_sclad_id// - ID текущего склада заказа, **не обязательный параметр**. По умолчанию используется ID склада принятия заказа;\\ | ||
| + | </ifauth> | ||
| //price_id// – ID прайс-листа, **не обязательный параметр**;\\ | //price_id// – ID прайс-листа, **не обязательный параметр**;\\ | ||
| //date_out// – дата выдачи (формат dd.mm.yyyy HH:MM:SS), **не обязательный параметр**;\\ | //date_out// – дата выдачи (формат dd.mm.yyyy HH:MM:SS), **не обязательный параметр**;\\ | ||
| Строка 1600: | Строка 1615: | ||
| //dirty_id// – ID наценки, **не обязательный параметр параметр**. Берется из команды GetListsOrderTNDForAll, массив строк order_dirties;\\ | //dirty_id// – ID наценки, **не обязательный параметр параметр**. Берется из команды GetListsOrderTNDForAll, массив строк order_dirties;\\ | ||
| //status_id// – ID статус услуги, **не обязательный параметр**. Принимает значение 1 – новый, 3 – в исполнении, 4 – исполненный, 5 – выданный, 7 - отмененный;\\ | //status_id// – ID статус услуги, **не обязательный параметр**. Принимает значение 1 – новый, 3 – в исполнении, 4 – исполненный, 5 – выданный, 7 - отмененный;\\ | ||
| + | <ifauth @user> | ||
| + | "current_sclad_id": "1234",<- перенести выше в пример в порядке следования описания, убрав отсюда\\ | ||
| + | //current_sclad_id// - ID текущего склада услуги, **не обязательный параметр**. По умолчанию используется ID склада принятия заказа;\\ | ||
| + | </ifauth> | ||
| **addons** – массив объектов доп. реквизитов (**обязательный параметр**, если нет реквизитов на изменение, то оставляется пустым []):\\ | **addons** – массив объектов доп. реквизитов (**обязательный параметр**, если нет реквизитов на изменение, то оставляется пустым []):\\ | ||
| Строка 3092: | Строка 3111: | ||
| **Устаревшая команда**. Команда просмотра фотографий заказа.\\ | **Устаревшая команда**. Команда просмотра фотографий заказа.\\ | ||
| Для просмотра списка фотографий, рекомендуется использовать актуальную команду [[api#фотографии_по_заказу_orderimagesmodern|OrderImagesModern]]. | Для просмотра списка фотографий, рекомендуется использовать актуальную команду [[api#фотографии_по_заказу_orderimagesmodern|OrderImagesModern]]. | ||
| + | |||
| + | Для получения самой фотографии, используется команда [[api#фотографии_по_заказу_photoonline|PhotoOnline]]. | ||
| Метод отправки: **GET** | Метод отправки: **GET** | ||