Создание потерянного заказа¶
Инструмент “Потерянные заказы” доступен для кэшбэков и программ лояльности. Для получения доступа требуется принять правила использования в разделе инструмента “Потерянные заказы”.
Параметры¶
HTTP метод | Права доступа | URL | Параметры | Примечание |
---|---|---|---|---|
POST | manage_lost_orders | https://api.admitad.com/lost_orders/create/ |
Список параметров для запроса | Возвращает созданный заказ.* |
- * Возвращает результат в формате JSON.
Список параметров для запроса¶
Название | Тип | Обязательный | Ограничения параметров | Допустимые значения |
---|---|---|---|---|
advcampaign | integer | ✔ | Список партнерских программ | |
website | integer | ✔ | Список площадок веб-мастера | |
order_id | string | ✔ | Максимальная длина 100 символа | |
order_date | date | ✔ | %d.%m.%Y | |
order_price | float | ✔ | ||
comment | string | ✔ | Максимальная длина 512 символа | |
appeal_id | string | Максимальная длина 100 символа | ||
estimated_reward | float | ✔ | ||
receipt | file | ✔ | JPEG/JPG/PNG/PDF |
Пример использования¶
Пример запроса с использованием утилиты curl:
curl -H 'Authorization: Bearer access_token' -X POST https://api.admitad.com/lost_orders/create/ \
-F 'website=1' \
-F 'advcampaign=1' \
-F 'order_id=YH123D' \
-F 'order_date=11.11.2016' \
-F 'order_price=1200' \
-F 'appeal_id=788aq' \
-F 'estimated_reward=7' \
-F 'receipt=@/example/DM89YVjMZY.jpg'
Пример ответа API-сервера в формате JSON:
{
"status": "processing",
"website": {
"id": 1,
"name": "TestWebsite"
},
"currency": "USD",
"order_id": "YH123D",
"advcampaign": {
"id": 1,
"name": "TestAdvCampaign"
},
"order_price": 1200,
"order_date": "2016-11-11T00:00:00",
"date_created": "2016-06-02T19:31:36",
"id": 6,
"comment": "",
"appeal_id": "788aq",
"appeal_status": "processing",
"estimated_reward": 7
}
Описание полей ответа API-сервера¶
Название | Описание |
---|---|
id | Идентификатор |
website | Площадка |
campaign | Программа |
status | Статус потерянного заказа |
order_id | Номер заказа |
order_date | Дата заказа |
order_price | Сумма заказа |
currency | Валюта |
comment | Комментарий |
date_created | Дата создания |
appeal_id | Идентификатор обращения |
appeal_status | Статус обращения |
estimated_reward | Предполагаемая сумма вознаграждения |