мета-данные страницы
3. Команды API ТОЛЬКО с пользовательской сессией
Команды получения данных, для выполнения которых Требуется пользовательская сессия.
Справочная информация
Списки ВДС и ДС. GetListsVdsDsForAll
Списки срочности, виды детской одежды и наценки. GetListsOrderTNDForAll
Работа с клиентами
Информация по клиенту. ContrInfoForAll
Информации по клиенту. ContragInfoForAll
Список бонусов клиента за период. BonusesBetweenForAll
Работа с заказами
Работа с накладными
Статистическая информация
Список заказов, измененных в указанный промежуток времени. OrderByDateTimeForAll
Список клиентов измененных в указанный промежуток времени. ClientsByDateTimeForAll
Список оплат за период. OrderPaysBetweenForAll
Устаревшие команды
Получение фотографий услуг. GetOrderImagesForAll
GetListsVdsDsForAll
Команда: GetListsVdsDsForAll
Получение списков активных Внешних дисконтных схем (ВДС) и дисконтных схем (ДС), которые доступны для всех клиентов.
Метод отправки: GET
Заголовок запроса (Header): не требуется.
Формат запроса:
GetListsVdsDsForAll&SessionID=
Строка запроса:
GET .../api/?GetListsVdsDsForAll&SessionID=...
Ответ json:
{
"error": 0,
"vds": [
{
"id": "100100100183",
"title": "100100100183",
"type_of_scheme": "0",
"type_of_action": "0",
"comment": "",
"is_active": "1",
"type_of_zeroing": "0",
"forbid_reuse": "0",
"block_used_bar": "0",
"action_time": "3",
"active_with": "",
"active_to": "",
"condition_id": "1",
"summ_discount": "0",
"is_add_bonus_ones": "0",
"bonus_end_dt": "",
"bonus_active_before": "",
"bonus_day_active": "",
"max_percent_in_zakaz": "",
"select_vds_id": "",
"bonus_one_time": "0",
"bonus_tp": "0",
"bonus_summ": "",
"is_for_sclads": "1",
"discount": "0",
"is_disc_for_folders": "1",
"is_for_tovar": "1",
"active_times": [
{
"day_of_week": "2",
"is_active": "1",
"time_first": "00%3A00%3A00",
"time_last": "23%3A59%3A00"
},
{
"day_of_week": "3",
"is_active": "1",
"time_first": "00%3A00%3A00",
"time_last": "23%3A59%3A00"
},
{
"day_of_week": "4",
"is_active": "1",
"time_first": "00%3A00%3A00",
"time_last": "23%3A59%3A00"
},
{
"day_of_week": "5",
"is_active": "1",
"time_first": "00%3A00%3A00",
"time_last": "23%3A59%3A00"
},
{
"day_of_week": "6",
"is_active": "1",
"time_first": "00%3A00%3A00",
"time_last": "23%3A59%3A00"
},
{
"day_of_week": "7",
"is_active": "1",
"time_first": "00%3A00%3A00",
"time_last": "23%3A59%3A00"
},
{
"day_of_week": "1",
"is_active": "1",
"time_first": "00%3A00%3A00",
"time_last": "23%3A59%3A00"
}
],
"sclads": ["10010","10013"],
"discounts_service_groups": [
{
"folder_id": "10015",
"parent": "",
"discount": "44"
}
],
"discounts_services": [
{
"tovar_id": "10018",
"discount": "10",
"price_before": "1000",
"price_after": "900",
"fix_price": "0"
}
],
"promo_codes": [
{
"promo_code_id": "10021",
"code": "10334",
"price_list_id": "",
"is_active": "1"
}
]
}
],
"ds": [
{
"id": "4",
"title": "3%25%20%D0%9D%D0%B0%D0%BA%D0%BE%D0%BF%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D0%BD%D0%B0%D1%8F%203-15%25"
}
]
}
где
error – статус выполнения (0 – нет ошибки, 1 – ошибка, 2 – не авторизирован, 3 - авторизация просрочена);
vds – массив строк внешних дисконтных схем:
id - ID ВДС;
title - наименование ВДС;
type_of_scheme - тип схемы ВДС (0 - Скидка, 1 - Начисление бонуса);
type_of_action - вид действия ВДС (0 - По префиксу штрих-кода в заказе, 1 -По штрихкоду в заказе, 2 - При начислении депозита);
forbid_reuse - запретить повторное использование ВДС разными клиентами;
block_used_bar - блокировать повторное использование ШК;
comment - комментарий;
is_active - активность ВДС;
type_of_zeroing - тип обнуления (0 - Не обнулять, 1 - Для всех услуг, 2 - Для тех услуг, которые участвуют);
action_time - действие ВДС (0 - Всегда, 1 - Только раз в месяц, 2 - Только раз, 3 - В период времени);
active_with - действует ВДС начиная с указанной даты, при action_time - 3;
active_to - действует ВДС заканчивая до указанной даты, при action_time - 3;
condition_id - применяется к Ко всем клиентам и заказам - 1, К клиентам, которые созданы сегодня - 2, В течение дня создания первого заказа - 3, На первый заказ - 4;
summ_discount - вид суммирования (0 - Использовать глобальные настройки, 1 - Суммировать, 2 - Не суммировать);
is_add_bonus_ones - признак начислять бонус 1 раз каждому клиенту;
bonus_end_dt - начислять бонусы до указанной даты;
bonus_active_before - начисленные бонусы действуют до указанной даты;
bonus_day_active - или действуют несколько дней с момента активации, вместо bonus_active_before;
max_percent_in_zakaz - максимальный процент оплаты заказа;
select_vds_id - оплачивать при выбранной ВДС (ID ВДС);
bonus_one_time - только разовое использование для начисленных бонусов;
bonus_tp - начислять бонус: С фиксированной суммой - 0, При выдаче заказа как процент от суммы заказа - 1, Дифференцированное начисление бонуса(цена) - 2, Дифференцированное начисление бонуса(процент) - 3, При выдаче заказа, рассчитанный по скрипту - 4;
bonus_summ - сумма бонуса;
is_for_sclads - действует только для складов;
discount - скидка по умолчанию на все группы услуг;
is_disc_for_folders - разная скидка по группам услуг;
is_for_tovar - Скидка по услугам;
active_times - массив строк времени действия:
day_of_week - день недели;
is_active - активено;
time_first - время начала;
time_last - время окончания;
sclads - Массив ID складов, где применяется ВДС;
discounts_service_groups - массив строк скидок по группам услуг:
folder_id - ID группы услуги;
parent - ID родителя группы услуги folder_id;
discount - скидка применяемая на группу услуги;
discounts_services - массив строк скидок по услугам:
tovar_id - ID услуги/товара;
discount - скидка;
fix_price - фиксированная цена;
price_before - цена до применения скидки;
price_after - цена после применения скидки;
promo_codes - массив строк промо-кодов ВДС:
promo_code_id - ID промокода;
code - промо-код;
price_list_id - ID прайс-листа промо-кода;
is_active - активность промо-кода;
ds – массив строк дисконтных схем:
id - ID ДС;
title - наименование ДС.
GetListsOrderTNDForAll
Команда: GetListsOrderTNDForAll
Получение всех списков срочности, видов детской одежды и наценки.
Метод отправки: GET
Заголовок запроса (Header): не требуется.
Формат запроса:
GetListsOrderTNDForAll&SessionID=
Строка запроса:
GET .../api/?GetListsOrderTNDForAll&SessionID=...
где
SessionID - Сессия, обязательный параметр.
Ответ json:
{
"error": 0,
"order_dirties": [
{
"id": "1001",
"name": " %D0%9E%D1%87%D0%B5%D0%BD%D1%8C%20%D1%81%D0%B8%D0%BB%D1%8C%D0%BD%D0%B0%D1%8F%20%D0%B7%D0%B0%D0%B3%D1%80%D1%8F%D0%B7%D0%BD%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D1%8C"
},
{
"id": "1005",
"name": "%D0%A1%D0%B8%D0%BB%D1%8C%D0%BD%D0%B0%D1%8F%20%D0%B7%D0%B0%D0%B3%D1%80%D1%8F%D0%B7%D0%BD%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D1%8C"
}
],
"order_nurseries": [
{
"id": "1001",
"name": "%D0%94%D0%B5%D1%82%D1%81%D0%BA%D0%B0%D1%8F"
},
{
"id": "1002",
"name": "%D0%9D%D0%B5%20%D0%B4%D0%B5%D1%82%D1%81%D0%BA%D0%B0%D1%8F"
}
]
"order_times": [
{
"id": "1002",
"name": "%D0%9D%D0%B5%20%D1%81%D1%80%D0%BE%D1%87%D0%BD%D1%8B%D0%B9"
},
{
"id": "1004",
"name": "%D0%A1%D1%80%D0%BE%D1%87%D0%BD%D1%8B%D0%B9%2024%20%D1%87%D0%B0%D1%81%D0%B0"
}
]
}
гдеerror – статус выполнения (0 – нет ошибки, 1 – ошибка, 2 – не авторизирован, 3 - авторизация просрочена);
order_dirties – массив строк наценки услуг;
order_nurseries – массив строк видов детской одежды для услуг;
order_times – массив строк типов срочности заказа;
Msg – описание ошибки (при error = 1).
ContrInfoForAll
Команда: ContrInfoForAll
Получение информации по клиенту.
Метод отправки: GET
Заголовок запроса (Header): не требуется.
Формат запроса:
ContrInfoForAll={"contr_id":"12345"}&SessionID=
Строка запроса:
GET .../api/?ContrInfoForAll=%7B%22contr_id%22:%2212345%22%7D&SessionID=...
где
contr_id – ID клиента, обязательный параметр.
Ответ json:
{
"error": 0,
"png": "EB831E9B-472E-4D30-9AAF-20296E6D0017",
"dor_id": "12345",
"contr_id":"10013",
"name":"%D0%90%D0%B3%D0%B1%D0%B8%D1%81+%D0%A2%D0%B5%D1%81%D1%82+%D0%A2%D0%B5%D1%81%D1%82%D0%BE%D0%B2%D0%B8%D1%87","short_name":"%D0%90%D0%B3%D0%B1%D0%B8%D1%81",
"fone":"",
"fone_cell":"%2B79990009900",
"email":"test@test.com",
"folder_id": "24",
"agree_to_receive_sms":"1",
"agree_to_receive_adv_sms":"1",
"address":"%D0%9D%D0%BE%D0%B2%D0%BE%D0%BA%D1%83%D0%B7%D0%BD%D0%B5%D1%86%D0%BA,+123-+4",
"barcode":"1600000100138",
"discount":"0",
"scheme_id": "",
"discount_scheme_name": "",
"is_family": "0",
"gender":"0",
"sp":"2",
"source":"",
"last_discount":"15",
"region_id":"",
"full_orders_cost":"693942,49",
"order_not_pay":"72",
"order_count":"114",
"deposit":"0",
"bonus":"1237,75",
"dolg":"520504,4",
"promo_code":"P2HZ3",
"lng":"RU",
"need_confirm_contract":"0",
"version_contract":"0",
"birth_day":"01.10.1974",
"addresses":[],
"date_last_ds": "28.06.2022 13:52:08"
}
Где
error - успешность выполнения команды;
contr_id – ID клиента;
name - имя клиента;
fone - обычный телефон;
fone_cell - сотовый телефон;
email - электронная почта;
folder_id - ID группы клиента;
address - адрес клиента;
agree_to_receive_sms - согласен получать СМС о готовности заказов;
agree_to_receive_adv_sms - согласен получать рекламные и поздравительные СМС;
barcode - номер карточки клиента;
discount - процент скидки клиента;
scheme_id - ID дисконтной схемы;
discount_scheme_name - Наименование дисконтной схемы;
is_family - признак семейная скидка;
source - любой текст;
agree_save_card_pay – согласие клиента на сохранение карты оплаты;
birth_day – дата рождения;
bonus – остаток бонуса клиента;
deposit – остаток депозита клиента;
dolg – сумма долга клиента;
gender – пол клиента (0-мужской, 1-женский);
order_count – количество заказов;
order_not_pay – количество не оплаченных заказов;
promo_code – используемый промо-код;
region_id – район;
sp – тип клиента (1- организация, 2- физическое лицо);
date_last_ds - дата присвоения последней ДС.
ContragInfoForAll
Команда: ContragInfoForAll
Получение информации о клиенте по телефону.
Метод отправки: GET
Заголовок запроса (Header): не требуется.
Формат запроса:
ContragInfoForAll={"teleph_cell":"+79990009900"}&SessionID=
Строка запроса:
GET .../api/?ContragInfoForAll=%7B%22teleph_cell%22%3A%22%2B79990009900%22%7D&SessionID=...
где
teleph_cell - номер телефона, обязательный параметр.
Ответ json:
{
"error": 0,
"contr_id": "10057",
"fullname": "%D0%A2%D0%B5%D1%81%D1%82+%D0%90%D0%9C%D0%9E+%D0%9A%D0%BE%D0%BD%D1%82%D1%80%D0%B0%D1%81%D1%82",
"name": "%D0%A2%D0%B5%D1%81%D1%82+%D0%90%D0%9C%D0%9E",
"teleph_cell": "%2B79990009917",
"email": "example@example.com",
"folder_id": "24",
"address": "%D1%82%D0%B5%D1%81%D1%82+1",
"barcode": "778855522212",
"discount": "23,4",
"gender": "1",
"birthday": "15.02.1980"
}
где
contr_id – ID клиента;
name – короткое имя;
fullname – полное имя;
teleph_cell – сотовый телефон (обязательно в начале должен присутствовать символ +, кодируется символами - %2B);
barcode – номер дисконтной карты;
gender – пол клиента (0-мужской, 1-женский);
address – адрес;
email – электронная почта;
folder_id - ID группы клиента;
discount - скидка(разделитель запятая);
birthday – день рождения (формат dd.mm.yyyy);
SessionID – ID сессии.
BonusesBetweenForAll
Команда: BonusesBetweenForAll
Получение списка бонусов клиента в указанный промежуток времени.
Данная команда с большими периодами может долго выполнятся, из за большого количества возвращаемых данных и вылетать по timeout! Рекомендуется в таких случаях уменьшать период.
Метод отправки: POST
Заголовок запроса (Header):
Content-type: application/json; charset=UTF-8 - обязательный параметр
Accept-Encoding: deflate - сжатие возвращаемого ответа, не обязательный параметр.
Строка запроса:
POST .../api/?BonusesBetweenForAll
Тело запроса тип json:
{
"BonusesBetweenForAll":{
"contr_id": "10013",
"StartDate": "01.03.2021",
"StopDate": "30.03.2021"
},
"SessionID": "0BE170AB-86AF-441F-8523-8C960EA3EC4E"
}
где
contr_id - ID клиента;
StartDate – дата начала, обязательный параметр;
StopDate – дата окончания, обязательный параметр.
Ответ json:
{
"error": 0,
"bonuses": [
{
"bonus_id": "100624",
"parent_bonus_id": "",
"doc_date": "03.03.2021",
"doc_time": "11:47:36",
"kredit": "150",
"already_payed": "10",
"bonus_rest": "140",
"active_before": "",
"max_percent_in_zakaz": "",
"one_time": "0",
"comment": "",
"bonus_type_id": "1001",
"bonus_type_name": "1222"
}
],
"bonus_payments": [
{
"id": "100604",
"bonus_id": "100624",
"doc_date": "23.03.2021",
"doc_time": "11:10:21",
"debet": "10",
"dor_id": "1001490",
"doc_num": "000124"
}
]
}
где
bonuses – массив объектов начислений бонусов;
bonus_id - ID бонуса;
parent_bonus_id - ID родительского бонуса, в связке c bonus_id;
doc_date - Дата начисления бонусов;
doc_time - Время начисления бонусов;
kredit - Сумма начисления бонуса;
already_payed - Потрачено бонуса;
bonus_rest - Остаток бонуса;
active_before - Дата до которой действуют бонусы;
max_percent_in_zakaz - Максимальный процент оплаты бонусами;
one_time - Признак только разовое использование;
comment - Комментарий;
bonus_type_id - ID типа бонусного начисления;
bonus_type_name - Наименование типа бонусного начисления;
bonus_payments – массив объектов оплат бонусами;
id - ID оплаты бонусом;
bonus_id - ID бонуса, которым оплачивали;
doc_date - Дата оплаты бонусом;
doc_time - Время оплаты бонусом;
debet - Сумма оплаты бонусом;
dor_id - ID заказа;
doc_num - номер заказа.
OrderInfoForAll
Команда: OrderInfoForAll
Получение информации о конкретном заказе по dor_id.
Метод отправки: GET
Заголовок запроса (Header): не требуется.
Формат запроса:
OrderInfoForAll={"dor_id":"12345"}&SessionID=
Строка запроса:
GET .../api/?OrderInfoForAll=%7B%22dor_id%22%3A%2210013%22%7D&SessionID=...
где
dor_id – ID заказа, обязательный параметр.
Ответ json:
{
"error": 0,
"order": {
"dor_id": "100182",
"doc_num": "000233",
"kredit": "4000",
"debet": "0",
"doc_date": "29.11.2017",
"date_out": "",
"date_out_fact": "",
"status_id": "3",
"photo_exist": "1",
"discount": "0",
"fast_execute": "0",
"sclad_id": "12455",
"sclad_to": "12455",
"current_sclad_id": "1003",
"kind_id": "3",
"vds_id": "1001",
"contr_id": "10013",
"waiting_confirm": "0",
"is_not_confirmed": "0",
"sclad_name": "",
"sclad_adr": "",
"sclad_hours": "",
"condition_id": "",
"condition_name": "",
"Srvices": [
{
"dos_id": "100229858",
"parent_id": "100229857",
"tov_id": "10018",
"service": "%D0%91%D0%B5%D1%80%D0%BC%D1%83%D0%B4%D1%8B",
"code": "01.18",
"status_id": "3",
"status_name": "%D0%92+%D0%B8%D1%81%D0%BF%D0%BE%D0%BB%D0%BD%D0%B5%D0%BD%D0%B8%D0%B8",
"serv_num": "1",
"barcode": "272102000000071001",
"barcode_read": "%5B2%5D%207%20(1)",
"price": "1000",
"qty": "1",
"kfx": "1",
"discount": "0",
"nursery_id": "0",
"nurseries_name": "%D0%9D%D0%B5+%D0%B4%D0%B5%D1%82%D1%81%D0%BA%D0%B0%D1%8F",
"nurseries_discount": "0",
"serv_weight": "1",
"dirty_id": "0",
"dirty_name": "%D0%9E%D0%B1%D1%89%D0%B5%D0%B5",
"dirty_kfx": "1",
"kredit": "1000",
"ext_info": "",
"shop_description": "",
"group_tov": "1.+%D0%A2%D0%B5%D0%BA%D1%81%D1%82%D0%B8%D0%BB%D1%8C%D0%BD%D0%BE-%D1%82%D1%80%D0%B8%D0%BA%D0%BE%D1%82%D0%B0%D0%B6%D0%BD%D0%B0%D1%8F+%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D0%B0",
"contr_provider_id": "10072",
"contr_provider_name": "%D0%9F%D0%BE%D0%B4%20%D0%BE%D0%B3%D1%80%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F",
"contr_provider_inn": "1234-1234-1234-1234",
"nds_name": "%D0%91%D0%B5%D0%B7%20%D0%9D%D0%94%D0%A1",
"addons": []
},
{
"dos_id": "100229859",
"tov_id": "10027",
"service": "%D0%92%D0%BE%D0%B4%D0%BE%D0%BB%D0%B0%D0%B7%D0%BA%D0%B0",
"code": "01.27",
"status_id": "3",
"status_name": "%D0%92+%D0%B8%D1%81%D0%BF%D0%BE%D0%BB%D0%BD%D0%B5%D0%BD%D0%B8%D0%B8",
"barcode": "271700000002331002",
"price": "1500",
"qty": "2",
"kfx": "1",
"discount": "0",
"fast_execute": "0",
"nursery_id": "0",
"nurseries_name": "%D0%9D%D0%B5+%D0%B4%D0%B5%D1%82%D1%81%D0%BA%D0%B0%D1%8F",
"nurseries_discount": "0",
"serv_weight": "1",
"dirty_id": "0",
"dirty_name": "%D0%9E%D0%B1%D1%89%D0%B5%D0%B5",
"dirty_kfx": "1",
"kredit": "3000",
"ext_info": "",
"shop_description": "",
"group_tov": "1.+%D0%A2%D0%B5%D0%BA%D1%81%D1%82%D0%B8%D0%BB%D1%8C%D0%BD%D0%BE-%D1%82%D1%80%D0%B8%D0%BA%D0%BE%D1%82%D0%B0%D0%B6%D0%BD%D0%B0%D1%8F+%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D0%B0",
"contr_provider_id": "",
"contr_provider_name": "",
"contr_provider_inn": "",
"nds_name": "",
"addons": [
{
"addon_id": "111",
"descr": "%D0%A6%D0%B2%D0%B5%D1%82",
"value_type": "1",
"aos_id": "1001787",
"aos_value": "%D0%91%D0%B5%D0%B6%D0%B5%D0%B2%D1%8B%D0%B9,+%D0%96%D1%91%D0%BB%D1%82%D1%8B%D0%B9,+%D0%9A%D0%B0%D1%88%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D1%8B%D0%B9"
},
{
"addon_id": "239",
"descr": "%D0%A1%D0%BE%D1%81%D1%82%D0%B0%D0%B2+%D1%82%D0%BA%D0%B0%D0%BD%D0%B8",
"value_type": "1",
"aos_id": "1001788",
"aos_value": "EL+-+%D1%8D%D0%BB%D0%B0%D1%81%D1%82%D0%B0%D0%BD,+SE+-+%D1%88%D0%B5%D0%BB%D0%BA"
},
{
"addon_id": "82",
"descr": "%D0%91%D0%B5%D0%BB%D0%B5%D1%81%D0%BE%D1%81%D1%82%D1%8C",
"value_type": "2",
"aos_id": "1001789",
"aos_value": "1"
},
{
"addon_id": "181",
"descr": "%D0%94%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B5%D0%BD%D0%B8%D1%8F",
"value_type": "1",
"aos_id": "1001790",
"aos_value": "%D1%82%D0%B5%D1%81%D1%82+1"
}
]
}
],
"Tovars":[
{
"dol_id":"10043",
"tov_id":"100300",
"tovar_name":"%D0%A2%D0%BE%D0%B2%D0%B0%D1%80%20%D1%81%D0%BE%D0%BF%D1%83%D1%81%D1%82%D0%B2%D1%83%D1%8E%D1%89%D0%B8%D0%B9",
"code":"0",
"group_tov":"%D0%A2%D0%BE%D0%B2%D0%B0%D1%80%D1%8B",
"barcode":"",
"price":"5",
"qty":"1",
"kfx":"1",
"discount":"5",
"kredit":"4,75",
"ext_info":"sdddd%20sdg%20sgs",
"tovar_descr":"fsdf%20sfs%20cfsd%20g%20wge%20w%D1%8B%20sg%20swgwg%20%D0%B4%D0%BE%D0%BB%D1%82%20kkkk%20k",
"monger_id":"1",
"monger_name":"%D0%90%D0%B3%D0%B1%D0%B8%D1%81"
}
]
}
}
где
orders – массив объектов заказов:
dor_id – ID заказа;
doc_num – номер заказа
kredit – сумма заказа,
debet – оплачено;
doc_date – дата заказа;
date_out – дата выдачи заказа;
date_out_fact – дата выдачи заказа фактическая;
status_id – статус заказа (1 – новый, 3 – в исполнении, 4 – исполненный, 5 - выданный). поле status - устаревшее;
status_name – наименование статуса;
photo_exist – признак присутствия в заказе фотографий;
discount – скидка;
fast_execute – ID срочности (берется из команды GetListsOrderTNDForAll, массив строк order_times);
sclad_id – ID склада приема;
sclad_to – ID склада выдачи;
current_sclad_id – ID текущего склада;
kind_id – тип заказа (0 – заказ химчистки, 1- прачечный заказ, 2 – продажа товаров, 4 – выездной заказ);
vds_id – ID внешней дисконтной схемы;
waiting_confirm – признак подтверждения заказа от клиента, не обязательный параметр. Принимает значения 0 - не требует подтверждения, по умолчанию; 1- требует подтверждения от клиента; 2 – клиент согласился, подтвержден; 3 - клиент НЕ согласился, отменен;
is_not_confirmed - признак подтверждения сотрудником химчистки, не обязательный параметр. Принимает значения 0 - если сотрудник химчистки уже подтвердил заказ или мы не ждем подтверждения от него, по умолчанию; 1 - если сотрудник химчистки еще не подтвердил заказа, но мы ждем это;
sclad_name - наименования склада выдачи;
sclad_adr - адрес склада выдачи;
sclad_hours - время работы склада выдачи;
condition_id - ID состояния, с версии Агбис.Химчистки 4.4.0;
condition_name - наименование состояния, с версии Агбис.Химчистки 4.4.0;
Srvices – массив объектов услуг:
dos_id – ID услуги в заказе;
parent_id – ID родительской услуги;
tov_id – ID услуги;
service – наименование;
status_id – статус услуги (1 – новый, 3 – в исполнении, 4 – исполненный, 5 – выданный, 7 - отмененный);
serv_num – порядковый номер услуги;
barcode – ШК услуги;
barcode_read - ШК для чтения;
price – цена услуги из прайс листа;
qty – кол-во;
kfx – коэффициент;
discount – скидка по услуге;
nursery_id – ID детской скидки (берется из команды GetListsOrderTNDForAll, массив строк order_nurseries);
nurseries_name – наименование детской скидки;
nurseries_discount – значение детской скидки;
dirty_id – ID наценки параметр (берется из команды GetListsOrderTNDForAll, массив строк order_dirties);
dirty_name – наименование наценки;
dirty_kfx – коэффициент наценки;
kredit – сумма услуги в заказе;
ext_info – описание;
shop_description – описание цеха;
group_tov – наименование группы услуги;
contr_provider_id - ID агента;
contr_provider_name - название агента;
contr_provider_inn - ИНН агента;
nds_name - применяемая НДС;
addons - массив объектов доп. реквизитов услуг:
addon_id – ID доп. реквизита;
descry – наименование доп. реквизита;
value_type – тип доп. реквизита;
aos_id – ID реквизита в заказе;
aos_value – значение доп. реквизита.
Tovars – массив объектов товаров:
dol_id – ID товара в заказе;
tov_id - ID товара из прайс-листа;
tovar_name – наименование товара;
group_tov – наименование группы товара;
barcode – ШК товара;
price – цена товара из прайс листа;
qty – кол-во;
kfx – коэффициент;
discount – скидка по товару;
kredit – сумма товара в заказе;
ext_info – описание;
tovar_descr – описание товара;
monger_id – ID продавца (пользователя);
monger_name – Имя продавца (пользователя).
OrdersBetweenForAll
Команда: OrdersBetweenForAll
Получения списка заказов за указанный период.
Данная команда с большими периодами может долго выполнятся, из за большого количества возвращаемых данных и вылетать по timeout! Рекомендуется в таких случаях уменьшать период.
Метод отправки: POST
Заголовок запроса (Header):
Content-type: application/json; charset=UTF-8 - обязательный параметр
Accept-Encoding: deflate - сжатие возвращаемого ответа, не обязательный параметр.
Строка запроса:
POST .../api/?OrdersBetweenForAll
Тело запроса тип json:
{
"OrdersBetweenForAll":{
"StartDate": "01.03.2018",
"StopDate": "30.03.2018",
"callback_address":"https://test.com/test.php"
},
"SessionID": "0BE170AB-86AF-441F-8523-8C960EA3EC4E"
}
где
StartDate – дата начала, обязательный параметр;
StopDate – дата окончания, обязательный параметр;
callback_address – адрес на который нужно вернуть ответ, не обязательный параметр. Если команда будет возвращать ответ дольше чем 29сек, то на этот адрес будет отправлен сформированный ответ.
Ответ json:
{
"error": 0,
"order": [
{
"dor_id":"100228",
"doc_num":"000034",
"contr_id":"10088",
"kredit":"11",
"debet":"11",
"dolg":"0",
"doc_date":"23.01.2018",
"doc_time":"11:10:00",
"date_out":"24.01.2018+17:00:00",
"date_out_fact": "",
"status":"1",
"status_name":"%D0%9D%D0%BE%D0%B2%D1%8B%D0%B9",
"photo_exist":"0",
"discount":"0",
"sclad_id":"1",
"sclad_to":"1",
"current_sclad_id":"1",
"fast_execute":"0",
"kind_id":"0",
"vds_id":"",
"waiting_confirm": "0",
"is_not_confirmed": "0",
"condition_id": "",
"condition_name": "",
"Srvices": [,
{
"dos_id":"100229911",
"parent_id":"100229910",
"tov_id":"100295",
"service":"%D0%91%D1%80%D1%8E%D0%BA%D0%B8+%D0%BA%D0%BE%D0%B6%D0%B0%D0%BD%D1%8B%D0%B5+(%D0%BF%D0%BE%D0%BA%D1%80%D0%B0%D1%81%D0%BA%D0%B0)",
"code":"01.11",
"status_id":"1",
"status_name":"%D0%9D%D0%BE%D0%B2%D1%8B%D0%B9",
"serv_num":"1",
"barcode":"271800000000341001",
"price":"6",
"qty":"1",
"kfx":"1",
"discount":"0",
"nursery_id":"0",
"nurseries_name":"%D0%9D%D0%B5+%D0%B4%D0%B5%D1%82%D1%81%D0%BA%D0%B0%D1%8F",
"nurseries_discount":"0",
"serv_weight":"1",
"dirty_id":"0",
"dirty_name":"%D0%9E%D0%B1%D1%89%D0%B5%D0%B5",
"dirty_kfx":"1",
"kredit":"6",
"ext_info":"",
"shop_description":"",
"group_tov":"1.+%D0%9A%D0%BE%D0%B6%D0%B0+(%D0%BF%D0%BE%D0%BA%D1%80%D0%B0%D1%81%D0%BA%D0%B0)",
"contr_provider_id": "10072",
"contr_provider_name": "%D0%9F%D0%BE%D0%B4%20%D0%BE%D0%B3%D1%80%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F",
"contr_provider_inn": "1234-1234-1234-1234",
"nds_name": "%D0%91%D0%B5%D0%B7%20%D0%9D%D0%94%D0%A1",
"addons":[
{
"addon_id":"110",
"descr":"%D0%9F%D0%BE%D0%BB",
"value_type":"1",
"aos_id":"1003462",
"aos_value":""
},
]
}
],
"payments":[
{
"date_pay":"18.12.2017+16:02:55",
"document":"%D0%9E%D0%BF%D0%BB%D0%B0%D1%82%D0%B0+%D0%B1%D0%B0%D0%BD%D0%BA%D0%BE%D0%B2%D1%81%D0%BA%D0%BE%D0%B9+%D0%BA%D0%B0%D1%80%D1%82%D0%BE%D0%B9",
"debet":"150",
"kredit":"0",
"kassa_name":"%D0%9E%D1%81%D0%BD%D0%BE%D0%B2%D0%BD%D0%B0%D1%8F"
}
]
}
]
}
где
Orders – массив объектов заказов;
dor_id – ID заказа;
doc_num – номер заказа;
contr_id – ID клиента;
kredit – сумма заказа;
debet – сумма оплаты заказа;
dolg – долг по заказу;
doc_date – дата принятия заказа;
doc_time – время принятия заказа;
date_out – дата выдачи заказа;
date_out_fact – дата выдачи заказа фактическая;
status – ID статуса;
status_name – наименование статуса;
photo_exist – признак присутствия в заказе фотографий;
discount – скидка;
sclad_id - склад принятия;
sclad_to – склад выдачи;
current_sclad_id – текущий склад;
fast_execute – ID срочности;
kind_id – тип заказа (0 – заказ химчистки, 1- прачечный заказ, 2 – продажа товаров, 4 – выездной заказ);
vds_id – ID ВДС;
waiting_confirm – признак подтверждения заказа от клиента. Принимает значения 0 - не требует подтверждения, по умолчанию; 1- требует подтверждения от клиента; 2 – клиент согласился, подтвержден; 3 - клиент НЕ согласился, отменен;
is_not_confirmed - признак подтверждения сотрудником химчистки. Принимает значения 0 - если сотрудник химчистки уже подтвердил заказ или мы не ждем подтверждения от него, по умолчанию; 1 - если сотрудник химчистки еще не подтвердил заказа, но мы ждем это;
condition_id - ID состояния, с версии Агбис.Химчистки 4.4.0;
condition_name - наименование состояния, с версии Агбис.Химчистки 4.4.0;
Srvices – массив объектов услуг;
dos_id – ID услуги в заказе;
parent_id – ID родительской услуги;
tov_id – ID услуги в прайс-листе;
service – наименование услуги;
code – артикул услуги;
status_id – ID статуса;
status_name – наименование статуса;
serv_num – порядковый номер услуги;
barcode – штрихкод услуги;
price - цена услуги из прайс-листа;
qty – количество;
kfx – коэффициент;
discount - скидка услуги;
nursery_id – ID детской скидки
nurseries_name – наименование услуги;
nurseries_discount - значение детской скидки;
serv_weight – вес услуги;
dirty_id – ID наценки;
dirty_name – наименование наценки;
dirty_kfx – коэффициент наценки;
kredit – сумма услуги;
ext_info – описание;
shop_description – описание цеха;
group_tov – наименование группы услуги;
contr_provider_id - ID агента;
contr_provider_name - название агента;
contr_provider_inn - ИНН агента;
nds_name - применяемая НДС;
addons – массив объектов доп. реквизитов;
addon_id – ID доп. реквизита;
descr – наименование доп. реквизита;
value_type - тип доп. реквизита;
aos_id - ID реквизита в заказе;
aos_value - значение доп. реквизита;
payments – массив объектов оплат;
date_pay – дата оплаты;
document –документ оплаты;
debet – сумма прихода;
kredit – сумма расхода;
kassa_name – наименование кассы.
DocsInWayBetweenForAll
Команда: DocsInWayBetweenForAll
Получения списка накладных в пути, в указанный промежуток времени.
Метод отправки: POST
Заголовок запроса (Header): Content-type: application/json; charset=UTF-8
Строка запроса:
POST .../api/?DocsInWayBetweenForAll
Тело запроса тип json:
{
"DocsInWayBetweenForAll":{
"StartDate": "01.03.2018",
"StopDate": "30.03.2018",
},
"SessionID": "0BE170AB-86AF-441F-8523-8C960EA3EC4E"
}
где
StartDate – дата начала, обязательный параметр;
StopDate – дата окончания, обязательный параметр.
Ответ json:
{
"error": 0,
"docs_in_way": [
{
"id":"100625",
"doc_date":"27.12.2017",
"doc_num":"000030",
"diw_status_id":"3",
"diw_status_name":"%D0%9F%D1%80%D0%B8%D0%BD%D1%8F%D1%82%D0%B0",
"from_sclad_id":"1",
"to_sclad_id":"1007",
"by_way_of_sclad_id":"10010",
"from_sclad_name":"%D0%9E%D1%81%D0%BD%D0%BE%D0%B2%D0%BD%D0%BE%D0%B9",
"to_sclad_name":"%D0%9F%D0%9F%20%D0%9E%D1%80%D1%8B%D0%BD%D0%B1%D0%BE%D1%80.%20%D0%A8%D0%BA%D0%B0%D1%84",
"by_way_of_sclad_name":"%D0%9C%D0%BE%D0%B1%D0%B8%D0%BB%D1%8C%D0%BD%D1%8B%D0%B9%20%D1%81%D0%BA%D0%BB%D0%B0%D0%B4",
"from_user_id":"1",
"accomp_id":"1",
"to_user_id":"1",
"from_user_name":"%D0%90%D0%B3%D0%B1%D0%B8%D1%81",
"accomp_name":"%D0%90%D0%B3%D0%B1%D0%B8%D1%81",
"to_user_name":"%D0%90%D0%B3%D0%B1%D0%B8%D1%81",
"qty_places":"",
"barcode":"250000000000100625",
"sclad_group_id":"",
"sclad_group_name":"",
"comments":"",
"docs_in_way_serv":[
{
"id":"100121",
"dos_id":"100229872",
"doc_in_way_id":"100625",
"barcode":"271700000001711003",
"barcode_read":"%5B0%5D%20171%20(3)",
"doc_num":"000171",
"doc_date":"25.12.2017",
"dor_id":"100186",
"date_out":"25.12.2017%2017:00:00",
"tovar_id":"100288",
"tovar_name":"%D0%94%D1%83%D0%B1%D0%BB%D0%B5%D0%BD%D0%BA%D0%B0%202%2F4%20(%D0%BF%D0%BE%D0%BA%D1%80%D0%B0%D1%81%D0%BA%D0%B0)",
"qty_kredit":"1",
"status_id":"4",
"status_name":"%D0%98%D1%81%D0%BF%D0%BE%D0%BB%D0%BD%D0%B5%D0%BD%D0%BD%D1%8B%D0%B9",
"date_in":"27.07.2018",
"time_in":"15:07:20",
"user_id_in":"1",
"user_in_name":"%D0%90%D0%B3%D0%B1%D0%B8%D1%81",
"ext_info":"",
"sclad_to":"1007",
"sclad_to_name":"%D0%9F%D0%9F%20%D0%9E%D1%80%D1%8B%D0%BD%D0%B1%D0%BE%D1%80.%20%D0%A8%D0%BA%D0%B0%D1%84",
"contr_id":"10013",
"contr_name":"%D0%90%D0%B3%D0%B1%D0%B8%D1%81",
"sclad_id_in":"1",
"sclad_id_in_name":""
}
]
}
]
}
где
docs_in_way – массив объектов накладных в пути;
id – ID накладной в пути;
doc_date – дата накладной;
doc_num – номер накладной;
diw_status_id – ID статус накладной (1 - Готова к отгрузке, 2 - В пути, 3 - Принята, 4 - Принята не полностью);
diw_status_name – наименования статуса;
from_sclad_id – ID склада, «с какого клада накладная»;
to_sclad_id – ID склада, «на какой склад накладная»;
by_way_of_sclad_id – ID мобильного склада, «через мобильный склад»;
from_sclad_name – наименование, «с какого клада накладная»;
to_sclad_name – наименование, «на какой склад накладная»;
by_way_of_sclad_name – наименование, «через мобильный склад»;
from_user_id – ID пользователя, «отгрузил»;
accomp_id – ID пользователя, «экспедитор»;
to_user_id – ID пользователя, «принял»;
from_user_name – наименование, «отгрузил»;
accomp_name – наименование, «экспедитор»;
to_user_name – наименование, «принял»;
qty_places – кол-во мест;
barcode – штрихкод;
sclad_group_id – ID группы складов, «на группу складов»;
sclad_group_name – наименование, «на группу складов»;
comments – комментарий;
docs_in_way_serv – массив объектов услуг в накладной;
id – ID строки услуги в накладной;
dos_id – ID услуги в заказе;
doc_in_way_id – ID накладной;
barcode – штрихкод услуги;
barcode_read – штрихкод услуги, для чтения;
doc_num – номер заказа;
doc_date – дата заказа;
dor_id – ID заказа;
date_out – дата выдачи заказа;
tovar_id – ID услуге в прайс-листе;
tovar_name – наименование услуги;
qty_kredit – количество услуги;
status_id – статус услуги;
status_name – наименование статуса услуги;
date_in – дата принятия;
time_in – время принятия;
user_id_in – ID пользователя;
user_in_name – наименование пользователя;
ext_info – описание услуги;
sclad_to – ID склад выдачи заказа;
sclad_to_name – наименование склад выдачи заказа;
contr_id – ID клиента;
contr_name – ФИО клиента;
sclad_id_in – ID cклада принятия услуги в накладной;
sclad_id_in_name – наименование склада принятия услуги в накладной.
OrderByDateTimeForAll
Команда: OrderByDateTimeForAll
Получения списка информации по заказам, измененных в указанный промежуток времени.
Данная команда с большими периодами может долго выполнятся, из за большого количества возвращаемых данных и вылетать по timeout! Рекомендуется в таких случаях уменьшать период.
Метод отправки: POST
Заголовок запроса (Header):
Content-type: application/json; charset=UTF-8 - обязательный параметр
Accept-Encoding: deflate - сжатие возвращаемого ответа, не обязательный параметр.
Строка запроса:
POST .../api/?OrderByDateTimeForAll
Тело запроса тип json:
{
"OrderByDateTimeForAll":{
"StartDate": "01.03.2018 10:00",
"StopDate": "01.03.2018 12:00"
},
"SessionID": "0BE170AB-86AF-441F-8523-8C960EA3EC4E"
}
где
StartDate – дата начала, обязательный параметр;
StopDate – дата окончания, обязательный параметр.
Ответ json:
{
"error": 0,
"order": [
{
"update":"16.03.2018+17:53:58",
"dor_id":"100228",
"doc_num":"000034",
"contr_id":"10088",
"kredit":"11",
"debet":"11",
"dolg":"0",
"doc_date":"23.01.2018",
"date_out":"24.01.2018+17:00:00",
"date_out_fact":"",
"status":"1",
"status_name":"%D0%9D%D0%BE%D0%B2%D1%8B%D0%B9",
"photo_exist":"0",
"discount":"0",
"sclad_id":"1",
"sclad_to":"1",
"current_sclad_id":"1",
"fast_execute":"0",
"kind_id":"0",
"vds_id":"",
"user_id": "1",
"user_name": "%D0%90%D0%B3%D0%B1%D0%B8%D1%81",
"firm_id": "10023",
"firm_name": "%D0%9E%D0%9E%D0%9E%20%22%D0%9A%D0%BE%D0%BC%D0%BF%D0%B0%D0%BD%D0%B8%D1%8F%20%D0%90%D0%B3%D0%B1%D0%B8%D1%81%22",
"price_list_id": "10023",
"price_list_name": "%D0%94%D0%BE%D0%B3%D0%BE%D0%B2%D0%BE%D1%80%20%E2%84%96000008%20%D0%BE%D1%82%2002.09.2019",
"waiting_confirm": "0",
"is_not_confirmed": "0",
"condition_id": "",
"condition_name": "",
"Srvices": [
{
"dos_id":"100229911",
"parent_id":"100229910",
"tov_id":"100295",
"service":"%D0%91%D1%80%D1%8E%D0%BA%D0%B8+%D0%BA%D0%BE%D0%B6%D0%B0%D0%BD%D1%8B%D0%B5+(%D0%BF%D0%BE%D0%BA%D1%80%D0%B0%D1%81%D0%BA%D0%B0)",
"code":"01.11",
"status_id":"1",
"status_name":"%D0%9D%D0%BE%D0%B2%D1%8B%D0%B9",
"serv_num":"1",
"barcode":"271800000000341001",
"price":"6",
"qty":"1",
"kfx":"1",
"discount":"0",
"nursery_id":"0",
"nurseries_name":"%D0%9D%D0%B5+%D0%B4%D0%B5%D1%82%D1%81%D0%BA%D0%B0%D1%8F",
"nurseries_discount":"0",
"serv_weight":"1",
"dirty_id":"0",
"dirty_name":"%D0%9E%D0%B1%D1%89%D0%B5%D0%B5",
"dirty_kfx":"1",
"kredit":"6",
"ext_info":"",
"shop_description":"",
"group_tov":"1.+%D0%9A%D0%BE%D0%B6%D0%B0+(%D0%BF%D0%BE%D0%BA%D1%80%D0%B0%D1%81%D0%BA%D0%B0)",
"current_sclad_id": "1003",
"contr_provider_id": "10072",
"contr_provider_name": "%D0%9F%D0%BE%D0%B4%20%D0%BE%D0%B3%D1%80%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F",
"contr_provider_inn": "1234-1234-1234-1234",
"nds_name": "%D0%91%D0%B5%D0%B7%20%D0%9D%D0%94%D0%A1",
"addons":[
{
"addon_id":"110",
"descr":"%D0%9F%D0%BE%D0%BB",
"value_type":"1",
"aos_id":"1003462",
"aos_value":""
},
]
}
] ,
"Tovars":[
{
"dol_id":"10043",
"tov_id":"100300",
"tovar_name":"%D0%A2%D0%BE%D0%B2%D0%B0%D1%80%20%D1%81%D0%BE%D0%BF%D1%83%D1%81%D1%82%D0%B2%D1%83%D1%8E%D1%89%D0%B8%D0%B9",
"code":"0",
"group_tov":"%D0%A2%D0%BE%D0%B2%D0%B0%D1%80%D1%8B",
"barcode":"",
"price":"5",
"qty":"1",
"kfx":"1",
"discount":"5",
"kredit":"4,75",
"ext_info":"sdddd%20sdg%20sgs",
"tovar_descr":"fsdf%20sfs%20cfsd%20g%20wge%20w%D1%8B%20sg%20swgwg%20%D0%B4%D0%BE%D0%BB%D1%82%20kkkk%20k",
"monger_id":"1",
"monger_name":"%D0%90%D0%B3%D0%B1%D0%B8%D1%81"
}
],
"payments":[
{
"date_pay":"18.12.2017+16:02:55",
"document":"%D0%9E%D0%BF%D0%BB%D0%B0%D1%82%D0%B0+%D0%B1%D0%B0%D0%BD%D0%BA%D0%BE%D0%B2%D1%81%D0%BA%D0%BE%D0%B9+%D0%BA%D0%B0%D1%80%D1%82%D0%BE%D0%B9",
"debet":"150",
"kredit":"0",
"kassa_name":"%D0%9E%D1%81%D0%BD%D0%BE%D0%B2%D0%BD%D0%B0%D1%8F"
}
]
}
]
}
где
Orders – массив объектов заказов;
update – дата изменения;
dor_id – ID заказа;
doc_num – номер заказа;
contr_id – ID клиента;
kredit – сумма заказа;
debet – сумма оплаты заказа;
dolg – долг по заказу;
doc_date – дата принятия заказа;
date_out – дата выдачи заказа;
date_out_fact – дата выдачи заказа фактическая;
status – ID статуса (1 – новый, 3 – в исполнении, 4 – исполненный, 5 – выданный, 7 - отмененный);
status_name – наименование статуса;
photo_exist – признак присутствия в заказе фотографий;
discount – скидка;
sclad_id - склад принятия;
sclad_to – склад выдачи;
current_sclad_id – текущий склад;
fast_execute – ID срочности;
kind_id – тип заказа (0 – заказ химчистки, 1- прачечный заказ, 2 – продажа товаров, 4 – выездной заказ);
vds_id – ID ВДС;
user_id - ID пользователя;
user_name - Имя пользователя;
waiting_confirm – признак подтверждения заказа от клиента, не обязательный параметр. Принимает значения 0 - не требует подтверждения, по умолчанию; 1- требует подтверждения от клиента; 2 – клиент согласился, подтвержден; 3 - клиент НЕ согласился, отменен;
is_not_confirmed - признак подтверждения сотрудником химчистки, не обязательный параметр. Принимает значения 0 - если сотрудник химчистки уже подтвердил заказ или мы не ждем подтверждения от него, по умолчанию; 1 - если сотрудник химчистки еще не подтвердил заказа, но мы ждем это;
condition_id - ID состояния, с версии Агбис.Химчистки 4.4.0;
condition_name - наименование состояния, с версии Агбис.Химчистки 4.4.0;
Srvices – массив объектов услуг;
dos_id – ID услуги;
parent_id – ID родительской услуги;
tov_id – ID услуги в прайс-листе;
service – наименование услуги;
code – артикул услуги;
status_id – ID статуса (1 – новый, 3 – в исполнении, 4 – исполненный, 5 – выданный, 7 - отмененный);
status_name – наименование статуса;
serv_num – порядковый номер услуги;
barcode – штрихкод услуги;
price - цена услуги из прайс листа;
qty – количество;
kfx – коэффициент;
discount - скидка услуги;
nursery_id – ID детской скидки;
nurseries_name – наименование услуги;
nurseries_discount - значение детской скидки;
serv_weight – вес услуги;
dirty_id – ID наценки;
dirty_name – наименование наценки;
dirty_kfx – коэффициент наценки;
kredit – сумма услуги;
ext_info – описание;
shop_description – описание цеха;
group_tov – наименование группы услуги;
current_sclad_id – ID текущего склада услуги;
contr_provider_id - ID агента;
contr_provider_name - название агента;
contr_provider_inn - ИНН агента;
nds_name - применяемая НДС;
addons – массив объектов доп. Реквизитов;
addon_id – ID доп. реквизита;
descr – наименование доп. Реквизита;
value_type - тип доп. реквизита;
aos_id - ID реквизита в заказе;
aos_value - значение доп. Реквизита;
Tovars – массив объектов товаров:
dol_id – ID товара в заказе;
tov_id - ID товара в прайс-листе;
tovar_name – наименование товара;
group_tov – наименование группы товара;
barcode – ШК товара;
price – цена товара из прайс-листа;
qty – кол-во;
kfx – коэффициент;
discount – скидка по товару;
kredit – сумма товара в заказе;
ext_info – описание;
tovar_descr – описание товара;
monger_id – ID продавца (пользователя);
monger_name – Имя продавца (пользователя);
payments – массив объектов оплат;
date_pay – дата оплаты;
document –документ оплаты;
debet – Сумма прихода;
kredit – сумма расхода;
kassa_name – наименование кассы.
ClientsByDateTimeForAll
Команда: ClientsByDateTimeForAll
Получения списка клиентов измененные в указанный промежуток времени.
Данная команда с большими периодами может долго выполнятся, из за большого количества возвращаемых данных и вылетать по timeout! Рекомендуется в таких случаях уменьшать период.
Метод отправки: POST
Заголовок запроса (Header):
Content-type: application/json; charset=UTF-8 - обязательный параметр
Accept-Encoding: deflate - сжатие возвращаемого ответа, не обязательный параметр.
Строка запроса:
POST .../api/?ClientsByDateTimeForAll
Тело запроса тип json:
{
"ClientsByDateTimeForAll":{
"StartDate": "01.03.2018 10:00",
"StopDate": "30.03.2018 20:00"
},
"SessionID": "0BE170AB-86AF-441F-8523-8C960EA3EC4E"
}
гдеStartDate – дата начала, обязательный параметр;
StopDate – дата окончания, обязательный параметр.
Ответ json:
{
"error":0,
"clients":[
{
"update": "16.11.2021%2015:30:36",
"contr_id": "10013",
"fullname": "%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",
"name": "%D0%90%D0%B3%D0%B1%D0%B8%D1%81%20%D0%A2.%20%D0%A2.",
"telephone": "",
"teleph_cell": "%2B79990009900",
"email": "test@test.ru",
"folder_id": "24",
"address": "%D1%82%D0%B5%D1%81%D1%82",
"barcode": "1600000100138",
"discount": "12",
"gender": "0",
"is_active": "1",
"is_deleted": "0",
"source": "",
"agree_to_receive_sms": "1",
"agree_to_receive_adv_sms": "0",
"sp": "2",
"region_id": "",
"date_create": "30.03.2017%2010:57:41",
"first_order_date": "22.06.2017",
"save_token_pay": "0",
"last_order_date": "13.07.2022",
"previous_order_date": "08.06.2022",
"scheme_id": "",
"schem_name": "",
"is_family": "0",
"dics_block_reason": "",
"contr_block_reason": "",
"address_post": "",
"okpo": "",
"inn": "",
"kpp": "",
"ogrn": "",
"account": "",
"bank_name": "",
"birth_day": "",
"order_not_pay": "380",
"order_count": "599",
"dolg": "1399165,42",
"bonus": "5459,6",
"deposit": "36",
"enter_count": "208",
"pay_rest": "-1310113,31",
"date_avg": "2",
"pay_summ": "1780109,24",
"disc_rest": "%D0%9E%D0%B3%D1%80%D0%B0%D0%BD%D0%B8%D1%87%D0%B5%D0%BD%D0%B8%D0%B5%20%D0%BE%D1%82%D1%81%D1%83%D1%82%D1%81%D1%82%D0%B2%D1%83%D0%B5%D1%82",
"promo_code": "P2HZ3",
"date_last_ds": "28.06.2022 13:52:08"
}
]
}
где
clients – массив объектов клиентов;
update – дата изменения клиента;
contr_id – ID клиента;
fullname – полное ФИО;
name – краткое ФИО;
telephone – обычный телефон;
teleph_cell – сотовый телефон;
email – электронная почта;
folder_id - ID группы клиента;
address – адрес клиента;
barcode – штрихкод клиента;
discount – скидки клиента;
gender – пол клиента (0-мужской, 1-женский);
is_active – признак активности;
is_deleted – признак удаления;
source – произвольный текст;
agree_to_receive_sms – согласие получать СМС о готовности заказов;
agree_to_receive_adv_sms – согласие получать рекламные и поздравительные СМС;
sp – тип клиента (1- организация, 2- физическое лицо);
region_id – регион;
date_create – дата создания;
first_order_date – дата первого заказа;
last_order_date – дата последнего заказа;
previous_order_date – дата предпоследнего заказа;
scheme_id - ID дисконтной схемы;
schem_name - наименование ДС;
is_family - признак семейная скидка;
agree_save_card_pay – признак согласия сохранять карту оплаты;
birth_day – дата рождения;
order_not_pay – количество не отплаченных заказов;
order_count – количество заказов;
deposit – остаток депозита клиента;
bonus – остаток бонусов клиента;
dolg – сумма долга;
enter_count – количество посещений;
pay_rest – нерастраченные авансовые платежи;
date_avg – среднее кол-во дней между заказами;
pay_summ – сумма заказов за весь период;
disc_rest – остаток по дисконтной схеме;
promo_code – промо-код;
date_last_ds - дата присвоения последней ДС.
OrderPaysBetweenForAll
Команда: OrderPaysBetweenForAll
Получения списка оплат заказов за указанный период.
Данная команда с большими периодами может долго выполнятся, из за большого количества возвращаемых данных и вылетать по timeout! Рекомендуется в таких случаях уменьшать период.
Метод отправки: POST
Заголовок запроса (Header):
Content-type: application/json; charset=UTF-8 - обязательный параметр
Accept-Encoding: deflate - сжатие возвращаемого ответа, не обязательный параметр.
Строка запроса:
POST .../api/?OrderPaysBetweenForAll
Тело запроса тип json:
{
"OrderPaysBetweenForAll":{
"StartDate": "01.03.2018",
"StopDate": "30.03.2018"
},
"SessionID": "0BE170AB-86AF-441F-8523-8C960EA3EC4E"
}
где
StartDate – дата начала, обязательный параметр;
StopDate – дата окончания, обязательный параметр.
Ответ 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"
}
]
}
где
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 – сумма возврата платежа.
Устаревшие команды
В данном разделе находятся уже устаревшие команды, но еще работающие.
Через несколько лет они будут удалены.
Для избежания поломки уже интегрированных устаревших команд, рекомендуется сделать переход на соответствующую актуальную команду.
GetOrderImagesForAll
Команда: GetOrderImagesForAll
Устаревшая команда, больше не поддерживается
Получение фотографий услуг.
Для просмотра списка фотографий, рекомендуется использовать актуальную команду OrderImagesModern.
Для получения самой фотографии, используется команда PhotoOnline.
Метод отправки: GET
Заголовок запроса (Header): не требуется.
Формат запроса:
GetOrderImagesForAll={"dor_id": "11223334"}&SessionID=
Строка запроса:
GET .../api/?GetOrderImagesForAll=%7B%22dor_id%22%3A%20%2211223334%22%7D&SessionID=...
где
dor_id – ID заказа, обязательно поле.
Ответ json:
{
"error":0,
"photos":[
{
"dos_id": "100229859",
"photo_id": "1004",
"img": "R0lGODlhEgAMAOZaACtTezxtnyBEaI2t0lNzlVZ1lzZbgpSz1zJYgJOx1lJ+rS1VfT5ih0p4qIipz1Bwk1Fxkz9voYanzoKkyyxUfFRzlWOLt0BxokdpjTFYfy9WfpCv1GuSvXSZw0Jlik5ukUVojFV0lkRzpEFxonGXwUx6qVZ1lkNzo0l3p46t01qFsn6hyFmEsjhdhDZcgj9jiFSAro+u0zhqnSpSeoeozmKLtzNZgExtkD1unzhdg3GXwFN/rVZ0llN/rl+JtWSNuUlrjn+iykxtkS5WfZKx1jZcg5Kx1Xufx5Kw1TprnVaBr3mdxUh3pzxhhjlehUpsj2OMuFeCsD5iiDdcgylRejpfhSZPeDNmmZWz11d2l////wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/wtYTVAgRGF0YVhNUDw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoV2luZG93cykiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6NjQyQjc1OThCRUJEMTFFNUFDRkVGNDdBMzUyNUUwMjQiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6NjQyQjc1OTlCRUJEMTFFNUFDRkVGNDdBMzUyNUUwMjQiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDo2NDJCNzU5NkJFQkQxMUU1QUNGRUY0N0EzNTI1RTAyNCIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDo2NDJCNzU5N0JFQkQxMUU1QUNGRUY0N0EzNTI1RTAyNCIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PgH//v38+/r5+Pf29fTz8vHw7+7t7Ovq6ejn5uXk4+Lh4N/e3dzb2tnY19bV1NPS0dDPzs3My8rJyMfGxcTDwsHAv769vLu6ubi3trW0s7KxsK+urayrqqmop6alpKOioaCfnp2cm5qZmJeWlZSTkpGQj46NjIuKiYiHhoWEg4KBgH9+fXx7enl4d3Z1dHNycXBvbm1sa2ppaGdmZWRjYmFgX15dXFtaWVhXVlVUU1JRUE9OTUxLSklIR0ZFRENCQUA/Pj08Ozo5ODc2NTQzMjEwLy4tLCsqKSgnJiUkIyIhIB8eHRwbGhkYFxYVFBMSERAPDg0MCwoJCAcGBQQDAgEAACH5BAXSAFoALAAAAAASAAwAAAd6gFZXg4SFhleCATpYjI2OjCQBgxIXUI+PPxcSg1gDKEpElwlRTANYnFhGMA0pjjElO0iMqIw1IzSMDic+B420WB09AStBOAodjqgHFhETR0kySxMRFr2nV1gbCg2mjwMNChvXDiIqCZeMCSwiDoMBHOiPHJKCh/aDVoEAIfkEBTwAWgAsAAAAABIADAAAB3eAAlaDhIWGVoIAIFmMjY6MIACDDwtSj48vCw+DWQQZOQWXBS0ZBFmcWSZTCBWOFTYuPIyojAyajBBDTY60WRhFADdCAAYYvFaNDBQfTzNUQB8UDI2cIQYIpo8ECAYhp1YQGlWhl1kFThoQgwAe5Y8ekoKH84MCgQA7"
}
]
}
где
photos – массив фотографий;
dos_id – ID услуги заказа;
photo_id – ID фотографии;
img – фотография в строке base64.