Добавление в Избранное
Общие сведения
Сервис позволяет добавлять заказы в список избранных заказов и удалять их из него.
Избранные заказы
Запрос метода
Структура запроса
Адрес метода: https://api.dellin.ru/v2/favorites/add.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000", "orderID":"345235" }
Адрес метода: https://api.dellin.ru/v2/favorites/add.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionid>00000000-0000-0000-0000-000000000000</sessionid> <orderid>345235</orderid> </request>
Описание параметров
Request
Request | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
appkey | Да | string | Ключ приложения. Для получения ключа необходимо пройти регистрацию |
sessionID | Да | string | ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя" |
orderID | Да | string | Номер заказа, который необходимо добавить в избранное |
Ответ метода
Структура ответа
{ "metadata":{ "status":200, "generated_at":"2020-04-01 07:47:32" }, "data":"ok" }
<response> <metadata> <status>200</status> <generated_at>2020-04-01 07:47:32</generated_at> </metadata> <data>ok</data> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Системная информация |
metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK) |
metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
data | string | Подтверждение успешности операции. Возможное значение - "ok" (операция успешно завершена) |
Обработка ошибок
В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".
Удаление заказа из избранного
Запрос метода
Структура запроса
Адрес метода: https://api.dellin.ru/v2/favorites/delete.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000", "orderID":"345235" }
Адрес метода: https://api.dellin.ru/v2/favorites/delete.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionid>00000000-0000-0000-0000-000000000000</sessionid> <orderid>345235</orderid> </request>
Описание параметров
Request
Request | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
appkey | Да | string | Ключ приложения. Для получения ключа необходимо пройти регистрацию |
sessionID | Да | string | ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя" |
orderID | Да | string | Номер заказа, который необходимо удалить из избранного |
Ответ метода
Ответ метода "Удаление заказа из избранного" аналогичен ответу метода "Добавление заказа в избранное".
Обработка ошибок
В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".