Wiki
Clone wikivozimby-php-api / receipt-cru
Создание и редактирование отправления
Работает по адресу api/receiptCRU и принимает следующие параметры:
| Параметр | Тип | Описание |
|---|---|---|
| username | Имя пользователя (лк) | |
| password_hash | Пароль пользователя (лк) | |
| Receipt[id] | Номер заявки (неактуально при создании) | |
| Receipt[good_name] | Наименование груза | |
| Receipt[real_weight] | Вес, кг | |
| Receipt[size_w] | Ширина, см. | |
| Receipt[size_l] | Длинна, см. | |
| Receipt[size_h] | Высота, см. | |
| Receipt[additional] | Дополнительная инф. | |
| Receipt[receipt_calculation_type] | Тип калькуляции (см. перечисление ReceiptCalculationType) | |
| Receipt[good_cost] | Оценочная стоимость груза, б.р. | |
| Receipt[order_receive] | Забрать у получателя за доставку, б.р. | |
| Receipt[cost_delivery_type] | Тарифный план (см. перечисление ReceiptCdt) | |
| Receipt[date_delivery] | Дата доставки (YYYY-MM-DD) | |
| Receipt[who_pays] | Кто оплачивает доставку (см. перечисление ReceiptWhoPays ) | |
| Receipt[type_id] | Вид товара (обязателен при ИМ. - см. api/rulesJson) | |
| Receipt[receiver_fio] | ФИО получателя | |
| Receipt[receiver_org_name] | Организация получателя | |
| Receipt[receiver_city] | Код города получателя (см. api/cityList) | |
| Receipt[receiver_deviation] | Отклонение от города получателя, км. | |
| Receipt[receiver_other_city] | Наименование нас. пункта (отклонения) | |
| Receipt[receiver_address] | Адрес получателя | |
| Receipt[receiver_contact1_array][] | Список телефонов получателя | |
| Receipt[receiver_passport_s] | Серия паспорта получатея | |
| Receipt[receiver_passport_n] | Номер паспорта получателя | |
| Receipt[receiver_delivery18] | Услуга "доставка до 18:00" | |
| Receipt[receiver_loadhelp] | Услуга "помощь в погрузке" |
Процесс создания отправления сводится к отправлению POST массива на указанный адрес. Также следует учитывать что отправление не всегда доступно к редактированию (в зависимости от даты доставки статуса и других особенностей).
При обновлении следует указывать параметр Receipt[id], иначе будет создано новое отправление.
Перечисление ReceiptCalculationType:
| Константа | Описание |
|---|---|
| 1 | интернет-магазин |
| 2 | посылок/грузов |
Перечисление ReceiptCdt:
| Константа | Описание |
|---|---|
| 1 | Экспресс |
| 2 | Стандарт |
| 3 | Эконом |
Перечисление ReceiptWhoPays:
| Константа | Описание |
|---|---|
| 0 | Отправитель |
| 1 | Получатель |
Ответ приходит в формате JSON и содержит следующие поля:
| Параметр | Описание |
|---|---|
| status | физ. статус |
| body | данные ответа |
Поле body содержит следующую структуру:
| Поле | Описание |
|---|---|
| status | текстовый статус запроса |
| code | номер статуса запроса |
| reason | текстовое описание причины отказа в обработке (если такова есть) |
| errors | список ошибок которые необходимо исправить (если они существуют) |
| id | UID созданой либо обновленной заявки |
Updated