Заказы (Orders)


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

Через наше API можно получить список всех заказов, которые есть у Вас в аккаунте платформе.

Пример GET запроса:

Request
GET https://api.leeloo.ai/api/v1/orders?limit=3&offset=0
  • limit - ограничение количества результатов;
  • offset - сколько результатов пропустить;

Если запрос составлен правильно, то система выдаст следующий ответ:

Response
{
    "data": [
        {
            "id": "59f2e2425bb695001a3f6388",
            "title": "Offer_1",
            "price": 199.99,
            "currency": "RUB",
            "paymentMethod": "YANDEX_MONEY",
            "status": "SUCCESS",
            "createdAt": "2017-10-27T07:37:38.205Z",
            "updatedAt": "2017-10-27T07:37:38.205Z"
        },
        {
            "id": "59f05ab665634200460fba71",
            "title": "Offer_2",
            "price": 1,
            "currency": "UAH",
            "paymentMethod": "ASSET_PAYMENT",
            "status": "SUCCESS",
            "createdAt": "2017-10-25T09:34:46.851Z",
            "updatedAt": "2017-10-25T09:34:46.851Z"
        },
        {
            "id": "59f05a797af93f003ca7abd8",
            "title": "Offer_2",
            "price": 1,
            "currency": "UAH",
            "paymentMethod": "ASSET_PAYMENT",
            "status": "FAILED",
            "createdAt": "2017-10-25T09:33:45.655Z",
            "updatedAt": "2017-10-25T09:33:45.655Z"
        }
    ],
    "meta": {
        "limit": 3,
        "offset": 0,
        "filteredCount": 3,
        "totalCount": 152
    },
    "status": 1
}

где

  • data - массив заказов;
  • id - идентификатор заказа (значение уникальное, создается при формировании заказа, можно узнать только по средством API);
  • title - имя оффера, по которому был сформирован заказ (задается при создании оффера);
  • price - цена заказа (берется из настроек оффера);
  • currency - валюта заказа;
  • paymentMethod - название службы, через которую был сформирован заказ (то есть мерчант платежной системы);
  • status - текущий статус заказа;
  • createdAt - время создания заказа;
  • updatedAt - время последнего обновления статуса заказа.

meta:

  • limit - лимит, установленный в запросе (по усмолчанию 20);
  • offset - установленный в запросе отступ (по умолчанию 0);
  • filteredCount - количество результатов в ответе;
  • totalCount - общее количество результатов, соответсвующих фильтру.



Информация о заказе

Позволяет получить подробную информацию о конкретном заказе.

Пример GET запроса:

Request
GET https://api.leeloo.ai/api/v1/orders/59f2e2425bb695001a3f6388
  • 59f2e2425bb695001a3f6388 - id заказа.

Пример ответа:

Response
{
    "data": {
        "id": "59f2e2425bb695001a3f6388",
        "title": "test321111",
        "price": 1,
        "currency": "UAH",
        "paymentMethod": "ASSET_PAYMENT",
        "status": "SUCCESS",
        "createdAt": "2017-10-27T07:37:38.205Z",
        "updatedAt": "2017-10-27T07:37:38.205Z"
    },
    "status": 1
}
  • data - данные заказа;
  • id - идентификатор заказа;
  • title - имя оффера, по которому был сформирован заказ;
  • price - цена заказа;
  • currency - валюта заказа;
  • paymentMethod - название службы, через которую был сформирован заказ;
  • status - текущий статус заказа;
  • createdAt - время создания заказа;
  • updatedAt - время последнего обновления статуса заказа.