Здесь показаны различия между двумя версиями данной страницы.
Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
rest_d [2022/12/14 12:11] timofeev |
rest_d [2022/12/14 13:05] (текущий) timofeev |
||
---|---|---|---|
Строка 12: | Строка 12: | ||
- | ==Журнал накладных== | + | ===Получение накладных=== |
- | GET /orders | + | [[rest_rn|получение списка накладных (GET /orders)]] |
- | Возможна фильтрация по формам расчетов. В массиве form_payments указываются коды или наименования во внешней системе. Слова CASH и CARD всегда интерпретируются как формы расчетов наличными и платежной картой (первые формы, имеющие соответствующие названия и настройки), другие наименования или коды во внешней системе должны быть указаны в справочнике Водяного "маркетинг - формы расчетов (нал., безнал.)".\\. | + | [[rest_rnakl_num|Накладная по номеру и дате]] |
- | <code> | + | |
- | http://127.0.0.1:10400/api/orders?date_gte='23.03.2020 08.00'&form_payments=[“CASHLESS”, “CHARITY”] | + | |
- | </code> | + | |
- | Ответ | + | |
- | <code> | + | |
- | { | + | |
- | "result": [ | + | |
- | { | + | |
- | "ID": "1000000000299", | + | |
- | "STATUS": "1", | + | |
- | "NOMER": "Т230320001", | + | |
- | "DATADOC": "23.03.2020 22:10:27", | + | |
- | "INFO": "Еременко ул,78", | + | |
- | "AUTOR": "1000000000002", | + | |
- | "DSZD": "22.03.2020 22:10:33", | + | |
- | "REDAKT": "1000000000002", | + | |
- | "DATAIZM": "23.03.2020 17:03:30", | + | |
- | "NEVYGRV1C": "0", | + | |
- | "OSNOVANIE": ".", | + | |
- | "FIRMA": "1000000000001", | + | |
- | "SUMMA_ITOG": "150", | + | |
- | "SKLAD": "1000000000001", | + | |
- | "KONTRAGENT": "1000000000027", | + | |
- | "DOGOVOR": "1000000000027", | + | |
- | "ADRES": "1000000000029", | + | |
- | "MAR": "1000000000002", | + | |
- | "FRMRAS": "1000000000002", | + | |
- | "STATUSZKZ": "1", | + | |
- | "SMENA": "1000000000002", | + | |
- | "DOKRASP": "0", | + | |
- | "DISP": "1000000000001", | + | |
- | "PDPDIR": "1000000000001", | + | |
- | "PDGLAVBUH": "1000000000004", | + | |
- | "PDOTVZAOF": "1000000000004", | + | |
- | "PROBIT": "0", | + | |
- | "POLUCH": "0", | + | |
- | "FAKTOT": "0", | + | |
- | "NVED": "0000000025", | + | |
- | "AVTOMOB": "1000000000001", | + | |
- | "EKSP": "1000000000005", | + | |
- | "VOD": "1000000000005", | + | |
- | "OTPUSTIL": "1000000000008", | + | |
- | "SAM": "0", | + | |
- | "EKSPRDST": "0", | + | |
- | "TIPCEN": "1000000000001", | + | |
- | "RS": "1000000000001", | + | |
- | "OTD_DOK": "0", | + | |
- | "POL_DOK": "0", | + | |
- | "VO_NAKL": "0", | + | |
- | "AKTIVPRD": "0", | + | |
- | "BONUSNA4ISL": "4,5", | + | |
- | "BONUSSPIS": "0", | + | |
- | "SUMBONUS": "0" | + | |
- | } | + | |
- | ], | + | |
- | "total": 1 | + | |
- | } | + | |
- | </code> | + | |
- | ===Заказы клиента за период с указанной даты==== | + | [[rest_rnakl_id|Накладная по идентификатору]] |
- | <code> | + | |
- | http://127.0.0.1:10400/api/orders?date_gte='23.03.2020 08.00'&kontr=1000000000001 | + | |
- | </code> | + | |
- | [[rest_rnakl_num|Заказ по номеру и дате]] | + | ===Создание и изменение, удаление накладных=== |
- | ==Создание накладной (заявки)== | + | [[rest_rn_post|Создание и изменение, удаление накладных]] |
- | POST /orders | + | |
- | <code> | + | |
- | POST http://127.0.0.1:10400/api/orders | + | |
- | </code> | + | |
- | Тело запроса | + | |
- | <code> | + | |
- | {"datadoc":"22.03.2020 10:05:00", | + | |
- | "planvrem":"22.03.2020 12:05:00", | + | |
- | "POLPLATKART":500, | + | |
- | "kontragent":1000000000001, | + | |
- | "adres":1000000000001, | + | |
- | "comment":"Оставить в кв. 22", | + | |
- | "TOVARY":[{"tovar":1000000000001,"kolvo":3}, | + | |
- | {"tovar":1000000000002,"kolvo":"1.25", "cena":"20","summa":"25.00"}], | + | |
- | "USLUGI":[{"usluga":1000000000001,"kolvo":1, "cena":"400.00","summa":"400.00"}], | + | |
- | "ZTARA":[{"tara":1000000000001,"kolvo":1, "cena":"350.00","summa":"350.00"}], | + | |
- | "PRDTARA":[{"tara":1000000000001,"kolvo":1, "cena":"300.00","summa":"300.00"}] | + | |
- | } | + | |
- | Здесь POLPLATKART - сумма платежа картой. Если заполнена, будет создан документ "Платёж банковской картой" на выбранную сумму.\\ | + | |
- | Массивы TOVARY, USLUGI, ZTARA, PRDTARA содержат, соответственно товары, услуги, тару выданную под залог и проданную по документу, при отсутствии, например, залоговой тары, соответствующий массив передавать не надо. | + | |
- | </code> | + | |
- | Ответ | ||
- | <code> | ||
- | {"result": 1000000000298} | ||
- | </code> | ||
- | Создана накладная с кодом 1000000000298. | ||
- | |||
- | |||
- | ==Создание ведомости доставки (назначение экипажа автомобиля на смену доставки)== | ||
- | Запрос | ||
- | <code> | ||
- | POST http://127.0.0.1:10400/api/crew | ||
- | </code> | ||
- | Тело запроса | ||
- | <code> | ||
- | {"avtomob":1000000000001, | ||
- | "smena":1000000000002, | ||
- | "vod":1000000000005, | ||
- | "eksp":1000000000005, | ||
- | "pomeksp":1000000000005, | ||
- | "datadoc":"22.03.2020 16:02:04.0"} | ||
- | </code> | ||
- | Ответ | ||
- | <code> | ||
- | ОК | ||
- | </code> | ||
- | |||
- | ==Получение шапки и состава накладной по идентификатору== | ||
- | GET /orders/:id | ||
- | |||
- | ==Изменение накладной (присоединение к ведомости доставки)== | ||
- | PATCH /orders/:id | ||
- | Запрос | ||
- | <code> | ||
- | http://127.0.0.1:10400/api/orders/1000000000299 | ||
- | </code> | ||
- | Тело запроса | ||
- | <code> | ||
- | {"crew":1000000000140, | ||
- | "planvrem":"22.03.2020 21:05:00" | ||
- | } | ||
- | </code> | ||
- | Здесь crew - код ведомости доставки\\ | ||
- | Будут созданы строки указанной ведомости доставки, соответствующие этой накладной. | ||
- | planvrem - расчетное время прибытия.\\ | ||
- | В запросе редактирования допустимы любые поля, кроме служебных (идентификатор, дата создания, изменения, автор и проч.).\\ | ||
- | ВАЖНО!!! НЕДОПУСТИМО передавать массивы табличных частей, эти параметры будут проигнорированы. При необходимости редактирования состава накладной ее следует удалить и создать заново. | ||
- | |||
- | Ответ | ||
- | <code> | ||
- | ОК | ||
- | </code> | ||
- | |||
- | ==Удаление накладной == | ||
- | <code> | ||
- | http://127.0.0.1:10400/api/orders/1000000000294 | ||
- | </code> | ||
- | |||
- | Ответ | ||
- | <code> | ||
- | ОК | ||
- | </code> | ||
- | При удалении накладной будут удалены строки ведомости доставки, соответствующие этой накладной. | ||
- | |||
- | ==Недоставленный заказ== | ||
- | POST /orders/:id/cancel | ||
- | |||
- | <code> | ||
- | POST http://127.0.0.1:10400/api/orders/1000000000298/cancel | ||
- | </code> | ||
- | тело запроса | ||
- | <code> | ||
- | {"comment":"звонили на все телефоны","prob":1} | ||
- | </code> | ||
- | Здесь comment- пояснение водителя, prob - код причины невыполнения заказа во внешней системе (эти коды должны быть указаны в справочнике "маркетинг - проблемные ситуации", в поле "код в мобильном приложении").\\ | ||
- | Ответ <code> | ||
- | ОК | ||
- | </code> | ||
- | Накладная переведена в состояние "не удалось выполнить", в поле "проблема" указана причина, соответствующая переданному коду, в поле "пояснение к проблеме" - текст поля "comment" из тела запроса. | ||
- | |||
- | ==Выполненный заказ== | ||
- | POST /orders/:id/complete | ||
- | |||
- | <code> | ||
- | POST http://127.0.0.1:10400/api/orders/1000000000298/complete | ||
- | </code> | ||
- | тело запроса | ||
- | <code> | ||
- | {"POLUCH":"200.00", | ||
- | "tara":1000000000001, | ||
- | "vztary":2} | ||
- | </code> | ||
- | Здесь poluch - сумма, полученная наличными, tara- код оборотной тары, vztary - количество возвращенной оборотной тары | ||
- | <code> | ||
- | ОК | ||
- | </code> | ||
- | Накладная переведена в состояние "выполнена" | ||
[[rest|REST-интерфейс для внешних систем]] | [[rest|REST-интерфейс для внешних систем]] | ||