Метод возвращает отчет по заказам. 

Адрес/v1.0/reports/orders
ТипGET
LoginТребуется 

Входные параметры

ПараметрОбязательностьОписаниеВозможные значения
sortby Опционален

Сортировка заказов.

По умолчанию выполняется сортировка по номеру

  • number — сортировка по номеру заказа;
  • submitdate — сортировка по дате подтверждения заказа;
  • customer — сортировка по покупателю, указанному в заказе;
  • orderstatus — сортировка по статусу заказа;
  • shipmentdate — сортировка по дате отгрузки заказа;
  • softwarelicense — сортировка по типу заказанной лицензии:
    • 0 — программная;
    • 1 — аппаратная 

direction

Опционален

Направление сортировки.

По умолчанию используется сортировка asc

  • asc — сортировка от меньшего к большему;
  • desc — сортировка от большего к меньшему

limit

Опционален

Максимальное количество записей, которые можно получить.

По умолчанию равен 100

От 1 до 100 включительно

offset 

Опционален

Смещение, показывающее с какого порядкового номера записи (с учетом выбранной сортировки) необходимо получить limit записей.

Записи нумеруются с 0


from

Опционален

В отчет будут попадать только заказы, у которых дата подтверждения (submitdate) будет больше, чем дата, указанная в этом параметре (в формате Unix time)


to 

Опционален

В отчет будут попадать только заказы, у которых дата подтверждения (submitdate) будет меньше, чем дата, указанная в этом параметре (в формате Unix time)


products 

Опционален

Список имен продуктов через запятую, заказы которых попадут в отчет


customers 

Опционален

Список ID покупателей через запятую, чьи заказы попадут в отчет


istrial 

Опционален

Фильтрация заказов на пробные лицензии.

По умолчанию в запросе возвращаются все заказы

  • false — вернутся только заказы на обычные лицензии;
  • true — вернутся только заказы на пробные лицензии
Пример запроса
https://station.guardant.ru/v1.0/reports/orders?sortby=submitdate&direction=desc&limit=2&offset=10&from=1586428828&to=1775731228&products=20031, 19599&customers =18653, 13489&istrial=false

Ответ

Возвращает:

  • массив orders, каждый JSON-объект которого включает поля заказа;
  • массив products;
  • может включать поле customer, если есть покупатель;
  • поле xcount, содержащее общее количество объектов данного типа на стороне сервера (без учета значений offset и limit).
Пример результата запроса 
{
    "orders": [
        {
            "_id": 79633,
            "customer": {
                "_id": 18653,
                "companyname": "company1",
                "email": "86er8@dollicons.com",
                "lastname": "",
                "name": ""
            },
            "date": 0,
            "description": "",
            "ishardwarelicense": true,
            "istrial": false,
            "licenses_activated": 1,
            "number": 189,
            "products": [
                {
                    "_id": 20031,
                    "modification": 0,
                    "name": "product1",
                    "productnumber": 24,
                    "status": 1
                }
            ],
            "shipmentdate": 1774855814,
            "status": 8,
            "submitdate": 1774855801,
            "type": 0
        },
        {
            "_id": 78992,
            "customer": {
                "_id": 13489,
                "companyname": "",
                "email": "john@bk.com",
                "lastname": "Doe",
                "name": "John"
            },
            "date": 0,
            "description": "",
            "ishardwarelicense": false,
            "istrial": false,
            "licenses_activated": 1,
            "number": 187,
            "products": [
                {
                    "_id": 19599,
                    "modification": 0,
                    "name": "rtadmin",
                    "productnumber": 17,
                    "status": 1
                }
            ],
            "shipmentdate": 1773414769,
            "status": 8,
            "submitdate": 1773414769,
            "type": 1
        }
    ],
    "xcount": 144
}


  • No labels
Если вам нужна помощь, обратитесь по адресу
hotline@guardant.ru