Developers

Инструменты

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

Создание заявки на потерянный заказ
Формат запроса:
POST https://cityads.com/api/rest/webmaster/v2/lostOrders?
access_token=Cr9G7dVD0FZMGaqrR9EPXXSl1J6A27AnJrNnl6Qi
{
    "lostOrder": {
        "traffic_channel_id": 1226971,
        "order_number": "123456",
        "order_date": "2018-06-08",
        "offer_id": "4325",
        "order_sum": "7263",
        "order_currency_id": 3,
        "comment": "comment"
    }
}
                    
Входные данные:
Имя: Описание:
traffic_channel_id ID канала трафика. См. список каналов трафика.
order_number Номер потерянного заказа.
order_date Дата, когда был сделан потерянный заказ.
offer_id ID оффера. См. список офферов.
order_sum Сумма потерянного заказа.
order_currency_id ID валюты потерянного заказа. См. справочник валют.
comment Ваш комментарий.
Получение списка заявок на потерянные заказы
Формат запроса:
GET https://cityads.com/api/rest/webmaster/v2/lostOrders?offers=4325,663
&order_number=123&status=processing,accepted&status_id=2,3
&order_date_start=2018-10-01&order_date_end=2018-10-02
&created_at_start=2018-10-03&created_at_end=2018-10-04
&updated_at_start=2018-10-05&updated_at_end=2018-10-06
&ids=1,2,3&page=1&perpage=10
&access_token=Cr9G7dVD0FZMGaqrR9EPXXSl1J6A27AnJrNnl6Qi
                    
Параметры запроса:
Тип: Имя: Описание: Допустимые значения: Обязательное:
int page Номер текущей страницы. По умолчанию 0.
int perpage Количество элементов на странице. По умолчанию 20. Не более 1000.
int offers Фильтр по офферам. Целочисленные идентификаторы перечисляются через запятую. См. список офферов.
string order_number Фильтр по номерам заказов. Перечисляются через запятую.
enum status Фильтр по статусам запросов. Строковый коды перечисляются через запятую. new, processing, accepted, rejected.
int status_id Фильтр по статусам запросов. Целочисленные идентификаторы перечисляются через запятую. См. справочник статусов.
string order_date_start Дата заказа от Формат yyyy-mm-dd.
string order_date_end Дата заказа до Формат yyyy-mm-dd.
string created_at_start Дата создания заявки от Формат yyyy-mm-dd.
string created_at_end Дата создания заявки до Формат yyyy-mm-dd.
string updated_at_start Дата последнего действия с заявкой от Формат yyyy-mm-dd.
string updated_at_end Дата последнего действия с заявкой до Формат yyyy-mm-dd.
string ids Идентификаторы заявок на поиск. Перечисляются через запятую.
Формат ответа:
{
    "lostOrder": [
        {
            "id": "31",
            "offer_id": "2174",
            "traffic_channel_id": "1226971",
            "order_number": "123",
            "order_sum": "423",
            "order_currency_id": "3",
            "order_date": "2018-10-01",
            "status_id": "1",
            "comment": "234234",
            "manager_comment": "",
            "created_at": "2018-10-08T14:42:55+03:00",
            "updated_at": "2018-10-09T14:36:12+03:00"
        },
        ...
    ]
}
                    
Параметры ответа:
Имя: Описание:
id ID заявки.
offer_id ID оффера. См. список офферов.
traffic_channel_id ID канала трафика. См. список каналов трафика.
order_number Номер заказа.
order_sum Сумма заказа.
order_currency_id ID валюты потерянного заказа. См. справочник валют.
order_date Дата, когда был сделан заказ.
status_id ID статуса заявки. См. справочник статусов.
comment Ваш комментарий.
manager_comment Комментарий менеджера.
created_at Дата и время создания заявки.
updated_at Дата и время последнего действия над заявкой.
Получение заявки на потерянный заказ по идентификатору
Формат запроса:
GET https://cityads.com/api/rest/webmaster/v2/lostOrders/{id}?
access_token=Cr9G7dVD0FZMGaqrR9EPXXSl1J6A27AnJrNnl6Qi
                    
Формат ответа:
{
    "lostOrder": {
        "id": "31",
        "offer_id": "2174",
        "traffic_channel_id": "1226971",
        "order_number": "123",
        "order_sum": "423",
        "order_currency_id": "3",
        "order_date": "2018-10-01",
        "status_id": "1",
        "comment": "234234",
        "manager_comment": "",
        "created_at": "2018-10-08T14:42:55+03:00",
        "updated_at": "2018-10-09T14:36:12+03:00"
    }
}
                    
Параметры ответа:
Имя: Описание:
id ID заявки.
offer_id ID оффера. См. список офферов.
traffic_channel_id ID канала трафика. См. список каналов трафика.
order_number Номер заказа.
order_sum Сумма заказа.
order_currency_id ID валюты потерянного заказа. См. справочник валют.
order_date Дата, когда был сделан заказ.
status_id ID статуса заявки. См. справочник статусов.
comment Ваш комментарий.
manager_comment Комментарий менеджера.
created_at Дата и время создания заявки.
updated_at Дата и время последнего действия над заявкой.
Редактирование заявки на потерянный заказ (только в статусе new)
Формат запроса:
PATCH https://cityads.com/api/rest/webmaster/v2/lostOrders/{id}?
access_token=Cr9G7dVD0FZMGaqrR9EPXXSl1J6A27AnJrNnl6Qi
{
    "lostOrder": {
        "order_sum": "123"
    }
}
                    
Удаление заявки на потерянный заказ (только в статусе new)
Формат запроса:
DELETE https://cityads.com/api/rest/webmaster/v2/lostOrders/{id}?
access_token=Cr9G7dVD0FZMGaqrR9EPXXSl1J6A27AnJrNnl6Qi