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

Compare with Current View Page History

Version 1 Next »

Method creates a new Sale order.

Address/v1.0/orders
TypePOST 
AuthorizationRequired

Input parameters

Input parameters are submitted as raw JSON:

NameRequired / OptionalDescriptionPossible values

customerId

Optional

Customer ID


orderQuantity

Optional

Number of serial numbers or hardware keys in the order


orderActivationLimit

Optional

Maximum number of serial number activations in the order


orderDescription

Optional

Order description


orderStatus

Optional

Current order status.

Default value is 0 (Draft)

  • 0 — Draft;
  • 1 — Submitted;
  • 2 — Revoked;
  • 4 — InProgress;
  • 8 — Complete

orderType

Required

Order type.

Must be equal to Sale

  • Sale

orderCanOverwriteContainer

Optional

Flag that determines whether the order can overwrite the license agreement from a previous order

  • true — order will overwrite the existing license agreement;
  • false —  order will append the new license agreement to the existing one

orderIsDemo

Optional

Create an order for demo or regular licenses

  • true — order demo licenses;
  • false — order regular licenses

customerrequired

Optional

Flag that determines whether the license can be activated without customer info

  • true — can be activated without customer info;
  • false — cannot be activated without customer info

orderActivationBirthDate

Optional

Allowed license activation period start date in Unix time


orderActivationDeathDate

Optional

Allowed license activation period end date in Unix time


isHardwareLicense

Optional

License type.

Default value is false

  • true — hardware license order;
  • false — software license order;

orderIsTrial

Optional

Create an order for trial or regular license.

Default value is false

  • true — trial keys order;
  • false — regular keys order;

orderIsTrialUnlim

Optional

Flag that determines the order's serial number activation limint

Default value is false

  • true — serial number activations are unlimited;
  • false — serial numbers have an activation limit

orderTrialLifetimeDays

Optional

Set when orderIsTrial = true.

Determines the lifetime of a trial license (cannot exceed 90 days). 

Default value is 90


netLicensesLimit

Optional

Upper limit of network connections for licenses in Guardant Control Center
crmIdOptionalID in vendor's CRM system 
refIdOptionalID in vendor's other systems
Example request
https://station.guardant.com/v1.0/orders
Example request body
{
  "customerId" : 8,
  "orderActivationBirthDate":1528911062,
  "orderActivationDeathDate":15210911062,
  "orderCanOverwriteContainer": false,
  "orderIsDemo": false,
  "customerRequired": true,
  "orderQuantity" : 10,
  "orderActivationLimit" : 10,
  "orderDescription" : "Created by Postmam",
  "orderStatus" : 0,
  "orderType" : 0,
  "isHardwareLicense": false,
  "orderIsTrial": false,
  "orderIsTrialUnlim": false,
  "orderTrialLifetimeDays": 0,
  "netLicensesLimit" : 0,
  "crmId": "",
  "refId": ""
}

Response

Example response 
{
  "order": {
    "_id": 10052,
    "number": 1,
    "activationlimit": 10,
 
    "activationbirthdate":1528911062,
    "activationdeathdate":15210911062,
    "canoverwritecontainer": false,
 
    "isdemo": false,
    "customerrequired": true,
     
 
    "customer": {
       "_id": 8,
       "description": "test",
       "email": "cust@mail.ru",
       "name": "MyCostomer",
       "phone": "123-12-12",
       "status": 0,
       "crmid": "",
       "refid": ""
    },
    "date": 0,
    "submitdate":  1528915062,
    "description": "Created by Postmam",
    "quantity": 10,
    "status": 0,
    "type": 0,
    "ishardwarelicense": false,
    "istrial": false,
    "istrialunlim": false,
    "triallifetimedays": 0,
    "netlicenseslimit" : 0,
    "crmid": "",
    "refid": ""
  }
}
  • No labels
If you have any questions please contact the support team
hotline@guardant.com