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

Тип

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"
}

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