Get Order Items

GET 
/v2/orders/:orderID/items

Use this endpoint to retrieve order items.

Request

Path Parameters

orderID stringrequired

The ID of the order.

Responses

200

Response Headers

application/json

Schema

Schema

data object[]
Array [
type string
The type represents the object being returned.
id uuid
The unique identifier for this order item.
quantity number
The quantity of this item were ordered.
product_id uuid
The unique identifier for this order item.
subscription_offering_id uuid
The unique identifier for the subscription offering for this order item.
name string
The name of this order item.
sku string
The SKU code for the order item.
unit_price object
amount number
The amount for this item.
currency string
The currency this item.
includes_tax boolean
Whether or not this price is tax inclusive.
value object
amount number
The amount for this item.
currency string
The currency this item.
includes_tax boolean
Whether or not this price is tax inclusive.
discounts object[]
Array [
amount object
amount number
The amount for this item.
currency string
The currency this item.
includes_tax boolean
Whether or not this price is tax inclusive.
code string
id uuid
]
links object
meta object
display_price object
with_tax object
unit object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
value object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
without_tax object
unit object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
value object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
tax object
unit object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
value object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
discount object
unit object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
value object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
without_discount object
unit object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
value object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
discounts object
property name* object
amount number
currency string
formatted string
timestamps object
created_at string
The date this was created.
updated_at
The date this was last updated.
relationships object
cart_item object
data object
type string
The type represents the object being returned.
id uuid
The unique identifier for this item.
catalog_id string
The unique identifier of the catalog associated with the product is shown if catalog_source=pim is set.
catalog_source string
The catalog source. Always pim or legacy.
]

Example (from schema)

{
  "data": [
    {
      "type": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "quantity": 0,
      "product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "subscription_offering_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "sku": "string",
      "unit_price": {
        "amount": 0,
        "currency": "string",
        "includes_tax": true
      },
      "value": {
        "amount": 0,
        "currency": "string",
        "includes_tax": true
      },
      "discounts": [
        {
          "amount": {
            "amount": 0,
            "currency": "string",
            "includes_tax": true
          },
          "code": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        }
      ],
      "links": {},
      "meta": {
        "display_price": {
          "with_tax": {
            "unit": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            },
            "value": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            }
          },
          "without_tax": {
            "unit": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            },
            "value": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            }
          },
          "tax": {
            "unit": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            },
            "value": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            }
          },
          "discount": {
            "unit": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            },
            "value": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            }
          },
          "without_discount": {
            "unit": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            },
            "value": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            }
          },
          "discounts": {}
        },
        "timestamps": {
          "created_at": "string"
        }
      },
      "relationships": {
        "cart_item": {
          "data": {
            "type": "string",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        }
      },
      "catalog_id": "string",
      "catalog_source": "string"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

detail string
status string
title string

Example (from schema)

[
  null
]

Example

{
  "errors": {
    "status": 401,
    "title": "Unauthorized"
  }
}

Loading...