PApax8
Orders

Get Order By ID

Returns the Order record specified by OrderId. Currently NOT supported for scheduled orders

get/orders/{orderId}

Request

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

Path parameters

orderIdstring required
Example:8f72220b-2a13-4856-a647-b80448722bbb

The unique identifier for an order record

Response

Successful operation

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 response

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

Changes

No recorded changes to this operation across all 1 revision of this API.