Orders

Create Order

Create a new order. Currently NOT supported for scheduled orders(orders with a future date).

post/orders

Request

Base URL
https://api.pax8.com/v1
URL
https://api.pax8.com/v1/orders
Auth
OAuth 2
Client credentials
Token URL: https://token-manager.pax8.com/oauth/token

Query parameters

isMockboolean

Perform validations only. Skip any interactions with the database.

Request body

idstring uuid

unique id of the order

companyIdstring uuid required

unique id of the purchasing company ie. end-user

createdDatestring date

the date the order was created

orderedBy'Pax8 Partner' | 'Customer' | 'Pax8'

the type of user who created the order

orderedByUserIdstring uuid

unique id of the user who created this order

orderedByUserEmailstring email

the email address of the user who created this order

isScheduledboolean

is true if order is future dated

Example request

{
  "orderedByUserEmail": "john@doe.com",
  "lineItems": [
    {
      "lineItemNumber": 1,
      "parentLineItemNumber": 1,
      "quantity": 45,
      "provisioningDetails": [
        {
          "key": "userEmailAddress",
          "description": "Provide the user's email address"
        }
      ]
    }
  ]
}

Response

Successful operation