You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Returns a list of all orders.

Address/v1.0/orders
TypeGET
AuthorizationRequired

Input parameters

NameRequired / OptionalDescriptionPossible values
sortby Optional

How orders are sorted.

Default value is number

  • number — sort by order number;
  • submitdate — sort by order confirmation date

direction

Optional

Sorting direction.

Default value is asc

  • asc — sort from lower number/earlier date to higher/later;
  • desc — sort from higher number/later date to lower/earlier

limit

Optional

Maximum number of orders that will be returned in the response.

Default value is 100

From 1 to 100, inclusive

offset 

Optional

Offset the first order number that will be included in the response.

The limit parameter will be applied after the offset parameter. For example, if offset = 49 and limit = 70, the response will return orders 49-119.

Orders are numbered starting with 0


statusOptional

Filter orders based on order status. To request orders in multiple statuses, add all required statues separated with a comma. 

Default request returns all orders

  • 0 — return orders with status Draft(0);
  • 1 — return orders with status Submit(1);
  • 2 — return orders with status Revoked(2)
isdemoOptional

Filter demo orders.

Default request returns all orders

  • true — return demo orders;
  • false — return non-demo orders
istrialOptional

Filter trial orders.

Default request returns all orders

  • true — return trial license orders;
  • false — return non-trial license orders
ishardwarelicenseOptional

Filter hardware license orders.

Default request returns all orders

  • true — return hardware license orders;
  • false — return software license orders
isupdateorderOptional

Filter Update orders.

Default request returns all orders

  • true — return Update orders;
  • false — return Sale orders
has_activated_licensesOptional

Filter orders based on whether they already have activated licenses.

Default request returns all orders

  • true — return orders that have at least one activated serial number;
  • false — return orders that have no activated serial numbers
has_not_activated_licensesOptional

Filter orders based on whether they have remaining unused licenses.

Default request returns all orders

  • true — return orders where at least one serial number is not yet activated;
  • false — return orders where all serial numbers are activated
Example request
https://station.guardant.com/v1.0/orders?sortby=submitdate&direction=desc&limit=2&offset=1&status=1&isdemo=false&istrial=false&ishardwarelicense=false

Response

Returns the orders array:

Example response
"orders": [
{
  "_id": 10049,
  "activationlimit": 2,
  "date": 1528911062,
  "submitdate":  1528915062,
  "number": 1,
  "activationbirthdate":1528911062,
  "activationdeathdate":15210911062,
  "canoverwritecontainer": false,
  "isdemo": false,
  "description": "1234234234",
  "quantity": 2,
  "status": 1,
  "type": 0,
  "ishardwarelicense": false,
  "crmid": "",
  "refid": ""
},{
 
  "_id": 10048,
  "activationlimit": 3,
  "customer": {
      "_id": 8,
       "description": "test",
       "email": "cust@mail.com",
       "name": "MyCostomer",
      "phone": "123-12-12",
      "status": 0,
      "crmid": "",
      "refid": ""
 
 },
  "date": 1528910935,
  "submitdate":  1528915062,
  "number: 2,
  "description": "test",
  "quantity": 2,
  "status": 0,
  "type": 0,
  "ishardwarelicense": false,
  "crmid": "",
  "refid": ""
},{
 
  "_id": 10045,
  "activationlimit": 1,
  "date": 1528905572,
  "submitdate":  1528915062,
  "number": 3,
  "activationbirthdate":1528911062,
 
  "activationdeathdate":15210911062,
  "canoverwritecontainer": false,
  "isdemo": false,
  "customerrequired": true,
  "description": "TEST_UPDATE2",
  "quantity": 1,
  "status": 1,
  "type": 1,
  "ishardwarelicense": false,
  "crmid": "",
  "refid": ""
}];
  • No labels