RU
EN
ГЛАВНАЯ СТРАНИЦА

Курьеры

Запрос списка подразделений курьера

Возвращает список подразделений и их заметок, доступных пользователю с учетом его настроек прав доступа.

Тип

GET

Вызов

/get-courier-divsions

Параметры

user-id

GUID курьера, поле usr_ID из таблицы tp_Users.

Пример вызова

http://127.0.0.1:8090/get-courier-divisions?user-id=8051B912-B90C-1045-9AA9-05A049551B57

Формат возвращаемых данных

Список подразделений и список заметок каждого подразделения, если они есть.

[ 
    { 
        "dvsn_ID": "7917642D-FF72-3B47-8ED8-04052BC144CB", 
        "dvsn_seg_ID": "D6B05F5F-7896-3B4D-86DE-5CAC980C6D1A", 
        "objsecl_secl_ID": "9B72A384-F600-48FF-B5C3-A0CC3CC2F6F0", 
        "dvsn_Name": "WebService", 
        "dvsn_GeoIdentifier": "Гражданский проспект", 
        "currencyFormat": "0.00", 
        "notes": [ 
            { 
                "note_ID": "5DA9A8AE-8096-D748-B2EC-6F1021D44C37", 
                "note_nttp_ID": "85111822-4528-4945-8922-1085CC7BAC92", 
                "note_Item_ID": "7917642D-FF72-3B47-8ED8-04052BC144CB", 
                "note_obj_ID": "7917642D-FF72-3B47-8ED8-04052BC144CB", 
                "note_tpsyso_ID": "5266CFD0-0164-4D14-9EDC-C8FE2C041143", 
                "note_Date": "2018-07-11T17:42:45", 
                "note_Value": { 
                    "value": "30.0", 
                    "type": "double" 
                } 
            } 
        ] 
    }, 
    { 
        "dvsn_ID": "93D340DD-C157-B540-BF40-8633D588541A", 
        "dvsn_seg_ID": "D6B05F5F-7896-3B4D-86DE-5CAC980C6D1A", 
        "objsecl_secl_ID": "9B72A384-F600-48FF-B5C3-A0CC3CC2F6F0", 
        "dvsn_Name": "Гражданский проспект 2", 
        "dvsn_GeoIdentifier": "Гражданский проспект 2", 
        "currencyFormat": "0.00" 
    }, 
    { 
        "dvsn_ID": "AEE476E1-F90F-8C43-9435-8DF4EAA84CDD", 
        "dvsn_seg_ID": "D6B05F5F-7896-3B4D-86DE-5CAC980C6D1A", 
        "objsecl_secl_ID": "9B72A384-F600-48FF-B5C3-A0CC3CC2F6F0", 
        "dvsn_Name": "Парнас", 
        "dvsn_GeoIdentifier": "Парнас", 
        "currencyFormat": "0.00" 
    }, 
    { 
        "dvsn_ID": "BF4EBEB6-97D1-9647-9AFB-9CB5AE39DA0A", 
        "dvsn_seg_ID": "D6B05F5F-7896-3B4D-86DE-5CAC980C6D1A", 
        "objsecl_secl_ID": "9B72A384-F600-48FF-B5C3-A0CC3CC2F6F0", 
        "dvsn_Name": "Купчино", 
        "dvsn_GeoIdentifier": "Купчино", 
        "currencyFormat": "0.00" 
    }, 
    { 
        "dvsn_ID": "73F796C3-8652-6C4A-A197-BFE36A8F7222", 
        "dvsn_seg_ID": "D6B05F5F-7896-3B4D-86DE-5CAC980C6D1A", 
        "objsecl_secl_ID": "9B72A384-F600-48FF-B5C3-A0CC3CC2F6F0", 
        "dvsn_Name": "Девяткино", 
        "dvsn_GeoIdentifier": "Девяткино", 
        "currencyFormat": "0.00" 
    } 
]

Запрос списка курьеров

Возвращает список курьеров (tp_Users) и их заметок.

Тип

GET

Вызов

/get-couriers

Параметры

security-level-id

GUID грифа доступа подразделения. Необязательный параметр.

Пример вызова

http://127.0.0.1:8090/get-couriers?security-level-id=8051B912-B90C-1045-9AA9-05A049551B57

Формат возвращаемых данных

Список курьеров (сотрудников) и список заметок каждого сотрудника, если они есть.

Пример

[ 
    { 
        "usr_ID": "942AF580-6AE9-4D89-9465-7A348FB604E9", 
        "usr_usrr_ID": "EB1467C5-DC3A-43A1-A4FF-7FE63B3DE033", 
        "usr_lggr_ID": "E5FE29B9-CF69-6541-8742-62355A61D6E6", 
        "usr_Name": "Администратор", 
        "usr_Description": "Автоматически создано", 
        "usr_Login": "админ", 
        "usr_SimpleLogonEnabled": false, 
        "usr_IsDisabled": false 
    }, 
    { 
        "usr_ID": "8F7774C7-2F42-894F-8CBD-C5F02ADEB896", 
        "usr_usrr_ID": "EB1467C5-DC3A-43A1-A4FF-7FE63B3DE033", 
        "usr_Name": "Test", 
        "usr_Login": "test", 
        "usr_SimpleLogonEnabled": true, 
        "usr_IsDisabled": false, 
        "notes": [ 
            { 
                "note_ID": "493E6B10-AFA7-CC47-9E4F-E441B7776DDC", 
                "note_nttp_ID": "C2C5038E-BFA1-5449-ACA7-6EE203B8CA5B", 
                "note_Item_ID": "8F7774C7-2F42-894F-8CBD-C5F02ADEB896", 
                "note_obj_ID": "8F7774C7-2F42-894F-8CBD-C5F02ADEB896", 
                "note_tpsyso_ID": "EE72F1AD-26D2-48EE-8025-BD8642138C33", 
                "note_Date": "2020-04-29T11:48:49", 
                "note_Value": { 
                    "value": "тест", 
                    "type": "string" 
                } 
            } 
        ] 
    } 
]

Добавление и изменение курьеров

Тип

POST

Вызов

/update-courier

Параметры

name

Имя курьера.

Параметр name обязателен при добавлении или при изменении курьера и необязателен при удалении курьера.

id

GUID курьера.

Параметр id обязателен при изменении или при удалении курьера и необязателен при добавлении курьера.

external-id

Идентификатор (ID) курьера во внешней системе.

Параметр external-id нужно задать, если нужно работать с существующими идентификаторами (id) курьеров во внешней системе.

Если курьер добавляется из сторонней системы, нужно обязательно передать external-id курьера при добавлении и в дальнейшем работать с этим external-id. В этом случае параметр id не требуется.

Предупреждение

При работе с параметром external-id обязательно нужно настроить тип заметки для внешнего id курьера в устройстве, иначе будет ошибка.

phone

Номер телефона курьера.

Если параметр phone задан, для устройства обязательно нужно указать группу персональных данных.

to-delete

Флаг удаления. Доступные значения true и false.

Параметр необязательный. Значение по умолчанию: false.

Пример вызова

http://127.0.0.1:8090/update-courier?id=8051B912-B90C-1045-9AA9-05A049551B57&to-delete=false&name=NewName&phone=9991112

Формат возвращаемых данных

Если курьер был успешно создан, то вернется его GUID.

{
  "courier_id": "CBBCAAB1-111C-4DF8-9DE3-4AD247590D90"
}

Если было успешное изменение или удаление, вернется просто 200, или 500 при ошибке.

Запрос списка счетов курьера

Возвращает все незакрытые счета доставки подразделения и закрытые счета открытого торгового дня, если передано подразделение.

Тип

GET

Вызов

/get-courier-deliveries

Параметры

user-id

GUID курьера (сотрудника).

division-id

GUID подразделения (для фильтрации по подразделению). Необязательный параметр.

Пример вызова

http://127.0.0.1:8090/get-courier-deliveries?user-id=E1D526BE-56F4-4C40-A169-2FEFD9D7679C&division-id=40F5D695-D2F3-C34A-83EF-65B7A7B145FE

Формат возвращаемых данных

Список гостевых счетов, каждый из которых содержит структуру гостевого счета.

Пример

[
    {
        "gest_ID": "51F068AF-B9CE-044A-AE42-F2C7BD229858",
        "gest_dvsn_ID": "7917642D-FF72-3B47-8ED8-04052BC144CB",
        "gest_clnt_ID": "564BD7E4-AEFD-8991-F34D-440FE3627639",
        "gest_usr_ID": "942AF580-6AE9-4D89-9465-7A348FB604E9",
        "gest_dev_ID": "D263A172-4D18-BC4A-AF9C-9CD5F61732E7",
        "gest_gsst_ID": 4,
        "gest_DateOpen": "2018-07-18T18:45:06",
        "gest_DateClose": "2018-07-18T18:45:06",
        "gest_Name": "YES001",
        "gest_ClientName": "GuestTest",
        "gest_ClientPhone": "7(098)673-47-52",
        "gest_ClientAddress": "<Address><Village Caption=\"Город\" Key=\"True\">Санкт-Петербург</Village><Street Caption=\"Улица\" Key=\"True\">Ленина</Street><House Caption=\"Дом\" Key=\"True\">1</House><Building Caption=\"Корпус\" Key=\"True\">1</Building><Apartment Caption=\"Квартира\" Key=\"True\">12</Apartment><Entrance Caption=\"Подъезд\">1</Entrance><Floor Caption=\"Этаж\">2</Floor><Intercom Caption=\"Домофон\">24</Intercom><Comment Caption=\"Комментарий\">комментарий</Comment></Address>",
        "gest_Comment": "Первая строка Вторая строка",
        "guestDeliveries": {
            "gsdlv_gest_ID": "51F068AF-B9CE-044A-AE42-F2C7BD229858",
            "gsdlv_usr_ID_Courier": "D0ECCA5E-B2B7-4F46-9BC2-5BF81FC5908E",
            "gsdlv_dlvrst_ID": 7,
            "gsdlv_dlvrmt_ID": 1,
            "gsdlv_cncpt_ID": "B719499B-9DFC-BA47-B027-0F390028946E",
            "gsdlv_pytp_ID_Prepaid": "69E60F44-033D-CA4C-AA92-4A165CA93587",
            "gsdlv_Date": "2018-07-18T17:45:07",
            "gsdlv_IsAutoStart": false,
            "gsdlv_CookingTime": 1800,
            "gsdlv_DeliveryTime": 1800,
            "gsdlv_SendSooner": true,
            "gsdlv_NeedConfirmation": true,
            "gsdlv_CashAmount": 5555.0,
            "gsdlv_PayDescription": "description",
            "gsdlv_GeoRegionID": "10"
        },
        "orders": [
            {
                "ordr_ID": "65198443-6AA4-554A-BC29-7ACF07A97742",
                "ordr_gest_ID": "51F068AF-B9CE-044A-AE42-F2C7BD229858",
                "ordr_usr_ID": "942AF580-6AE9-4D89-9465-7A348FB604E9",
                "ordr_usr_ID_Operator": "942AF580-6AE9-4D89-9465-7A348FB604E9",
                "ordr_dev_ID": "D263A172-4D18-BC4A-AF9C-9CD5F61732E7",
                "ordr_dvsn_ID": "7917642D-FF72-3B47-8ED8-04052BC144CB",
                "ordr_arch_ID": "5899755A-61DA-F646-88F7-B78D660C39F2",
                "ordr_orst_ID": 1,
                "ordr_Date": "2018-07-20T10:13:37",
                "ordr_Name": "01",
                "orderItems": [
                    {
                        "orit_ID": "43BB2B77-005E-954F-8E29-0D3880FA08FF",
                        "orit_ordr_ID": "65198443-6AA4-554A-BC29-7ACF07A97742",
                        "orit_mitm_ID": "B981C624-DA3A-F846-B35D-6D07E8A974FA",
                        "orit_mvtp_ID": "5224EB11-E8BE-1846-98C6-895B4B449B91",
                        "orit_slgr_ID": "25E3A39D-43E3-E840-8CCC-ED0DC12A4A37",
                        "orit_pcit_ID": "E53D0162-A1F0-4516-A62F-FA4635280537",
                        "orit_Volume": 1.0,
                        "orit_Count": 1,
                        "orit_Price": 10.5,
                        "orit_PriceDiscount": 4.5,
                        "orit_PriceMargin": 0.0,
                        "orit_VAT": 0.0,
                        "orit_PriceVat": 0.0,
                        "orit_Order": 1,
                        "orit_IsUnspentCredit": false,
                        "orderItemDiscounts": {
                            "oritd_ID": "920CE619-1A2A-4331-9532-5EBB27ADFA5D",
                            "oritd_orit_ID": "43BB2B77-005E-954F-8E29-0D3880FA08FF",
                            "oritd_dstp_ID": "BB2C3AB3-9A9B-A347-B6F8-73C77538DD54",
                            "oritd_Price": 10.5,
                            "oritd_PriceDiscount": 4.5,
                            "oritd_PriceMargin": 0.0,
                            "oritd_Order": 1
                        }
                    },
                    {
                        "orit_ID": "55133698-FF0C-5B4F-9F2F-784C03CCCD12",
                        "orit_ordr_ID": "65198443-6AA4-554A-BC29-7ACF07A97742",
                        "orit_mitm_ID": "FBE3CE39-94AA-D149-A993-1628A1092830",
                        "orit_mvtp_ID": "5224EB11-E8BE-1846-98C6-895B4B449B91",
                        "orit_slgr_ID": "25E3A39D-43E3-E840-8CCC-ED0DC12A4A37",
                        "orit_pcit_ID": "AC00EE79-9646-48B6-BA88-103DCBDA40A7",
                        "orit_Volume": 1.0,
                        "orit_Count": 1,
                        "orit_Price": 52.5,
                        "orit_PriceDiscount": 22.5,
                        "orit_PriceMargin": 0.0,
                        "orit_VAT": 0.0,
                        "orit_PriceVat": 0.0,
                        "orit_Order": 0,
                        "orit_IsUnspentCredit": false,
                        "orderItemDiscounts": {
                            "oritd_ID": "87A00C57-8FA7-4B6C-A4E1-F232833574D6",
                            "oritd_orit_ID": "55133698-FF0C-5B4F-9F2F-784C03CCCD12",
                            "oritd_dstp_ID": "BB2C3AB3-9A9B-A347-B6F8-73C77538DD54",
                            "oritd_Price": 52.5,
                            "oritd_PriceDiscount": 22.5,
                            "oritd_PriceMargin": 0.0,
                            "oritd_Order": 1
                        }
                    },
                    {
                        "orit_ID": "08BC411F-8786-CC4E-9813-E4BD76DF040B",
                        "orit_ordr_ID": "65198443-6AA4-554A-BC29-7ACF07A97742",
                        "orit_mitm_ID": "D40DF381-FAE8-7243-8A72-7CEA2CFE02DA",
                        "orit_mvtp_ID": "5224EB11-E8BE-1846-98C6-895B4B449B91",
                        "orit_slgr_ID": "25E3A39D-43E3-E840-8CCC-ED0DC12A4A37",
                        "orit_pcit_ID": "DBFC47EE-3A74-439B-B072-B177A93D11F4",
                        "orit_Volume": 1.0,
                        "orit_Count": 1,
                        "orit_Price": 0.0,
                        "orit_PriceDiscount": 0.0,
                        "orit_PriceMargin": 0.0,
                        "orit_VAT": 0.0,
                        "orit_PriceVat": 0.0,
                        "orit_Order": 2,
                        "orit_IsUnspentCredit": false
                    }
                ]
            }
        ],
        "notes": [
            {
                "note_ID": "80DE9C90-A8F0-4289-9368-D72523FEC999",
                "note_nttp_ID": "60D367B5-15D2-D24D-8A74-A28F40C8CB9D",
                "note_Item_ID": "51F068AF-B9CE-044A-AE42-F2C7BD229858",
                "note_obj_ID": "51F068AF-B9CE-044A-AE42-F2C7BD229858",
                "note_tpsyso_ID": "7F40833C-3722-4502-BC11-45EC786A4621",
                "note_Date": "2018-07-20T10:13:04",
                "note_Value": {
                    "value": "45.0",
                    "type": "double"
                }
            },
            {
                "note_ID": "F641A6F5-4953-4C33-9A1D-3E71B92FF5CA",
                "note_nttp_ID": "0412C97B-AF11-2447-88D9-B40FA0EB996D",
                "note_Item_ID": "51F068AF-B9CE-044A-AE42-F2C7BD229858",
                "note_obj_ID": "51F068AF-B9CE-044A-AE42-F2C7BD229858",
                "note_tpsyso_ID": "7F40833C-3722-4502-BC11-45EC786A4621",
                "note_Date": "2018-07-20T10:13:05",
                "note_Value": {
                    "value": "27.0",
                    "type": "double"
                }
            }
        ]
    }
]

Запрос списка открытых смен

Возвращает список открытых смен (tp_UserLocationPresence).

Тип

GET

Вызов

/get-courier-location-presence

Параметры

user-id

Идентификатор курьера (сотрудника).

division-id

Идентификатор подразделения.

location-id

Идентификатор местоположения.

Подсказка

Один из параметров должен быть обязательно передан, иначе будет возвращена ошибка.

Если передан параметр division-id, у этого подразделения должно быть заполнено местоположение.

Пример вызова

http://127.0.0.1:8090/get-courier-location-presence?user-id=D0ECCA5E-B2B7-4F46-9BC2-5BF81FC5908E&division-id=DBF6851C-B392-450D-AD4E-AD5038D9F6C2&location-id=8051B912-B90C-1045-9AA9-05A049551B57

Формат возвращаемых данных

Список открытых смен (tp_UserLocationPresence)

Пример

[ 
  { 
    "uslp_ID": "DBF6851C-B392-450D-AD4E-AD5038D9F6C2", 
    "uslp_usr_ID": "D0ECCA5E-B2B7-4F46-9BC2-5BF81FC5908E", 
    "uslp_loc_ID": "8051B912-B90C-1045-9AA9-05A049551B57", 
    "uslp_DateBegin": "2020-04-29T10:14:07" 
  } 
]

Открытие и закрытие смены

Тип

POST

Вызов

/set-courier-location-presence

Параметры

division-id

GUID подразделения.

location-id

GUID местоположения.

to-open

Тип операции. Обязательный параметр.

Возможные значения: true - открыть смену, false - закрыть смену.

user-id

Идентификатор сотрудника. Задается, если в поле usr_SimpleLogonEnabled указано значение true.

login

Логин сотрудника (поле usr_Login). Задается, если в поле usr_SimpleLogonEnabled указано значение false.

password

Пароль пользователя в формате base64, если есть.

Один из параметров division-id или location-id должен быть обязательно передан, иначе будет возвращена ошибка.

Если передан division-id, то у этого подразделения должно быть заполнено местоположение.

Если будут переданы параметры user-id и login, то значение параметра login получит приоритет. Один из этих параметров обязателен.

Пример вызова

http://127.0.0.1:8090/set-courier-location-presence?location-id=8051B912-B90C-1045-9AA9-05A049551B57&to-open=true&login=Login&password=dGVzdA

Формат возвращаемых данных

Возвращается http-код 200, если регистрация прошла успешно, иначе http-ответ 500 с текстом ошибки.

Проверка авторизации

Тип

GET

Вызов

/check-logon

Параметры

user-id

Идентификатор сотрудника. Задается, если в поле usr_SimpleLogonEnabled указано значение true.

login

Логин сотрудника (поле usr_Login). Задается, если в поле usr_SimpleLogonEnabled указано значение false.

password

Пароль пользователя в формате base64, если есть.

Если будут переданы параметры user-id и login, то значение параметра login получит приоритет. Один из этих параметров обязателен.

Пример вызова

http://127.0.0.1:8090/check-logon?login=Login&password=dGVzdA 

Формат возвращаемых данных

Возвращается http-код 200, если регистрация прошла успешно, иначе http-ответ 500 с текстом ошибки.

Закрытие счета доставки

Тип

PUT

Вызов

/close-delivery

Параметры

guest-id

Идентификатор гостевого счета доставки.

date-closed

Дата закрытия гостевого счета доставки в формате yyyy-MM-dd'T'HH:mm:ss. Необязательный параметр.

user-id

Идентификатор сотрудника. Задается, если в поле usr_SimpleLogonEnabled указано значение true.

login

Логин сотрудника (поле usr_Login). Задается, если в поле usr_SimpleLogonEnabled указано значение false.

password

Пароль пользователя в формате base64, если есть.

Если будут переданы параметры user-id и login, то значение параметра login получит приоритет. Один из этих параметров обязателен.

Пример вызова

http://127.0.0.1:8090/close-delivery?guest-id=51F068AF-B9CE-044A-AE42-F2C7BD229858&date-closed=2020-04-29T12:00:00&login=Login&password=dGVzdA

Формат возвращаемых данных

Возвращается http-код 200, если регистрация прошла успешно, иначе http-ответ 500 с текстом ошибки.

Проверки счета

  1. Статус счета «В оплате».

    gest_gsst_ID = 4
  2. Нет заказов в статусе «Не готов».

    ordr_orst_ID <> 0
  3. Статус доставки:

    3.a.

    При типе доставки «Доставка курьером» статус доставки должен быть «В пути».

    if gsdlv_dlvrmt_ID = 1 => gsdlv_dlvrst_ID = 7
    3.b.

    При типе доставки «Самовывоз» статус доставки должен быть «Ждет отправки», либо «Начали готовить».

    if gsdlv_dlvrmt_ID = 2 => gsdlv_dlvrst_ID in (5,6)
  4. Если не удовлетворяет условиям – будет возвращена ошибка с соответствующим текстом.

Отмена закрытия счета доставки

Тип

PUT

Вызов

/open-delivery

Параметры

guest-id

Идентификатор гостевого счета доставки.

user-id

Идентификатор сотрудника. Задается, если в поле usr_SimpleLogonEnabled указано значение true.

login

Логин сотрудника (поле usr_Login). Задается, если в поле usr_SimpleLogonEnabled указано значение false.

password

Пароль пользователя в формате base64, если есть.

Если будут переданы параметры user-id и login, то значение параметра login получит приоритет. Один из этих параметров обязателен.

Пример вызова

http://127.0.0.1:8090/open-delivery?guest-id=51F068AF-B9CE-044A-AE42-F2C7BD229858&login=Login&password=dGVzdA

Формат возвращаемых данных

Возвращается http-код 200, если регистрация прошла успешно, иначе http-ответ 500 с текстом ошибки.

Проверки счета

  1. Статус счета «Закрыт»

    gest_gsst_ID = 1
  2. Статус доставки «Закрыта»

    gsdlv_dlvrst_ID = 1
  3. Если не удовлетворено условиям – будет возвращена ошибка с соответствующим текстом.