Метод возвращает список всех заказов. 

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

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

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

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

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

  • number — сортировка по номеру заказа;
  • submitdate — сортировка по дате подтверждения заказа

direction

Опционален

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

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

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

limit

Опционален

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

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

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

offset 

Опционален

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

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


statusОпционален

Фильтрация по статусу заказа. Если необходимо выбрать заказы с определенными статусами, то перечислите их через запятую в параметре запроса.

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

  • 0 — вернутся заказы в статусе Draft(0);
  • 1 — вернутся заказы в статусе Submit(1);
  • 2 — вернутся заказы в статусе Revoked(2)
isdemoОпционален

Фильтрация демонстрационных заказов.

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

  • true — вернутся демонстрационные заказы;
  • false — вернутся не демонстрационные заказы
istrialОпционален

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

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

  • true — вернутся заказы на пробные лицензии;
  • false — вернутся не пробные заказы
ishardwarelicenseОпционален

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

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

  • true — вернутся заказы на аппаратные ключи;
  • false — вернутся заказы на программные лицензии
isupdateorderОпционален

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

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

  • true — вернутся заказы на обновления (Update);
  • false — вернутся заказы на продажу (Sale)
has_activated_licensesОпционален

Фильтрация заказов на заказы с активированными лицензиями (только для заказов на серийные номера).

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

  • true — вернутся заказы, у которых есть хотя бы один активированный серийный номер;
  • false — вернутся заказы, у которых все серийные номера не активированы
has_not_activated_licensesОпционален

Фильтрация заказов на заказы с не активированными лицензиями (только для заказов на серийные номера).

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

  • true — вернутся заказы, у которых есть хотя бы один не активированный серийный номер;
  • false — вернутся заказы,  у которых все серийные номера активированы
Пример запроса
https://station.guardant.ru/v1.0/orders?sortby=submitdate&direction=desc&limit=2&offset=1&status=1&isdemo=false&istrial=false&ishardwarelicense=false

Ответ

Возвращает массив orders:

Пример результата запроса 
{
    "orders": [
        {
            "_id": 76628,
            "activated_licenses_count": 0,
            "activationbirthdate": 1769177563,
            "activationdeathdate": 0,
            "activationlimit": 1,
            "archivationdate": 0,
            "archived": false,
            "canoverwritecontainer": false,
            "crmid": "",
            "customerrequired": false,
            "date": 1769177563,
            "description": "",
            "isdemo": false,
            "ishardwarelicense": false,
            "istrial": false,
            "istrialunlim": false,
            "netlicenseslimit": 0,
            "number": 161,
            "quantity": 1,
            "refid": "",
            "serials": [
                {
                    "_id": 95382,
                    "activationcount": 0,
                    "activationlimit": 1,
                    "dongleid": -1057589851,
                    "flags": 0,
                    "licensecontainerversion": 0,
                    "serialstring": "asH3iw-CibZyV-7c5Mur-fm1ZR3-cByZge",
                    "status": 0
                }
            ],
            "status": 1,
            "submitdate": 1769177575,
            "submituser": {
                "_id": 11536,
                "confirmed": true,
                "email": "bob@mycompany.com",
                "status": true,
                "userdetails": {
                    "_id": 11536,
                    "archivationdate": 0,
                    "archived": false,
                    "firstname": "Bob",
                    "lastname": "Doe",
                    "lastvisitdate": 1775117766,
                    "role": {
                        "_id": 1,
                        "createorders": true,
                        "createproducts": true,
                        "createusers": true,
                        "manageprotect": true,
                        "nameeng": "Administrator",
                        "namerus": "Администратор",
                        "readvendorbalance": true
                    },
                    "settings": {
                        "language": 0,
                        "notification_off": true
                    }
                }
            },
            "triallifetimedays": 0,
            "type": 0
        },
        {
            "_id": 69304,
            "activated_licenses_count": 0,
            "activationbirthdate": 1755172944,
            "activationdeathdate": 0,
            "activationlimit": 1,
            "archivationdate": 0,
            "archived": false,
            "canoverwritecontainer": false,
            "crmid": "",
            "customerrequired": false,
            "date": 1755172944,
            "description": "",
            "isdemo": false,
            "ishardwarelicense": false,
            "istrial": false,
            "istrialunlim": false,
            "netlicenseslimit": 0,
            "number": 146,
            "quantity": 1,
            "refid": "",
            "serials": [
                {
                    "_id": 75296,
                    "activationcount": 0,
                    "activationlimit": 1,
                    "dongleid": -1940114234,
                    "flags": 0,
                    "licensecontainerversion": 0,
                    "serialstring": "Ua29W1-imSbxm-ymirfS-S45aam-Z2bi8K",
                    "status": 0
                }
            ],
            "status": 1,
            "submitdate": 1755172951,
            "submituser": {
                "_id": 11536,
                "confirmed": true,
                "email": "bob@mycompany.com",
                "status": true,
                "userdetails": {
                    "_id": 11536,
                    "archivationdate": 0,
                    "archived": false,
                    "firstname": "Bob",
                    "lastname": "Doe",
                    "lastvisitdate": 1775117766,
                    "role": {
                        "_id": 1,
                        "createorders": true,
                        "createproducts": true,
                        "createusers": true,
                        "manageprotect": true,
                        "nameeng": "Administrator",
                        "namerus": "Администратор",
                        "readvendorbalance": true
                    },
                    "settings": {
                        "language": 0,
                        "notification_off": true
                    }
                }
            },
            "triallifetimedays": 0,
            "type": 0
        }
    ]
}
  • No labels
Если вам нужна помощь, обратитесь по адресу
hotline@guardant.ru