Потерянные заказы

Список потерянных заказов

Инструмент «Потерянные заказы» доступен для кэшбэков и программ лояльности. Для получения доступа требуется принять правила использования в разделе инструмента «Потерянные заказы».

Параметры

HTTP метод	Права доступа	URL	Параметры	Примечание
GET	lost_orders	`https://api.admitad.com/lost_orders/`	Возвращает список потерянных заказов	Возвращает список потерянных заказов*.
GET	lost_orders	`https://api.admitad.com/lost_orders/{id}/`		Возвращает потерянный заказ*, где id — это идентификатор потерянного заказа.

* Возвращает результат в формате JSON.

Список параметров для запроса

Название	Тип	Допустимые значения
advcampaign	integer	Список партнерских программ
website	integer	Список площадок веб-мастера
status	string	accepted processing rejected
limit	integer	Параметры limit, offset
offset	integer	Параметры limit, offset
start_date	date	%d.%m.%Y
end_date	date	%d.%m.%Y
appeal_id	string
appeal_status	string	resolved processing

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/lost_orders/?limit=1

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/lost_orders/3/

Пример ответа API-сервера в формате JSON:

{

    "results": [

        {

            "status": "processing",

            "website": {

                "id": 1,

                "name": "TestWebsite"

            },

            "order_id": "574T32EDD1H1",

            "advcampaign": {

                "id": 1,

                "name": "TestAdvCampaign"

            },

            "currency": "USD",

            "order_price": 230,

            "order_date": "2016-01-01T00:00:00",

            "date_created": "2016-06-02T19:31:36",

            "id": 3,

            "comment": "",

            "appeal_id": "",

            "appeal_status": "processing",

            "estimated_reward": 7

        }

    ],

    "_meta": {

        "count": 3,

        "limit": 1,

        "offset": 0

    }

}

Описание полей ответа API-сервера

Название	Описание
id	Идентификатор
website	Площадка
campaign	Программа
status	Статус потерянного заказа
order_id	Номер заказа
order_date	Дата заказа
order_price	Сумма заказа
comment	Комментарий
date_created	Дата создания
currency	Валюта
reject_reason	Причина отклонения
reject_comment	Комментарий
reward	Вознаграждение
appeal_id	Идентификатор обращения
appeal_status	Статус обращения
estimated_reward	Предполагаемая сумма вознаграждения

Создание потерянного заказа

Параметры

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	Предполагаемая сумма вознаграждения

Список статусов заказов

Параметры

HTTP метод	Права доступа	URL	Параметры	Примечание
GET	lost_orders	`https://api.admitad.com/lost_orders/payments_info/`	Список параметров для запроса	Возвращает информацию о статусах заказов

* Возвращает результат в формате JSON.

Список параметров для запроса

Название	Тип	Допустимые значения
advcampaign	integer	Список партнерских программ
order_id	integer	Один или несколько индетификаторов заказов. Максимум 20

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/lost_orders/payments_info/?advcampaign=8&order_id=test&order_id=q1234&order_id=1002247

Пример ответа API-сервера в формате JSON:

{

    "order_info": [

        {

            "order_id": "test",

            "status": "does_not_exist"

        },

        {

            "order_id": "q1234",

            "payment_id": 268,

            "payment_status": "approved",

            "status": "owner"

        },

        {

            "order_id": "1002247",

            "status": "already_counted"

        }

    ]

}

Описание полей ответа API-сервера

Название	Описание
status	Информация о статусе поиска заказа. Принимает значения (owner — если заказ есть у программы, already_counted — если заказ есть, но он принадлежит другому пользователю, does_not_exist — у программы нет такого заказа)
payment_status	Статус заказа
payment_id	Идентификатор заказа

Список апелляций

Для получения доступа требуется принять правила использования в разделе инструмента «Потерянные заказы».

Параметры

HTTP метод	Права доступа	URL	Параметры	Примечание
GET	lost_orders	`https://api.admitad.com/appeals/`	Список параметров для запроса	Возвращает список апелляций*.
GET	lost_orders	`https://api.admitad.com/appeals/{id}/`		Возвращает апелляцию, где id — это идентификатор апелляции.

* Возвращает результат в формате JSON.

Список параметров для запроса

Название	Тип	Допустимые значения
advcampaign	integer	Список партнерских программ
website	integer	Список площадок веб-мастера
status	string	accepted processing rejected
limit	integer	Параметры limit, offset
offset	integer	Параметры limit, offset
start_date	date	%d.%m.%Y
end_date	date	%d.%m.%Y
appeal_id	string

Пример исспользования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/appeals/?limit=1

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/appeals/3/

Пример ответа API-сервера в формате JSON:

{

    "results": [

        {

            "status": "processing",

            "website": {

                "id": 1,

                "name": "TestWebsite"

            },

            "order_id": "574T32EDD1H1",

            "advcampaign": {

                "id": 1,

                "name": "TestAdvCampaign"

            },

            "currency": "USD",

            "order_price": "230.00",

            "order_date": "2016-01-01T00:00:00",

            "date_created": "2016-06-02T19:31:36",

            "id": 3,

            "comment": "example",

            "appeal_id": "",

            "appeal_status": "processing",

            "estimated_reward": "20.00"

        }

    ],

    "_meta": {

        "count": 3,

        "limit": 1,

        "offset": 0

    }

}

Описание полей ответа API-сервера

Название	Описание
id	Идентификатор
website	Площадка
campaign	Программа
status	Статус потерянного заказа
order_id	Номер заказа
order_date	Дата заказа
order_price	Сумма заказа
comment	Комментарий
date_created	Дата создания
currency	Валюта
reward	Вознаграждение
appeal_id	Идентификатор обращения
estimated_reward	Предполагаемая сумма вознаграждения

Создание апелляции

Для получения доступа требуется принять правила использования в разделе инструмента «Потерянные заказы».

Параметры

HTTP метод	Права доступа	URL	Параметры	Примечание
POST	manage_lost_orders	`https://api.admitad.com/appeals/create/`	Список параметров для запроса	Возвращает созданную апелляцию*.

* Возвращает результат в формате JSON.

Список параметров для запроса

Название	Тип	Обязательный	Ограничения параметров	Допустимые значения
advcampaign	integer	✔		Список партнерских программ
order_id	string	✔	Максимальная длина 100 символа
comment	string	✔	Максимальная длина 512 символа
appeal_id	string		Максимальная длина 100 символа
receipt	file	✔	JPEG/JPG/PNG/PDF

Пример использования

Пример запроса с использованием утилиты curl:

curl -H 'Authorization: Bearer access_token Accept: application/json' -X POST https://api.admitad.com/appeals/create/ \

     -F 'advcampaign=1' \

     -F 'order_id=YH123D' \

     -F 'comment=example' \

     -F 'appeal_id=788aq' \

     -F 'receipt=@/example/receipt.png'

Пример ответа API-сервера в формате JSON:

{

    "status": "processing",

    "website": {

        "id": 1,

        "name": "TestWebsite"

    },

    "currency": "USD",

    "order_id": "YH123D",

    "advcampaign": {

        "id": 1,

        "name": "TestAdvCampaign"

    },

    "order_price": "1200.00",

    "order_date": "2016-11-11T00:00:00",

    "date_created": "2016-06-02T19:31:36",

    "id": 6,

    "comment": "example",

    "appeal_id": "788aq",

    "appeal_status": "processing",

    "estimated_reward": "1000",

}

Описание полей ответа API-сервера

Название	Описание
id	Идентификатор
website	Площадка
advcampaign	Программа
status	Статус потерянного заказа
order_id	Номер заказа
order_date	Дата заказа
order_price	Сумма заказа
currency	Валюта
comment	Комментарий
date_created	Дата создания
appeal_id	Идентификатор обращения
estimated_reward	Предполагаемая сумма вознаграждения