---
title: "Get Order By ID"
method: GET
path: "/orders/{orderId}"
tags: ["Orders"]
---

# Get Order By ID

`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`

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

## Path parameters

- `orderId` string, required

## Response `200`

Successful operation

- Order
  - `id` string, uuid: unique id of the order
  - `companyId` string, uuid, required: unique id of the purchasing company ie. end-user
  - `createdDate` string, date: the date the order was created
  - `orderedBy` 'Pax8 Partner' | 'Customer' | 'Pax8': the type of user who created the order
  - `orderedByUserId` string, uuid: unique id of the user who created this order
  - `orderedByUserEmail` string, email: the email address of the user who created this order
  - `isScheduled` boolean: is ```true``` if order is future dated
  - `lineItems` LineItem[], required
    - `id` string, uuid
    - `productId` string, uuid, required
    - `subscriptionId` string, uuid: The original subscription ID for the associated subscription's lineage. See the Subscriptions endpoints for how subscription lineages work.
    - `commitmentTermId` string, uuid
    - `provisionStartDate` string, date-time
    - `lineItemNumber` number, required: Required. Number used as a reference to the line item for parent line items
    - `billingTerm` 'Monthly' | 'Annual' | '2-Year' | '3-Year' | 'One-Time' | 'Trial' | 'Activation'
    - `parentSubscriptionId` string, uuid: Reference to the subscription this item depends on
    - `parentLineItemNumber` number: Reference to the required parent line item in this same order
    - `quantity` number, required: Whole Number
    - `provisioningDetails` ProvisioningDetail[]
      - `label` string: The label to display
      - `key` string: The key
      - `values` string[]: A list of values based on the ```valuetype``` and ```possibleValues```
      - `description` string: Instructions and context to help enter the required provisioning information
      - `valueType` 'Input' | 'Single-Value' | 'Multi-Value': Provisioning Detail Value Type: * `Input` - A value that is supplied by a user * `Single-Value` - A single value that is picked from the `possibleValues` list * `Multi-Value` - One or multiple values that are picked from the `possibleValues` list
      - `possibleValues` string[]: A list of possible values. `possibleValues` will be null when `valueType` is `Input`

## Other responses

- `404`: Invalid order id

---

[API](https://skmtc.dev/pax8/apis/partner-endpoints.md) - [All operations](https://skmtc.dev/pax8/apis/partner-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/pax8/apis/partner-endpoints/revisions/f90cec5b4720?raw)