Содержание

Содержание

2. Команды API ТОЛЬКО с клиентской сессией
Устаревшие команды
- OrderConfirm

2. Команды API ТОЛЬКО с клиентской сессией

Команды получения данных по конкретному клиенту, для выполнения которых Требуется клиентская сессия.

SaveInfo

Команда: SaveInfo

Сохранение информации по клиенту в ЛК.

Метод отправки: GET

Формат запроса:

SaveInfo={"Name": "Агбис Тест Тестович", "birth_day": "01.10.1974", "Teleph_cell": "+79990009900", "Email": "", "Address": "Новокузнецк, 123- 4", "gender": "0", "agree_to_receive_sms": "1", "agree_to_receive_adv_sms": "0"}&SessionID=

Строка запроса:

GET .../api/?SaveInfo=%7B%22Name%22%3A%20%22%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%22%2C%20%22birth_day%22%3A%20%2201.10.1974%22%2C%20%22Teleph_cell%22%3A%20%22%2B79990009900%22%2C%20%22Email%22%3A%20%22%22%2C%20%22Address%22%3A%20%22%D0%9D%D0%BE%D0%B2%D0%BE%D0%BA%D1%83%D0%B7%D0%BD%D0%B5%D1%86%D0%BA%2C%20123-%204%22%2C%20%22gender%22%3A%20%220%22%2C%20%22agree_to_receive_sms%22%3A%20%221%22%2C%20%22agree_to_receive_adv_sms%22%3A%20%220%22%7D&SessionID=...

где
Name – ФИО клиента, не обязательный параметр;
Teleph_cell – сотовый телефон, не обязательный параметр;
Fone – обычный телефон, не обязательный параметр;
birth_day – день рождения (пример: 01.04.1954), не обязательный параметр;
Email – E-mail адрес, не обязательный параметр;
Address – адрес клиента, не обязательный параметр;
gender – пол клиента (0 – м, 1 - ж), не обязательный параметр;
agree_to_receive_sms - согласие на смс о готовности заказа, не обязательный параметр;
agree_to_receive_adv_sms - согласие на рекламную смс, не обязательный параметр;
source - любой текст, не обязательный параметр;
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0, 
  "Msg": "%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B8%20%D1%81%D0%BE%D1%85%D1%80%D0%B0%D0%BD%D0%B5%D0%BD%D1%8B", 
  "contr_id": "10013"
}

где
error - успешность выполнения команды;
Msg - сообщение;
contr_id - ID клиента;
need_confirm_phone - признак что, измененный телефон нужно подтвердить.
Клиенту на новый телефон уходит смс с кодом подтверждения. Для подтверждения телефона используется команда ConfirmCellPhone.

SavePass

Команда: SavePass

Сохранение нового пароля клиента в ЛК.

Метод отправки: GET

Формат запроса:

SavePass={"old":"40bd001563085fc35165329ea1ff5c5ecbdbbeef","new":"7110eda4d09e062aa5e4a390b0a572ac0d2c0220","IsDigitPass":"1"}&SessionID=

Строка запроса:

GET .../api/?SavePass=%7B%22old%22%3A%2240bd001563085fc35165329ea1ff5c5ecbdbbeef%22%2C%22new%22%3A%227110eda4d09e062aa5e4a390b0a572ac0d2c0220%22%2C%22IsDigitPass%22%3A%221%22%7D&SessionID=...

где
old - старый пароль, обязательный параметр;
new - новый пароль, обязательный параметр;
IsDigitPass - признак, если пароль содержит только цифры, не обязательный параметр;
SessionID - ID сессии, обязательный параметр.

old и new должны быть преобразованы с помощью алгоритма SHA1.

Ответ json:

{
  "error": 0
}

ConfirmCellPhone

Команда: ConfirmCellPhone

Подтверждение номера телефона по клиенту в ЛК.
При успешном подтверждении новый телефон будет применен в карточке клиента.

Метод отправки: GET

Формат запроса:

ConfirmCellPhone={"contr_id": "10013", "code": "1234"}&SessionID=

Строка запроса:

GET .../api/?ConfirmCellPhone={"contr_id": "10013", "code": "1234"}&SessionID=...

где
contr_id - ID клиента, обязательный параметр;
code - код подтверждения из смс, не обязательный параметр. Если не указать будет повторная смс с кодом подтверждения, не чаще 1 раза в 5мин;
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0, 
  "code": "223", 
  "phone": "+79990009900", 
  "contr_id": "10013"
}

где
error - успешность выполнения команды;
code - новый код подтверждения из смс при повторной отправке;
phone - телефон на который ушла смс;
contr_id - ID клиента.

Bonus

Команда: Bonus

Метод отправки: GET

Остаток бонусов авторизированного клиента в ЛК. Обязательный параметр SessionID.

Формат запроса:

Bonus&SessionID=

Строка запроса:

GET .../api/?Bonus&SessionID=...

где
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error":0,
  "bonus_rest":"1956"
}

где
bonus_rest - остаток бонуса клиента.

Deposit

Команда: Deposit

Метод отправки: GET

Остаток депозита авторизированного клиента в ЛК. Обязательный параметр SessionID.

Формат запроса:

Deposit&SessionID=

Строка запроса:

GET .../api/?Deposit&SessionID=...

где
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error":0,
  "deposit_rest":"206"
}

где
deposit_rest - остаток депозита клиента.

Orders

Команд: Orders

Метод отправки: GET

Список текущих заказов (кроме выданных) авторизированного клиента в ЛК.

Формат запроса:

Orders={"sclad": 1, "need_serv": 1}&SessionID=

Строка запроса:

GET .../api/?Orders=%7B%22sclad%22%3A1%2C%22need_serv%22%3A1%7D&SessionID=...

где
sclad - информация по складу, необязательный параметр. Указывает нужно ли в ответе указывать информацию по складу(принимает значение 0 и 1);
need_serv - детализация по услугам заказа, необязательный параметр. Указывает нужно ли в ответ записывать детализацию по услугам заказа, в противном случае блок «services» будет отсутствовать(принимает значение 0 и 1);
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0, 
  "orders":[
    {
      "dor_id": 150708,
      "doc_num": "001476",
      "kredit": "1056",
      "debet": "801,93",
      "doc_date": "15.07.2013",
      "date_out": "19.07.2013 15:14:22",
      "status": "1",
      "photo_exist": "0",
      "discount": "5",
      "sclad_name": "%D0%A7%D0%B8%D1%81%D1%82%D0%BA%D0%B0",
      "sclad_adr": "%D0%94%D1%80%D1%83%D0%B6%D0%B1%D1%8B%201-1",
      "sclad_hours": "8:00-20:00",
      "condition_id": "",
      "condition_name": "",
      "services":[
        {
          "dos_id": "100230799",
          "tov_id": "100644",
          "service": "%D0%94%D1%83%D0%B1%D0%BB%D0%B5%D0%BD%D0%BA%D0%B0",
          "code": "060104",
          "status_id": "1",
          "status_name": "%D0%9D%D0%BE%D0%B2%D1%8B%D0%B9",
          "barcode": "271800000786781001",
          "price": "1320",
          "qty": "1",
          "kfx": "1",
          "discount": "20", 
          "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": "1056",
          "ext_info": "",
          "shop_description": "",
          "group_tov": "%D0%90%D1%82%D0%B5%D0%BB%D1%8C%D0%B5",
          "addons":[
            {
              "id": "3",
              "descr": "%D0%98%D0%B7%D0%BD%D0%BE%D1%81%20%D0%B2%20%25",
              "value_type": "1",
              "aos_id": "1009302",
              "aos_value": "%D0%98%D0%B7%D0%BD%D0%BE%D1%81%2050%25"
            }
          ]
        }
      ]
    }
  ]
}

где
orders - массив объектов заказов:
dor_id – ID заказа;
doc_date – дата заказа;
doc_num – номер заказа;
date_out – дата выдачи;
kredit – сумма заказа;
debet – сумма оплаты заказа;
discount – скидка по заказу;
kind_id – тип заказа (0 – Заказ для химчистки, 1 - Заказ для прачечной, 2 – Продажа товаров, 3 – Выездной заказ);
photo_exist – содержит фотографии;
sclad_to – ID склад приема;
sclad_name – название склада;
sclad_adr – адрес склада;
sclad_hours – время работы склада;
current_sclad_id – текущий склад;
status – статус заказа (1 - Новый, 2 - На хранении, 3 - В исполнении, 4 - Исполненный, 5 - Выданный, 6 - Закрытый, 7 - Отменённый);
waiting_confirm – признак подтверждения заказа от клиента (0 - не требует подтверждения, по умолчанию; 1- требует подтверждения от клиента; 2 – клиент согласился, подтвержден; 3 - клиент НЕ согласился, отменен);
is_not_confirmed - признак подтверждения сотрудником химчистки (0 - если сотрудник химчистки уже подтвердил заказ или мы не ждем подтверждения от него, по умолчанию; 1 - если сотрудник химчистки еще не подтвердил заказа, но мы ждем это);
condition_id - ID состояния, с версии Агбис.Химчистки 4.4.0;
condition_name - наименование состояния, с версии Агбис.Химчистки 4.4.0;
services - массив объектов услуг:
dos_id – ID услуги в заказе;
tov_id – ID номенклатурной услуги;
service - название услуги;
code - артикул;
status_id – ID статуса;
status_name - название статуса;
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 - группа номенклатуры.
addons - массив объектов доп реквизитов:
id – ID реквизита;
descr - название реквизита;
value_type - тип реквизита;
aos_id – ID значения реквизита;
aos_value - значение реквизита.

OrdersHistory

Команда: OrdersHistory

Метод отправки: GET

Список выполненных (выданных) заказов клиента в ЛК.

Формат запроса:

OrdersHistory={"mon": 1, "need_serv": 1}&SessionID=

Строка запроса:

GET .../api/?OrdersHistory=%7B%22mon%22%3A1%2C%22need_serv%22%3A1%7D&SessionID=...

где
mon - период отображения истории, необязательный параметр. Принимает значение 0 - за последний квартал, 1 – за последние полгода, 2 - за год;
sclad - информация по складу, необязательный параметр. Указывает нужно ли в ответе указывать информацию по складу(принимает значение 0 и 1);
need_serv - детализация по услугам заказа, необязательный параметр. Указывает нужно ли в ответ записывать детализацию по услугам заказа, в противном случае блок «services» будет отсутствовать(принимает значение 0 и 1);
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": "0",
  "orders_history": 
    [
      {
        "dor_id": "159214",
        "doc_num": "0000023",
        "kredit": "1056",
        "debet": "1056",
        "doc_date": "15.07.2013",
        "date_out": "19.07.2013 15:14:22",
        "status": "5",
        "discount": "0",
        "date_out_fast": "20.06.2016 10:08:23",
        "condition_id": "",
        "condition_name": "",
        "services":
          [
            {
              "dos_id": "100230799",
              "tov_id": "100644",
              "service": "%D0%94%D1%83%D0%B1%D0%BB%D0%B5%D0%BD%D0%BA%D0%B0",
              "code": "060104",
              "status_id": "1",
              "status_name": "%D0%9D%D0%BE%D0%B2%D1%8B%D0%B9",
              "barcode": "271800000786781001",
              "price": "1320",
              "qty": "1",
              "kfx": "1",
              "discount": "20",
              "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": "1056",
              "ext_info": "",
              "shop_description": "",
              "group_tov": "%D0%90%D1%82%D0%B5%D0%BB%D1%8C%D0%B5",
              "addons":
                [
                  {
                    "id": "3",
                    "descr": "%D0%98%D0%B7%D0%BD%D0%BE%D1%81%20%D0%B2%20%25",
                    "value_type": "1",
                    "aos_id": "1009302",
                    "aos_value": "%D0%98%D0%B7%D0%BD%D0%BE%D1%81%2050%25"
                  }
                ]
            }
          ]
      }
    ]
}

где
orders_history - массив объектов заказов:
dor_id – ID заказа;
doc_date – дата заказа;
doc_num – номер заказа;
date_out – дата выдачи;
date_out_fast – дата выдачи фактическая;
kredit – сумма заказа;
debet – сумма оплаты заказа;
discount – скидка по заказу;
status – статус заказа.
condition_id - ID состояния, с версии Агбис.Химчистки 4.4.0;
condition_name - наименование состояния, с версии Агбис.Химчистки 4.4.0;
services - массив объектов услуг:
dos_id – ID услуги;
tov_id – ID номенклатуры;
service - название услуги;
code - артикул;
status_id – ID статуса;
status_name - название статуса;
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 - группа номенклатуры.
addons - массив объектов доп. реквизитов:
id – ID реквизита;
descr - название реквизита;
value_type - тип реквизита;
aos_id – ID значения реквизита;
aos_value - значение реквизита.

FullOrderInfo

Команда: FullOrderInfo

Получение полной информации по заказу.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

FullOrderInfo={"dor_id":"1"}&SessionID=

Строка запроса:

GET .../api/?FullOrderInfo=%7B%22dor_id%22%3A%221001464%22%7D&SessionID=...

где
dor_id – ID заказа, обязательный параметр;
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0,
  "dor_id": "1001464",
  "order_dop_info": {
    "kind_id": "0",
    "doc_num": "000098",
    "kredit": "1",
    "debet": "0",
    "barcode": "280000000001001464",
    "firm_id": "11",
    "doc_date": "24.05.2021",
    "date_out": "25.05.2021%2017:00:00",
    "current_sclad_id": "1",
    "status_id": "1",
    "photo_exist": "0",
    "discount": "20",
    "sclad_to": "1",
    "fast_exec_id": "0",
    "sclad_name": "%D0%9E%D1%81%D0%BD%D0%BE%D0%B2%D0%BD%D0%BE%D0%B9",
    "sclad_adr": "%D0%BF%D1%80-%D1%82%20%D0%9C%D0%B5%D1%82%D0%B0%D0%BB%D0%BB%D1%83%D1%80%D0%B3%D0%BE%D0%B2%2043-23",
    "sclad_hours": "",
    "discount_extrnl_id": "",
    "sclad_kredit_id": "1",
    "is_not_confirmed": "0",
    "waiting_confirm": "0"
  },
  "order_services": [
    {
      "dos_id": "100231018",
      "parent_id": "",
      "qty_kredit": "1",
      "kredit": "1",
      "name": "%D0%91%D0%B5%D1%80%D0%BC%D1%83%D0%B4%D1%8B",
      "status_id": "1",
      "unitname": "%D1%88%D1%82.",
      "serv_num": "1",
      "barcode_read": "%5B0%5D%2098%20(1)",
      "photo_exist": "0"
    }
  ],
  "order_payments": [
    {
     "doc_id": "100156",
     "doc_type": "91",
     "kassa_debet": "0",
     "bank_debet": "0",
     "card_debet": "0",
     "bonus_debet": "1940",
     "deposit_debet": "0"
   }
  ],
  "order_comments": [],
  "order_plans": [],
  "order_signs": []
}

где
dor_id - ID заказа;
order_dop_info – Массив доп. информация по заказу:
kind_id - тип заказа (0 - Заказ для химчистки, 1 - Заказ для прачечной, 2 - Продажа товаров, 3 - Выездной заказ, 5 - Заказ для клининга);
doc_num - номер заказа;
kredit – сумма заказа;
debet – сумма оплаты заказа;
barcode – штрих-код заказа;
firm_id – ID фирмы;
doc_date – дата заказа;
date_out – дата выдачи;
current_sclad_id – ID текущего склада;
status_id – статус заказа (1 - Новый, 2 - На хранении, 3 - В исполнении, 4 - Исполненный, 5 - Выданный, 6 - Закрытый, 7 - Отменённый);
photo_exist – заказ содержит фотографии (0 - нет фотографий, 1 - содержит фотографии);
discount – скидка по заказу;
sclad_to – ID склада приема;
fast_exec_id - ID срочности;
sclad_name – название склада;
sclad_adr – адрес склада;
sclad_hours – время работы склада;
discount_extrnl_id - ID ВДС;
sclad_kredit_id - ID склада приема;
waiting_confirm – признак подтверждения заказа от клиента (0 - не требует подтверждения, по умолчанию; 1- требует подтверждения от клиента; 2 – клиент согласился, подтвержден; 3 - клиент НЕ согласился, отменен);
is_not_confirmed - признак подтверждения сотрудником химчистки (0 - если сотрудник химчистки уже подтвердил заказ или мы не ждем подтверждения от него, по умолчанию; 1 - если сотрудник химчистки еще не подтвердил заказа, но мы ждем это);
order_services – массив услуг в заказе(ID услуги, кол-во конкретной услуги, стоимость конкретной услуги, наименование услуги, статус услуги, ед. измерения услуги);
dos_id - ID услуги;
parent_id - ID родительской услуги;
qty_kredit - количество;
kredit - сумма услуги;
name - наименование услуги;
status_id - статус услуги;
unitname - наименование единицы измерения;
serv_num - номер услуги;
barcode_read - бирка услуги
photo_exist - услуга содержит фотографии (0 - нет фотографий, 1 - содержит фотографии);
order_payments - массив оплат:
doc_id - ID документа оплаты;
doc_type - тип документа оплаты (3 - Кассовый документ (без фискализации), 4 - Банковский документ, 9 - Оплата банковской картой, 31 - Кассовый чек оплата покупателем (с фискализацией), 32 - Кассовый чек возврат денег покупателю (с фискализацией), 91 - Бонус, 92 - Оплата депозитом);
kassa_debet - сумма оплаты кассового документа;
bank_debet - сумма оплаты банковского документа;
card_debet - сумма оплаты банковской картой;
bonus_debet - сумма оплаты бонусом;
deposit_debet - сумма оплаты депозитом;
order_comments – массив комментариев услуг в заказа:
id - ID комментария;
descript - комментарий;
order_plans – массив выездов по заказу; Только в статусах 0 - новый, 3 - Принял, 4 - В пути
id - ID выезда;
tp - тип выезда;
dt - дата выезда;
hr - час выезда;
mn - минуты выезда;
to_hr - час до которого длится выезд;
to_mn - минуты до которого длится выезда;
address - адрес выезда;
comment - комментарий;
sclad_id - ID склада выезда;
mp_status_id - ID статус выезда (0 - новый, 3 - Принял, 4 - В пути);
order_signs – массив подписанных квитанций по заказу(вн. номер подписанной квитанции, дата подписания, название квитанции):
id - ID подписанной квитанции;
dttm - дата подписанной квитанции;
name - наименование квитанции.

Services

Команда: Services

Запрос краткой информации по услугам заказа

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

Services={"dor_id":"1"}&SessionID=

Строка запроса:

GET .../api/?Services=%7B%22dor_id%22%3A%221001464%22%7D&SessionID=...

где
dor_id – ID заказа, обязательный параметр;
info - дополнительная информация по услуге, обязательный параметр. Принимает значения 0 и 1;
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0,
  "order_servises": [
    {
      "dos_id": "100231286",
      "tov_id": "10018",
      "service": "%D0%91%D0%B5%D1%80%D0%BC%D1%83%D0%B4%D1%8B",
      "status_id": "1",
      "unit_name": "%D1%88%D1%82.",
      "serv_num": "1",
      "parent_id": "",
      "kredit": "880",
      "ext_info": "",
      "qty_kredit": "1"
    }
  ]
}

где
order_servises - массив услуг заказа:
dos_id – ID услуги;
tov_id – ID товара;
service – название услуги;
status_id - статус услуги;
unit_name - единица измерения;
serv_num – последовательный номер услуги;
parent_id – ID родительской услуги;
kredit – стоимость услуги;
ext_info – дополнительное описание;
qty_kredit – количество услуги.

FullService

Команда: FullService

Получение полной информации по услугам заказа.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

FullService={"dor_id":"1"}&SessionID=

Строка запроса:

GET .../api/?FullService=%7B%22dor_id%22%3A%221001464%22%7D&SessionID=...

где
dor_id – ID заказа, обязательный параметр;
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0,
  "order_services": [
    {
      "dos_id": "100231286",
      "parent_id": "",
      "tov_id": "10018",
      "service": "%D0%91%D0%B5%D1%80%D0%BC%D1%83%D0%B4%D1%8B",
      "code": "01.18",
      "status_id": "1",
      "status_name": "%D0%9D%D0%BE%D0%B2%D1%8B%D0%B9",
      "serv_num": "1",
      "barcode": "272100000002241001",
      "price": "880",
      "qty": "1",
      "kfx": "1",
      "discount": "12",
      "nursery_id": "0",
      "nurseries_name": "%D0%9D%D0%B5%20%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": "880",
      "ext_info": "",
      "shop_description": "",
      "group_tov": "1.%20%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%20%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D0%B0",
      "discount_type": "10",
      "addons": []
    }
  ]
}

где
order_services - массив услуг заказа:
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 – описание склада;
addons – массива дополнительных реквизитов услуги;
id – ID дополнительного реквизита;
descr – наименование;
value_type – тип реквизита;
aos_id – ID значения реквизита;
aos_value – значение реквизита.

OrderAppConfirm

Команда: OrderAppConfirm

Подтверждение клиентом заказа в ЛК.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

OrderAppConfirm={"dor_id":"12345"}&SessionID=

Строка запроса:

GET .../api/?OrderAppConfirm=%7B%22dor_id%22%3A%2212345%22%7D&SessionID=...

где
dor_id - ID заказа, обязательный параметр;
SessionID - ID сессии, обязательный параметр;

Ответ json:

{
  "error": 0, 
  "Msg": "%D0%97%D0%B0%D0%BA%D0%B0%D0%B7%20%D0%BF%D0%BE%D0%B4%D1%82%D0%B2%D0%B5%D1%80%D0%B6%D0%B4%D0%B5%D0%BD"
}

где
Msg - сообщение.

CancelOrderApp

Команда: CancelOrderApp

Отмена подтверждение клиентом заказа в ЛК.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

CancelOrderApp={"dor_id":"12345"}&SessionID=

Строка запроса:

GET .../api/?CancelOrderApp=%7B%22dor_id%22%3A%2212345%22%7D&SessionID=...

где
dor_id - ID заказа, обязательный параметр;
SessionID - ID сессии, обязательный параметр;

Ответ json:

{
  "error": 0, 
  "Msg": "%D0%97%D0%B0%D0%BA%D0%B0%D0%B7%20%D0%BE%D1%82%D0%BC%D0%B5%D0%BD%D1%91%D0%BD"
}

где
Msg - сообщение.

CancelOrder

Команда: CancelOrder

Перевод статуса заказа в отменённый в ЛК.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

CancelOrder={"dor_id ":"12345"}&SessionID=

Строка запроса:

GET .../api/?CancelOrder=%7B%22dor_id %22%3A%2212345%22%7D&SessionID=...

где
dor_id – ID заказа, обязательный параметр;
comment - комментарий, необязательный параметр;
SessionID - ID сессии, обязательный параметр.

Ответ json:

{"error": 0}

DepositPay

Команда: DepositPay

Оплата заказа депозитом в ЛК.

Метод отправки: GET

Формат запроса:

DepositPay={"dor_id":"123","amount":"12"}&SessionID=

Строка запроса:

GET .../api/?DepositPay=%7B%22dor_id%22%3A%221001490%22,%22amount%22%3A%2212%22%7D&SessionID=...

где
dor_id – ID заказа, обязательный параметр;
amount - сумма депозита, обязательный параметр;
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0,
  "Msg": "%D0%97%D0%B0%D0%BA%D0%B0%D0%B7%20%D0%BE%D0%BF%D0%BB%D0%B0%D1%87%D0%B5%D0%BD"
}

BonusPay

Команда: BonusPay

Оплата заказа бонусом в ЛК.

Метод отправки: GET

Формат запроса:

BonusPay={"dor_id":"123","amount":"12"}&SessionID=

Строка запроса:

GET .../api/?BonusPay=%7B%22dor_id%22%3A%221001490%22,%22amount%22%3A%2212%22%7D&SessionID=...

где
dor_id – ID заказа, обязательный параметр;
amount - сумма бонуса, обязательный параметр;
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0,
  "Msg": "%D0%97%D0%B0%D0%BA%D0%B0%D0%B7%20%D0%BE%D0%BF%D0%BB%D0%B0%D1%87%D0%B5%D0%BD"
}

TitleMessages

Команда: TitleMessages

Получение списка тем обсуждений (переписки) клиента в ЛК.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

TitleMessages&SessionID=

Строка запроса:

GET .../api/?TitleMessages&SessionID=...

где
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0,
  "Messages": [
    {
      "id": "1001",
      "dor_id": "",
      "doc_num": "",
      "dttm": "07.09.2017 11:03:50",
      "comment": "",
      "user": "1",
      "star": "0",
      "message_type": "7",
      "new_mes_count": "0",
      "status_message": "0"
    }
  ]
}

где
id – ID темы сообщения;
dor_id – номер заказ (если привязан по заказу);
doc_num – номер заказа;
dttm – дата/время создания;
comment – главное сообщение темы;
user – признак кому принадлежит сообщение, 1 – клиент, 0 – сотрудник химчистки;
star – оценка (от 1 до 5);
message_type – тип сообщения (1- отзыв, 2 – жалоба, 3 – пожелание, 4 – некорректные данные, 5 - вопрос);
new_mes_count – количество новых сообщений;
status_message – признак что сообщение новое.

MessageList

Команда: MessageList

Получение списка сообщений темы (переписки) клиента в ЛК.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

MessageList={"id":"123"}&SessionID=

Строка запроса:

GET .../api/?MessageList=%7B%22id%22%3A%22123%22%7D&SessionID=...

где
id – ID переписки;
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0,
  "childNode_comments": [
    {
      "id": 124,
      "dttm": "10.10.2021%2015:47:41",
      "comment": "%D0%A2%D0%B5%D1%81%D1%82%D0%BE%D0%B2%D0%BE%D0%B5%20%D1%81%D0%BE%D0%BE%D0%B1%D1%89%D0%B5%D0%BD%D0%B8%D0%B5",
      "user": 1,
      "status_message": 0
    }
  ]
}

где
childNode_comments - массив сообщений темы:
id – ID сообщения;
dttm – дата/время;
comment – текст сообщения;
user – признак кому принадлежит сообщение, 1 – клиент, 0 – сотрудник химчистки;
status_message – признак что сообщение новое.

CountNewMessages

Команда: CountNewMessages

Количество новых сообщений в теме(переписке) в ЛК.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

CountNewMessages={"id":"123"}&SessionID=

Строка запроса:

GET .../api/?CountNewMessages=%7B%22id%22%3A%22123%22%7D&SessionID=...

где
id – ID обсуждения;
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0,
  "count_new": "2"
}

где
count_new – количество новых сообщений оставленных сотрудниками химчистки. Обнулиться после выполнения MessageList.

SendMessage

Команда: SendMessage

Отправка сообщения в тему (переписки) или создание новой темы (переписки) в ЛК.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Новое сообщение в обсуждении:

Формат запроса:

SendMessage={"id":"1001","dttm":"21.12.2021 12:00","mes_type":"3","comment":"Проверка"}&SessionID=

Строка запроса:

GET .../api/?SendMessage=%7B%22id%22%3A%221001%22,%22dttm%22%3A%2221.12.2021%2012%3A00%22,%22mes_type%22%3A%223%22,%22comment%22%3A%22%D0%9F%D1%80%D0%BE%D0%B2%D0%B5%D1%80%D0%BA%D0%B0%22%7D&SessionID=...

Новое обсуждение(отзыв с оценкой):

Формат запроса:

SendMessage={"dttm":"21.12.2021 12:00","mes_type":"1","comment":"Проверка","star": "4"}&SessionID=

Строка запроса:

GET .../api/?SendMessage=%7B%22dttm%22%3A%2221.12.2021%2012%3A00%22,%22mes_type%22%3A%221%22,%22comment%22%3A%22%D0%9F%D1%80%D0%BE%D0%B2%D0%B5%D1%80%D0%BA%D0%B0%22,%22star%22%3A%20%224%22%7D&SessionID=...

где
dttm – дата/время(формат записи «01.01.2015 12:00»), обязательный параметр;
mes_type – тип сообщения(1 – отзыв, 2 – Жалоба, 3 – Пожелание, 4 - Некорректные данные, 5 – Вопрос), обязательный параметр;
comment – текст, обязательный параметр;
dor_id – ID заказа для создания отзыва о заказе, не обязательный параметр;
id – ID переписки, если новое сообщение в обсуждении или без него, если новое обсуждение, не обязательный параметр;
star – оценка (1 – ужасно, 2 – плохо, 3 – средне, 4 – хорошо, 5 – отлично, по умолчанию 0), не обязательный параметр;
call_back_me – просит перезвонить (0 – нет, 1 – да, по умолчанию 0), не обязательный параметр;
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0,
  "fl": 0,
  "id": "123"
}

где
fl – признак, что сообщение было создано как новая переписка (0), либо добавлено в существующую (1);
id – ID нового обсуждения, вернется если было создано новое осуждение.

GetActionList

Команда: GetActionList

Получение списка акций в ЛК.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Получение списка акций:

Формат запроса:

GetActionList={"act":"1"}&SessionID=

Строка запроса:

GET .../api/?GetActionList=%7B%22act%22%3A%221%22%7D&SessionID=...

где
Обязательный параметр act - тип акции (1 – список акций, 2 – картинка акции сертификата), обязательный параметр;
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0,
  "actions": [
    {
      "action_id": "1003",
      "act_type_id": "1",
      "date_begin": "24.04.2018",
      "date_end": "11.05.2022",
      "name": "1234",
      "short_detail": "%D0%BA%D1%80%D0%B0%D1%82%D0%BA%D0%B8%D0%B9%20%D1%82%D0%B5%D0%BA%D1%81%D1%82",
      "full_detail": "%D0%9F%D0%BE%D1%81%D0%BB%D0%BD%D1%8B%D0%B9%20%D1%82%D0%B5%D0%BA%D1%81%D1%82",
      "sclads_id": "1,1009,10015"
    }
  ]
}

где
action_id – ID акции;
act_type_id – тип акции (1 – распродажи, 2 – сертификаты, 3 – пакеты, 4 – бонусные пакеты);
date_begin – дата начала действия акции;
date_end – дата окончания действия акции;
name – наименование акции;
short_detail – краткое описание;
full_detail – полное описание.

Получение картинки акции сертификата:

Формат запроса:

GetActionList={"act":"2","action_id":"123"}&SessionID=

Строка запроса:

GET .../api/?GetActionList=%7B%22act%22%3A%222%22%2C%22action_id%22%3A%22123%22%7D&SessionID=...

где
act - тип акции (1 – список акций, 2 – картинка акции сертификата), обязательный параметр;
action_id – ID акции для act = 2, обязательный параметр;
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0,
  "actions": [
    {
      "action_id": "1002",
      "act_type_id": "3",
      "photo": ""
    }
  ]
}

где
action_id – ID акции;
act_type_id – тип акции (1 – распродажи, 2 – сертификаты, 3 – пакеты, 4 – бонусные пакеты);
photo – картинка в Base64.

Certificate

Команда: Certificate

Получение списка сертификатов в ЛК.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

Certificate={"id":"123"}&SessionID=

Строка запроса:

GET .../api/?Certificate=%7B%22id%22%3A%22123%22%7D&SessionID=...

где
id – ID сертификата, обязательный параметр. Если указан, то будет выбран конкретный сертификат;
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0,
  "certificate": [
    {
      "id": "1002",
      "name": "%D1%82%D0%B5%D1%81%D1%82%D0%BE%D0%B2%D1%8B%D0%B9%20%D1%81%D0%B5%D1%80%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%82",
      "dt_first": "03.05.2018",
      "dt_last": "03.05.2022",
      "comments": "",
      "price": "1800",
      "lines": [
        {
          "id": "1003",
          "tov_name": "%D0%91%D0%B5%D1%80%D0%BC%D1%83%D0%B4%D1%8B",
          "discount": "76,6",
          "qty": "2",
          "price_before": "1000",
          "price_after": "234"
        }
      ]
    }
  ]
}

где
certificate - массив сертификатов:
id – ID сертификата;
name – названия сертификата;
dt_first – дата начала действия;
dt_last – дата окончания действия;
comments – комментарий;
price – стоимость (из активирующей услуги);
lines – массив строк сертификатов (5 первых строк попадают):
id – ID строки сертификата;
tov_name – название услуги;
discount – скидка;
qty – количество;
price_before – цена до применения сертификата;
price_after – цена после применения сертификата.

CertificateLines

Команда: CertificateLines

Получение списка строк сертификатов.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

CertificateLines ={"id":"123"}&SessionID=

Строка запроса:

GET .../api/?CertificateLines=%7B%22id%22%3A%22123%22%7D&SessionID=...

где
id – ID сертификата, обязательный параметр;
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0,
  "certificate_lines": [
    {
      "id": "1003",
      "tov_name": "%D0%91%D0%B5%D1%80%D0%BC%D1%83%D0%B4%D1%8B",
      "discount": "76,6",
      "qty": "2",
      "price_before": "1000",
      "price_after": "234"
    }
  ]
}

где
id – ID строки сертификата;
tov_name – название услуги;
discount – скидка;
qty – количество;
price_before – цена до применения сертификата;
price_after – цена после применения сертификата.

ActiveCertificates

Команда: ActiveCertificates

Получение списка активных сертификатов клиента в ЛК.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

ActiveCertificates&SessionID=

Строка запроса:

GET .../api/?ActiveCertificates&SessionID=...

где
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0,
  "active_certificates": [
    {
      "id": "1002",
      "certificate_id": "1002",
      "promo_code": "9990000999",
      "cer_name": "%D1%82%D0%B5%D1%81%D1%82%D0%BE%D0%B2%D1%8B%D0%B9%20%D1%81%D0%B5%D1%80%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%82"
    }
  ]
}

где
id – ID активного сертификата клиента;
certificate_id – ID сертификата;
promo_code – промо-код активного сертификата;
cer_name – название сертификата.

CreatePayCertificate

Команда: CreatePayCertificate

Создание оплаты сертификата на клиента в ЛК.
При выполнении команды, выбирается активирующая услуга сертификата, создается заказ, в которой будет эта услуга. Увидеть заказ можно через команду Orders.
Оплачивается как обычный заказ на сумму сертификата.
Требуется предварительная настройка сертификата в программе Агбис.Химчистка и глобальных опций

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

CreatePayCertificate={"id":"123"}&SessionID=

Строка запроса:

GET .../api/?CreatePayCertificate=%7B%22id%22%3A%22123%22%7D&SessionID=...

где
id – ID сертификата, обязательный параметр;
SessionID - ID сессии, обязательный параметр.

Ответ json:

{
  "error": 0,
  "dor_id": "10023", 
  "doc_num": "00012-5"
}

где
dor_id – ID заказа, который нужно оплатить;
doc_num – номер заказа, который нужно оплатить.

Advertisment

Команда: Advertisment

Получение списка рекламных объявлений (Акции, Новости, Поздравления, Специальное предложение) в ЛК.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

Advertisment={"id":"123"}&SessionID=

Строка запроса:

GET .../api/?Advertisment=%7B%22id%22%3A%22123%22%7D&SessionID=...

где
id – ID объявления (если указано, то вернется конкретное объявление), не обязательный параметр;
type – тип объявления (1 – Новости, 2 – Акция, 3 - Специальное предложение, 4 - Поздравление), не обязательный параметр;
date_first – начало периода, не обязательный параметр;
date_last – конец периода, не обязательный параметр;
not_load_pic – не выгружать картинки (для быстрой обработки команды можно использовать равным 1, и в ответ не будут добавляться картинки. По-умолчанию 0), не обязательный параметр;
По умолчанию будут возвращены все объявления, которые действуют на сегодняшний день

Ответ json:

{
  "error": 0,
  "advertisments": [
    {
      "id": "10015",
      "type": "1",
      "description": "%D0%9D%D0%BE%D0%B2%D0%BE%D1%81%D1%82%D1%8C%201",
      "mes": "%D0%9D%D0%BE%D0%B2%D0%BE%D1%81%D1%82%D1%8C%201",
      "sub_mes": "%D0%9D%D0%BE%D0%B2%D0%BE%D1%81%D1%82%D1%8C%201",
      "barcode": "0",
      "img": [
        {
          "adv_id": "10015",
          "path": "img1.gif",
          "img64": ""
        }
      ]
    }
  ]
}

где
advertisments – массив объявлений:
id – ID объявления;
type – тип;
description – описание;
mes – текст в формате HTML (кодированный encodeURIComponent);
sub_mes – дополнительный текст;
barcode – штрихкод;
img – массив картинок:
adv_id – ID объявления, которому принадлежит картинка;
path – название картинки (по этому параметру, можно найти к какому тегу «img» в HTML принадлежит эта картинка);
img64 – картинка (картинка кодирована в строку Base64).

AdvertismentImg

Команда: AdvertismentImg

Получение всех картинок, которые есть в рекламном объявлении в ЛК.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

AdvertismentImg={"id":"123"}&SessionID=

Строка запроса:

GET .../api/?AdvertismentImg=%7B%22id%22%3A%22123%22%7D&SessionID=...

где
id – ID объявления (если указано, то вернется конкретное объявление), обязательный параметр;

Ответ json:

{
  "error": 0,
  "advertisments_img": [
    {
      "adv_id": "10015",
      "path": "img1.gif",
      "img64": "..."
    }
  ]
}

где
adv_id – ID объявления, которому принадлежит картинка;
path – название картинки (по этому параметру, можно найти к какому тегу «img» в HTML принадлежит эта картинка);
img64 – картинка (картинка кодирована в строку Base64).

PromoCodeUse

Команда: PromoCodeUse

Вернет используемый текущим клиентом промо-код в ЛК.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

PromoCodeUse&SessionID=

Строка запроса:

GET .../api/?PromoCodeUse&SessionID=...

Ответ json:

{
  "error": 0,
  "promo_code": "123",
  "discount_extrnl": "%D0%B1%D0%BE%D0%BD%D1%83%D1%81%20400",
  "discount": "0",
  "address": ""
}

где
promo_code – промо-код клиента;
discount_extrnl - наименование привязанной ВДС (внешней дисконтной схемы) к промо-коду;
discount - скидка ВДС;
address – выбранный адрес используемого промо-кода.

PromoCodeActivate

Команда: PromoCodeActivate

Активирует промо-код клиенту в ЛК.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

PromoCodeActivate={"PromoCode":"123", "dor_id":"12345"}&SessionID=

Строка запроса:

GET .../api/?PromoCodeActivate=%7B%22PromoCode%22%3A%22123%22%7D&%7B%22dor_id%22%3A%2212345%22%7D&SessionID=...

где
PromoCode - активируемый промо-код, обязательный параметр;
dor_id – ID заказа (для проверки кол-ва заказов клиента), необязательный параметр.

Ответ json:

{
  "error": 0,
  "Msg": "%D0%9F%D1%80%D0%BE%D0%BC%D0%BE-%D0%BA%D0%BE%D0%B4%20%D0%B0%D0%BA%D1%82%D0%B8%D0%B2%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD"
}

Entry

Команда: Entry

Отметка статистики входа клиента в ЛК (при регистрации или авторизации).

Метод отправки: GET

Формат запроса:

Entry={"type":"1"}&SessionID=

Строка запроса:

GET .../api/?Orders=%7B%22type%22%3A%221%22%7D&SessionID=...

где
type - тип входа в ЛК. 0 - при регистрации, 1 - при авторизации. Обязательный параметр

Ответ json:

{"error":0}

EntranceSite

Команда: EntranceSite

Отметка статистики заходов клиента в ЛК (Обновление страницы/вход по сохранной сессии, без авторизации).

Метод отправки: GET

Формат запроса:

EntranceSite&SessionID=

Строка запроса:

GET .../api/?EntranceSite&SessionID=...

Ответ json:

{"error":0}

OpenOrders

Команда: OpenOrders

Отметка статистики открытия заказа клиентом в ЛК (получение информации по заказу).

Метод отправки: GET

Формат запроса:

OpenOrders=&SessionID=

Строка запроса:

GET .../api/?OpenOrders&SessionID=...

Ответ json:

{"error":0}

OpenHistory

Команда: OpenHistory

Отметка статистики открытия истории заказа клиентом в ЛК (получение информации по заказу).

Метод отправки: GET

Формат запроса:

OpenHistory&SessionID=

Строка запроса:

GET .../api/?OpenHistory&SessionID=...

Ответ json:

{"error":0}

Устаревшие команды

В данном разделе находятся уже устаревшие команды, но еще работающие.

Через несколько лет они будут удалены.

Для избежания поломки уже интегрированных устаревших команд, рекомендуется сделать переход на соответствующую актуальную команду.

OrderConfirm

Устаревшая команда, больше не поддерживается

Команда: OrderConfirm

Подтверждение клиентом заказа. Обновленная команда OrderAppConfirm.

Метод отправки: GET

Заголовок запроса (Header): не требуется.

Формат запроса:

OrderConfirm={"dor_id":"12345"}&SessionID=

Строка запроса:

GET .../api/?OrderConfirm=%7B%22dor_id%22%3A%2212345%22%7D&SessionID=...

где
dor_id - ID заказа, обязательный параметр;
SessionID - ID сессии, обязательный параметр;

Ответ json:

{
  "error": 0, 
  "Msg": "%D0%9E%D0%BA"
}

где
Msg - сообщение.

Инструменты

меню и быстрый поиск

быстрый поиск

статус сайта

«хлебные крошки»

Инструменты страницы

мета-данные страницы

2. Команды API ТОЛЬКО с клиентской сессией

Работа с клиентом в ЛК

Работа с заказами клиента в ЛК

Работа с оплатой заказа в ЛК

Работа с общением клиента с химчисткой в ЛК

Работа с акциями, сертификатами, рекламными объявлениями в ЛК

Работа с промо-кодами

Работа со статистикой в ЛК

SaveInfo

SavePass

ConfirmCellPhone

Bonus

Deposit

Orders

OrdersHistory

FullOrderInfo

Services

FullService

OrderAppConfirm

CancelOrderApp

CancelOrder

DepositPay

BonusPay

TitleMessages

MessageList

CountNewMessages

SendMessage

GetActionList

Certificate

CertificateLines

ActiveCertificates

CreatePayCertificate

Advertisment

AdvertismentImg

PromoCodeUse

PromoCodeActivate

Entry

EntranceSite

OpenOrders

OpenHistory

Устаревшие команды

OrderConfirm