Get Order Items

GET/v2/orders/{orderID}/items

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the Get Order Items action (under Carts).
Fill in the fields below, then reference the result from later steps as {{getOrderItems.response.data}}.

Request

Path parameters

orderIDstringrequired

The ID of the order.

Query parameters

includestring

Comma-delimited string of entities to include (tax_items, custom_discounts, promotions).

Response

Returns 200 with an object. Read it in later steps with {{getOrderItems.response.data.<field>}}.

dataarray<object>

typestring

The type represents the object being returned.

idstring (uuid)

The unique identifier for this order item.

quantitynumber

The quantity of this item were ordered.

product_idstring (uuid)

The unique identifier for this order item.

subscription_offering_idstring (uuid)

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.

locationstring

The stock location for this order item.

unit_priceobject3 fields

valueobject3 fields

discountsarray<object>7 fields

linksobject

metaobject2 fields

relationshipsobject3 fields

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

bundle_configurationobject2 fields

Configuration for bundle products.

componentsobject

Components of the bundle product.

custom_inputsobject

Custom inputs for the order item as a generic object

custom_attributesobject

Specifies custom attributes for cart or order objects. Each attribute includes a top-level key, as well as corresponding type and value entries. Attribute values must correspond to the assigned types. Example: ``` "custom_attributes": { "is_member": { "type": "boolean", "value": true }, "membership_level": { "type": "string", "value": "premium" } } ```

shipping_group_idstring

The shipping group ID for the order item

promotion_sourcestring

The promotion source for the order item

promotion_action_idstring

The action ID within the rule promotion that produced this promotion item.

subscription_configurationobject2 fields

Subscription configuration for the order item

includedobject

Optional included data such as tax items, custom discounts, and promotions.

tax_itemsarray<object>7 fields

Array of tax items included in the response.

custom_discountsarray<object>8 fields

Array of custom discounts included in the response.

promotionsarray<object>9 fields

Array of promotions included in the response.

json

{
  "data": [
    {
      "type": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "quantity": 0,
      "product_id": "00000000-0000-0000-0000-000000000000",
      "subscription_offering_id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "sku": "string",
      "location": "string",
      "unit_price": {
        "amount": 0,
        "currency": "string",
        "includes_tax": false
      },
      "value": {
        "amount": 0,
        "currency": "string",
        "includes_tax": false
      },
      "discounts": [
        {
          "amount": {
            "amount": 0,
            "currency": "string",
            "includes_tax": false
          },
          "code": "string",
          "id": "00000000-0000-0000-0000-000000000000",
          "promotion_source": "string",
          "is_cart_discount": false,
          "ordinal": 0,
          "promotion_action_id": "string"
        }
      ],
      "links": {}
    }
  ],
  "included": {
    "tax_items": [
      {
        "type": "string",
        "id": "00000000-0000-0000-0000-000000000000",
        "jurisdiction": "string",
        "code": "string",
        "name": "string",
        "rate": 0,
        "amount": 0
      }
    ],
    "custom_discounts": [
      {
        "type": "string",
        "id": "00000000-0000-0000-0000-000000000000",
        "external_id": "string",
        "discount_engine": "string",
        "amount": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "description": "string",
        "discount_code": "string",
        "relationships": {
          "item": {
            "data": {
              "id": null,
              "type": null
            }
          }
        }
      }
    ],
    "promotions": [
      {
        "type": "string",
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "description": "string",
        "automatic": false,
        "promotion_type": "string",
        "promotion_source": "string",
        "start": "2025-01-01T00:00:00Z",
        "end": "2025-01-01T00:00:00Z"
      }
    ]
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.

Was this page helpful?