# Потерянные заказы
# Список потерянных заказов <span id="list-of-lost-orders" />

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

## Параметры <span id="list-of-lost-orders-parameters" />

| HTTP метод | Права доступа                               | URL                                        | Параметры                                                                               | Примечание                                                                   |
| ---------- | ------------------------------------------- | ------------------------------------------ | --------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| GET        | [lost\_orders](/article/ru/308#lost-orders) | https://api.admitad.com/lost\_orders/      | [Возвращает список потерянных заказов](#list-of-lost-orders-list-of-request-parameters) | Возвращает список потерянных заказов\*                                       |
| GET        | [lost\_orders](/article/ru/308#lost-orders) | https://api.admitad.com/lost\_orders/{id}/ |                                                                                         | Возвращает потерянный заказ\*, где id — это идентификатор потерянного заказа |

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

## Список параметров для запроса <span id="list-of-lost-orders-list-of-request-parameters" />

| Название       | Тип     | Допустимые значения                                                        |
| -------------- | ------- | -------------------------------------------------------------------------- |
| advcampaign    | integer | [Список партнерских программ](/article/ru/312#list-affiliate-programs)     |
| website        | integer | [Список площадок веб-мастера](/article/ru/328#list-of-publisher-ad-spaces) |
| status         | string  | accepted                                                                   |
|                |         | processing                                                                 |
|                |         | rejected                                                                   |
| limit          | integer | [Параметры limit, offset](/article/ru/310)                                 |
| offset         | integer | [Параметры limit, offset](/article/ru/310)                                 |
| start\_date    | date    | %d.%m.%Y                                                                   |
| end\_date      | date    | %d.%m.%Y                                                                   |
| appeal\_id     | string  |                                                                            |
| appeal\_status | string  | resolved                                                                   |
|                |         | processing                                                                 |

## Пример использования <span id="list-of-lost-orders-example-of-use" />

Пример запроса с использованием утилиты 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-сервера <span id="list-of-lost-orders-description-of-api-server-response-fields" />

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

# Создание потерянного заказа <span id="creation-of-lost-order" />

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

## Параметры <span id="creation-of-lost-order-parameters" />

| HTTP метод | Права доступа                                              | URL                                          | Параметры                                                                           | Примечание                   |
| ---------- | ---------------------------------------------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------- |
| POST       | [manage\_lost\_orders](/article/ru/308#manage-lost-orders) | https://api.admitad.com/lost\_orders/create/ | [Список параметров для запроса](#creation-of-lost-order-list-of-request-parameters) | Возвращает созданный заказ\* |

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

## Список параметров для запроса <span id="creation-of-lost-order-list-of-request-parameters" />

| Название          | Тип     | Обязательный | Ограничения параметров         | Допустимые значения                                                        |
| ----------------- | ------- | ------------ | ------------------------------ | -------------------------------------------------------------------------- |
| advcampaign       | integer | ✔            |                                | [Список партнерских программ](/article/ru/312#list-affiliate-programs)     |
| website           | integer | ✔            |                                | [Список площадок веб-мастера](/article/ru/328#list-of-publisher-ad-spaces) |
| 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               |                                                                            |

## Пример использования <span id="creation-of-lost-order-example-of-use" />

Пример запроса с использованием утилиты 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-сервера <span id="creation-of-lost-order-description-of-api-server-response-fields" />

| Название          | Описание                            |
| ----------------- | ----------------------------------- |
| id                | Идентификатор                       |
| website           | Площадка                            |
| campaign          | Программа                           |
| status            | Статус потерянного заказа           |
| order\_id         | Номер заказа                        |
| order\_date       | Дата заказа                         |
| order\_price      | Сумма заказа                        |
| currency          | Валюта                              |
| comment           | Комментарий                         |
| date\_created     | Дата создания                       |
| appeal\_id        | Идентификатор обращения             |
| appeal\_status    | Статус обращения                    |
| estimated\_reward | Предполагаемая сумма вознаграждения |

# Список статусов заказов <span id="list-of-order-statuses" />

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

## Параметры <span id="list-of-order-statuses-parameters" />

| HTTP метод | Права доступа                               | URL                                                  | Параметры                                                                           | Примечание                                 |
| ---------- | ------------------------------------------- | ---------------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------ |
| GET        | [lost\_orders](/article/ru/308#lost-orders) | https://api.admitad.com/lost\_orders/payments\_info/ | [Список параметров для запроса](#list-of-order-statuses-list-of-request-parameters) | Возвращает информацию о статусах заказов\* |

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

## Список параметров для запроса <span id="list-of-order-statuses-list-of-request-parameters" />

| Название    | Тип     | Допустимые значения                                                    |
| ----------- | ------- | ---------------------------------------------------------------------- |
| advcampaign | integer | [Список партнерских программ](/article/ru/312#list-affiliate-programs) |
| order\_id   | integer | Один или несколько индетификаторов заказов. Максимум 20                |

## Пример использования <span id="list-of-order-statuses-example-of-use" />

Пример запроса с использованием утилиты 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-сервера <span id="list-of-order-statuses-description-of-api-server-response-fields" />

| Название        | Описание                                                                                                                                                                                                                   |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| status          | Информация о статусе поиска заказа. Принимает значения (owner — если заказ есть у программы, already\_counted — если заказ есть, но он принадлежит другому пользователю, does\_not\_exist — у программы нет такого заказа) |
| payment\_status | Статус заказа                                                                                                                                                                                                              |
| payment\_id     | Идентификатор заказа                                                                                                                                                                                                       |

# Список апелляций <span id="list-of-appeal-claims" />

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

## Параметры <span id="list-of-appeal-claims-parameters" />

| HTTP метод | Права доступа                               | URL                                   | Параметры                                                                          | Примечание                                                     |
| ---------- | ------------------------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| GET        | [lost\_orders](/article/ru/308#lost-orders) | https://api.admitad.com/appeals/      | [Список параметров для запроса](#list-of-appeal-claims-list-of-request-parameters) | Возвращает список апелляций\*                                  |
| GET        | [lost\_orders](/article/ru/308#lost-orders) | https://api.admitad.com/appeals/{id}/ |                                                                                    | Возвращает апелляцию\*, где id — это идентификатор апелляции\* |

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

## Список параметров для запроса <span id="list-of-appeal-claims-list-of-request-parameters" />

| Название    | Тип     | Допустимые значения                                                        |
| ----------- | ------- | -------------------------------------------------------------------------- |
| advcampaign | integer | [Список партнерских программ](/article/ru/312#list-affiliate-programs)     |
| website     | integer | [Список площадок веб-мастера](/article/ru/328#list-of-publisher-ad-spaces) |
| status      | string  | accepted                                                                   |
|             |         | processing                                                                 |
|             |         | rejected                                                                   |
| limit       | integer | [Параметры limit, offset](/article/ru/310)                                 |
| offset      | integer | [Параметры limit, offset](/article/ru/310)                                 |
| start\_date | date    | %d.%m.%Y                                                                   |
| end\_date   | date    | %d.%m.%Y                                                                   |
| appeal\_id  | string  |                                                                            |

## Пример использования <span id="list-of-appeal-claims-example-of-use" />

Пример запроса с использованием утилиты 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-сервера <span id="list-of-appeal-claims-description-of-api-server-response-fields" />

| Название          | Описание                            |
| ----------------- | ----------------------------------- |
| id                | Идентификатор                       |
| website           | Площадка                            |
| campaign          | Программа                           |
| status            | Статус потерянного заказа           |
| order\_id         | Номер заказа                        |
| order\_date       | Дата заказа                         |
| order\_price      | Сумма заказа                        |
| comment           | Комментарий                         |
| date\_created     | Дата создания                       |
| currency          | Валюта                              |
| reward            | Вознаграждение                      |
| appeal\_id        | Идентификатор обращения             |
| estimated\_reward | Предполагаемая сумма вознаграждения |

# Создание апелляции <span id="creating-an-appeal-claim" />

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

## Параметры <span id="creating-an-appeal-claim-parameters" />

| HTTP метод | Права доступа                                                                | URL                                     | Параметры                                                                             | Примечание                       |
| ---------- | ---------------------------------------------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------- | -------------------------------- |
| POST       | [<u>lost\_orders</u>](https://support.admitad.ru/article/ru/308#lost-orders) | https://api.admitad.com/appeals/create/ | [Список параметров для запроса](#creating-an-appeal-claim-list-of-request-parameters) | Возвращает созданную апелляцию\* |

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

## Список параметров для запроса <span id="creating-an-appeal-claim-list-of-request-parameters" />

| Название    | Тип     | Обязательный | Ограничения параметров         | Допустимые значения                                                    |
| ----------- | ------- | ------------ | ------------------------------ | ---------------------------------------------------------------------- |
| advcampaign | integer | ✔            |                                | [Список партнерских программ](/article/ru/312#list-affiliate-programs) |
| order\_id   | string  | ✔            | Максимальная длина 100 символа |                                                                        |
| comment     | string  | ✔            | Максимальная длина 512 символа |                                                                        |
| appeal\_id  | string  |              | Максимальная длина 100 символа |                                                                        |
| receipt     | file    | ✔            | JPEG/JPG/PNG/PDF               |                                                                        |

## Пример использования <span id="creating-an-appeal-claim-example-of-use" />

Пример запроса с использованием утилиты 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-сервера <span id="creating-an-appeal-claim-description-of-api-server-response-fields" />

| Название          | Описание                            |
| ----------------- | ----------------------------------- |
| id                | Идентификатор                       |
| website           | Площадка                            |
| advcampaign       | Программа                           |
| status            | Статус потерянного заказа           |
| order\_id         | Номер заказа                        |
| order\_date       | Дата заказа                         |
| order\_price      | Сумма заказа                        |
| currency          | Валюта                              |
| comment           | Комментарий                         |
| date\_created     | Дата создания                       |
| appeal\_id        | Идентификатор обращения             |
| estimated\_reward | Предполагаемая сумма вознаграждения |