Получение необходимых полей и параметров для формы формирования заказа
Описание
Прежде чем перейти к оформлению заказа, нужно получить данным запросом необходимые поля и данные пользователя. А именно массив 'addresses' с ранее используемыми адресами отгрузки, массив 'address_fields' списка полей, которые нужно заполнить, для отправки заказа на новый адрес, массив 'delivery' с перечнем способов доставки и массив 'payment' с вариантами способов оплаты.
Формат запроса
[api.ramis.ru/techapi/]?[get=order_form]&[token=ваш_токен]
Параметры запроса
| Параметр | Описание |
|---|---|
| api.ramis.ru/techapi/ | Путь к ресурсу |
| get=order_form | Метод получение необходимых полей и параметров для формы формирования заказа |
| token=ваш_токен | Токен пользователя |
Возвращаемые данные
В случае выполнения успешного запроса, возвращается массив с двумя элементами: 'status' со значением 'successful' означающем, что запрашиваемые данные получены и 'result' в котором представлены возвращаемые данные в виде значения или массива 'items' значений, элементы которых представлены в таблице.
| Элемент | Значение |
|---|---|
| id | Идентификатор адреса |
| name | Строковое значение адреса |
| address_fields | Массив полей нового адреса |
| name | Строковый идентификатор поля нового адреса |
| title | Наименование поля нового адреса |
| type | Тип поля нового адреса |
| delivery | Массив способов доставки |
| id | Идентификатор способа доставки |
| name | Наименование способа доставки |
| price | Стоимость способа доставки |
| type | Тип способа доставки |
| payment | Массив способов оплаты |
| id | Идентификатор способа оплаты |
| name | Наименование способа оплаты |
| type | Тип способа оплаты |
Возвращаемые ошибки
В случае не удачного выполнения запроса, возвращается массив с двумя элементами: 'status' со значение 'error' означающем, что запрашиваемые данные не получены и 'result' в котором представлены возвращаемые ошибки в виде массива значений, 'code' - код ошибки и 'message' - текстовое значение ошибки, данные которых представлены в таблице.
| Элемент | Значение |
|---|---|
| 100 | the name of the reference book is not set |
| 200 | token not found (токен не найден) |