мета-данные страницы
Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
commercial_api [17.04.2024 11:48] Anatoly [Сохранение заказа. SaveOrderForAll] |
commercial_api [27.04.2024 11:07] (текущий) Anatoly [Создание выезда. TripOrder] |
||
|---|---|---|---|
| Строка 3: | Строка 3: | ||
| ==== Описание API ==== | ==== Описание API ==== | ||
| - | %%API%% позволяет реализовать создание и редактирование заказов, добавление оплаты в заказ, создание и изменение клиентов, получение изменившихся заказов и клиентов и др. | + | %%API%% позволяет реализовать создание и редактирование заказов, добавление оплаты в заказ, создание и изменение клиентов, получение изменившихся заказов и клиентов и др. |
| ---- | ---- | ||
| ==== Схема работы API ==== | ==== Схема работы API ==== | ||
| {{:работа_api.drawio.png?direct&600 |}}\\ | {{:работа_api.drawio.png?direct&600 |}}\\ | ||
| - | + | ---- | |
| - | === Формат команд === | + | ==== Формат команд ==== |
| - | Все значения параметров команд должны быть преобразованы, **через js encodeURIComponent или подобные функции**. | + | Все значения параметров команд должны быть преобразованы, **через js encodeURIComponent, через php urlencode или подобные функции**. |
| **Пример:** | **Пример:** | ||
| Строка 1279: | Строка 1279: | ||
| //fast_exec// – ID срочности, **не обязательный параметр**. Берется из команды GetListsOrderTNDForAll, массив строк order_times;\\ | //fast_exec// – ID срочности, **не обязательный параметр**. Берется из команды GetListsOrderTNDForAll, массив строк order_times;\\ | ||
| <ifauth @user> | <ifauth @user> | ||
| - | "creater_id": "1234",<- добавить выше в пример. | + | "creater_id": "1234",<- перенести выше в пример в порядке следования описания, убрав отсюда\\ |
| //creater_id// - ID приемщика заказа, **не обязательный параметр**. По умолчанию используется ID авторизованного пользователя;\\ | //creater_id// - ID приемщика заказа, **не обязательный параметр**. По умолчанию используется ID авторизованного пользователя;\\ | ||
| </ifauth> | </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), **не обязательный параметр**;\\ | ||
| Строка 1324: | Строка 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** – массив объектов доп. реквизитов (**обязательный параметр**, если не реквизитов для заполнения, указывается пустым []):\\ | ||
| Строка 1557: | Строка 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), **не обязательный параметр**;\\ | ||
| Строка 1603: | Строка 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** – массив объектов доп. реквизитов (**обязательный параметр**, если нет реквизитов на изменение, то оставляется пустым []):\\ | ||
| Строка 1764: | Строка 1780: | ||
| { | { | ||
| "error":0, | "error":0, | ||
| - | "Trip":12345, | + | "TripID":12345, |
| "Msg": "%D0%97%D0%B0%D1%80%D0%B5%D0%B7%D0%B5%D1%80%D0%B2%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BE" | "Msg": "%D0%97%D0%B0%D1%80%D0%B5%D0%B7%D0%B5%D1%80%D0%B2%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BE" | ||
| } | } | ||
| Строка 2656: | Строка 2672: | ||
| //Msg// – описание ошибки (при error = 1). | //Msg// – описание ошибки (при error = 1). | ||
| ---- | ---- | ||
| + | ===== Список оплат за период. OrderPaysBetweenForAll ===== | ||
| + | **Команда:** %%OrderPaysBetweenForAll%% | ||
| + | Получения списка оплат заказов за указанный период. | ||
| + | |||
| + | Данная команда с большими периодами может долго выполнятся, из за большого количества возвращаемых данных и вылетать по timeout! Рекомендуется в таких случаях уменьшать период. | ||
| + | |||
| + | Метод отправки: **POST** | ||
| + | |||
| + | Заголовок запроса (Header): **Content-type: application/json** | ||
| + | |||
| + | Строка запроса: <code>.../api/?OrderPaysBetweenForAll</code> | ||
| + | |||
| + | Тело запроса тип **json**: | ||
| + | <sxh json> | ||
| + | { | ||
| + | "OrderPaysBetweenForAll":{ | ||
| + | "StartDate": "01.03.2018", | ||
| + | "StopDate": "30.03.2018" | ||
| + | }, | ||
| + | "SessionID": "0BE170AB-86AF-441F-8523-8C960EA3EC4E" | ||
| + | } | ||
| + | </sxh> | ||
| + | |||
| + | где\\ | ||
| + | //StartDate// – дата начала, **обязательный параметр**;\\ | ||
| + | //StopDate// – дата окончания, **обязательный параметр**. | ||
| + | |||
| + | Ответ **json** | ||
| + | <sxh json> | ||
| + | { | ||
| + | "error": 0, | ||
| + | "order_pays": [ | ||
| + | { | ||
| + | "dor_id": "102221", | ||
| + | "doc_num": "00019-2", | ||
| + | "contr_id": "10013", | ||
| + | "contr_name": "%D0%90%D0%B3%D0%B1%D0%B8%D1%81%20%D0%A2%D0%B5%D1%81%D1%82%20%D0%A2%D0%B5%D1%81%D1%82%D0%BE%D0%B2%D0%B8%D1%87", | ||
| + | "teleph_cell": "%2B79990009900", | ||
| + | "doc_date": "03.12.2021", | ||
| + | "date_out": "03.12.2021", | ||
| + | "status_id": "1", | ||
| + | "kredit": "4501", | ||
| + | "debet": "270", | ||
| + | "pay_date": "20.01.2022", | ||
| + | "pay_kassa_id": "54", | ||
| + | "doc_type": "3", | ||
| + | "pay_debet": "123", | ||
| + | "pay_kredit": "0" | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | </sxh> | ||
| + | |||
| + | где\\ | ||
| + | **order_pays** – массив оплат:\\ | ||
| + | //dor_id// – ID заказа;\\ | ||
| + | //doc_num// – номер заказа;\\ | ||
| + | //contr_id// – ID клиента;\\ | ||
| + | //contr_name// – ФИО клиента;\\ | ||
| + | //teleph_cell// – номер телефона;\\ | ||
| + | //doc_date// – дата приема заказа;\\ | ||
| + | //date_out// - дата выдачи заказа;\\ | ||
| + | //status_id// – ID статуса заказа (1 – новый, 3 – в исполнении, 4 – исполненный, 5 – выданный, 7 - отмененный);\\ | ||
| + | //kredit// – сумма заказа;\\ | ||
| + | //debet// – полная сумма оплаты заказа;\\ | ||
| + | //pay_date// – дата платежа;\\ | ||
| + | //pay_kassa_id// – ID кассы платежа;\\ | ||
| + | //doc_type// – тип платежа (3 - Кассовый документ, 4 - Банковский документ, 9 - Оплата банковской картой, 31 - Кассовый чек (оплата покупателем), 32 - Кассовый чек (возврат денег покупателю), | ||
| + | 91 – Бонус, 92 - Оплата депозитом);\\ | ||
| + | //pay_debet// – сумма прихода платежа;\\ | ||
| + | //pay_kredit// – сумма возврата платежа. | ||
| + | ---- | ||
| ====== Статистическая информация ====== | ====== Статистическая информация ====== | ||