Submit a new hardware provisioning order for appliances or agents

Request

Creates a new provisioning order.

Requires orders::modify permission.

Security

JWTAuthorizer

Bodyapplication/json

address1string

address2string

applianceTypestring

assigneestring

Trustgrid user assigned to the order

attachmentsArray of objects(Order Attachment)

Files attached to the order

attnstring

carrierCodestring

Shipping carrier code

cellProviderstring

citystring

clonedFromIdstring

UID of the original order if this order is a clone

clonedFromOrderNumberinteger

Order number of the original order if this order is a clone

clusterIpstring

commentsArray of objects(Order Comment)

Comments on the order

companyNamestring

contactEmailstring

contactNamestring

contactPhonestring

createdAtstring, (date-time)

Timestamp when the order was created

creatorstring

User ID of the order creator

customobject

Custom key-value fields

customerRefNumstring

dataPlanstring

dns1string

Legacy primary DNS

dns2string

Legacy secondary DNS

dueDatestring

endUserAccountNumstring

failoverTypestring

flaggedboolean

haboolean

True when this order is for an HA pair

hyperlinksArray of objects(Order Hyperlink)

Customer-facing hyperlinks

interfacesCountnumber, [ 1 .. 2 ]

Number of interfaces to configure per node

labelsArray of strings

Labels attached to the order

locationNamestring

natsArray of objects

noBillboolean

Whether the order should not be billed

nodeCountnumber, [ 1 .. 2 ]

Number of nodes needed to fulfill order

nodesArray of objects

notesstring

orderNumnumber

System-wide unique order number

orgIdstring

Organization ID

orgNamestring

Organization display name

prioritystring(Order Priority)

Order priority

Enum:"normal""high""urgent"

projectIDstring

Associated project ID

rackMountsboolean

Whether rack mounts are requested

rmaboolean

Whether this order is an RMA

shippedDatestring, (date-time)

Timestamp when the order shipped

shippingCompanyNamestring

shippingContactEmailstring

shippingStatusstring

Carrier shipping status

shipStationOrderIdinteger

ShipStation order ID

siteNamestring

siteTypestring

Site deployment type

Enum:"primary""secondary""test"

stakeholdersArray of objects(Order Stakeholder)

Order stakeholders

statestring

statusstring(Order Status)

Order status. API-side holistic validations apply to orders whose status is in provisioning, qa, shipped, delivered, installed, and in production.

Enum:"new""on hold per client""gathering info""pending feedback""info received""provisioning""qa""shipped""delivered""installed"

summarystring

technicalContactEmailstring

technicalContactNamestring

technicalContactPhonestring

tgHyperlinksArray of objects(Order Hyperlink)

Trustgrid-facing hyperlinks

tgNotesstring

Trustgrid-internal notes (visible only to users with trustgrid::order-notes)

trackingNumberstring

Carrier tracking number

transitionsArray of objects(Order Transition)

Status transition history

uidstring

validationsobject(Order Validation)

Live validation results for the order

zipstring

curl -i -X POST \
  https://apidocs.trustgrid.io/_mock/provisioning/api/v1/orders \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "address1": "string",
    "address2": "string",
    "applianceType": "string",
    "assignee": "string",
    "attachments": [
      {
        "key": "string",
        "uid": "string",
        "name": "string",
        "owner": "string",
        "uploadedAt": "2019-08-24T14:15:22Z"
      }
    ],
    "attn": "string",
    "carrierCode": "string",
    "cellProvider": "string",
    "city": "string",
    "clonedFromId": "string",
    "clonedFromOrderNumber": 0,
    "clusterIp": "string",
    "comments": [
      {
        "uid": "string",
        "body": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "user": "string"
      }
    ],
    "companyName": "string",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "creator": "string",
    "custom": {
      "property1": "string",
      "property2": "string"
    },
    "customerRefNum": "string",
    "dataPlan": "string",
    "dns1": "string",
    "dns2": "string",
    "dueDate": "string",
    "endUserAccountNum": "string",
    "failoverType": "string",
    "flagged": true,
    "ha": true,
    "hyperlinks": [
      {
        "url": "string",
        "description": "string"
      }
    ],
    "interfacesCount": 1,
    "labels": [
      "string"
    ],
    "locationName": "string",
    "nats": [
      {
        "description": "string",
        "localCidr": "string",
        "networkCidr": "string"
      }
    ],
    "noBill": true,
    "nodeCount": 1,
    "nodes": [
      {
        "dns1": "string",
        "dns2": "string",
        "interfaces": [
          {
            "dhcp": true,
            "gateway": "string",
            "ip": "string",
            "subnet": "string"
          }
        ],
        "linkedNode": "string",
        "name": "string"
      }
    ],
    "notes": "string",
    "orderNum": 0,
    "orgId": "string",
    "orgName": "string",
    "priority": "normal",
    "projectID": "string",
    "rackMounts": true,
    "rma": true,
    "shippedDate": "2019-08-24T14:15:22Z",
    "shippingCompanyName": "string",
    "shippingContactEmail": "string",
    "shippingStatus": "string",
    "shipStationOrderId": 0,
    "siteName": "string",
    "siteType": "primary",
    "stakeholders": [
      {
        "name": "string",
        "email": "string",
        "phone": "string",
        "role": "string"
      }
    ],
    "state": "string",
    "status": "new",
    "summary": "string",
    "technicalContactEmail": "string",
    "technicalContactName": "string",
    "technicalContactPhone": "string",
    "tgHyperlinks": [
      {
        "url": "string",
        "description": "string"
      }
    ],
    "tgNotes": "string",
    "trackingNumber": "string",
    "transitions": [
      {
        "from": "new",
        "to": "new",
        "timestamp": "2019-08-24T14:15:22Z"
      }
    ],
    "uid": "string",
    "validations": {
      "valid": true,
      "anonymous": "string",
      "nats": [
        {
          "valid": true,
          "networkCidr": "string",
          "localCidr": "string"
        }
      ],
      "nodes": [
        {
          "valid": true,
          "name": "string",
          "dns1": "string",
          "dns2": "string",
          "linkedNode": "string",
          "anonymous": "string",
          "interfaces": [
            {
              "valid": true,
              "ip": "string",
              "subnet": "string",
              "gateway": "string",
              "anonymous": "string"
            }
          ]
        }
      ]
    },
    "zip": "string"
  }'

Responses