Get Order Items

GET 
https://useast.api.elasticpath.com/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 [
typestring
The type represents the object being returned.
iduuid
The unique identifier for this order item.
quantitynumber
The quantity of this item were ordered.
product_iduuid
The unique identifier for this order item.
subscription_offering_iduuid
The unique identifier for the subscription offering for this order item.
namestring
The name of this order item.
skustring
The SKU code for the order item.
unit_price object
amountnumber
The amount for this item.
currencystring
The currency this item.
includes_taxboolean
Whether this price is tax inclusive.
value object
amountnumber
The amount for this item.
currencystring
The currency this item.
includes_taxboolean
Whether this price is tax inclusive.
discounts object[]
Array [
amount object
amountnumber
The amount for this item.
currencystring
The currency this item.
includes_taxboolean
Whether this price is tax inclusive.
codestring
iduuid
]
linksobject
meta object
display_price object
with_tax object
unit object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
value object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
without_tax object
unit object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
value object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
tax object
unit object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
value object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
discount object
unit object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
value object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
without_discount object
unit object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
value object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
discounts object
property name* object
amountnumber
currencystring
formattedstring
timestamps object
created_atstring
The date this was created.
updated_at
The date this was last updated.
relationships object
cart_item object
data object
typestring
The type represents the object being returned.
iduuid
The unique identifier for this item.
catalog_idstring
The unique identifier of the catalog associated with the product is shown if catalog_source=pim is set.
catalog_sourcestring
The catalog source. Always pim or legacy.
]

Example (auto)

{
  "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

detailstring
statusstring
titlestring

Example (auto)

[
  null
]

Example

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

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://useast.api.elasticpath.com/v2/orders/:orderID/items");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

Parameters

orderID — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!