PApax8
Orders

List Orders

Returns a paginated list of orders. Currently NOT supported for scheduled orders(orders with a future date).

get/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

pagenumber

The page number to request for in the orders list

sizenumber
companyIdstring uuid
Example:f7fc273a-8d86-45c9-a26f-ffd42416adda

The company id to filter on

Response

Successful operation

Example response

{
  "content": [
    {
      "orderedByUserEmail": "john@doe.com",
      "lineItems": [
        {
          "lineItemNumber": 1,
          "parentLineItemNumber": 1,
          "quantity": 45,
          "provisioningDetails": [
            {
              "key": "userEmailAddress",
              "description": "Provide the user's email address"
            }
          ]
        }
      ]
    }
  ],
  "page": {
    "size": 50,
    "totalElements": 237,
    "totalPages": 5,
    "number": 1
  }
}

Changes

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