Commerce Cloud

Order Items

The Order Item Object

Parameters

AttributeTypeDescription
idstringThe unique identifier for this order item.
typestringThe type represents the object being returned.
product_idstringThe unique identifier for this order item.
namestringThe name of this order item.
skustringThe SKU code for the order item.
quantityintegerThe quantity of this item were ordered.
unit_priceobjectThe unit price object.
valueobjectThe value object.
linksobjectThe links object.
metaobjectThe meta object.
relationshipsobjectThe relationships object.
catalog_sourcestringThe catalog source. Always pimorlegacy`.
catalog_idstringThe unique identifier of the catalog associated with the product is shown if catalog_source=pim is set.

Sample object

{
    "data": [
        {
            "type": "order_item",
            "id": "eb9f1a75-c438-457d-b474-e2286e81b94b",
            "quantity": 1,
            "product_id": "bf8a9d62-6ca9-45f6-85eb-f0d1d9ae7fdd",
            "name": "Woodsy",
            "sku": "WDLP100BRO",
            "unit_price": {
                "amount": 40000,
                "currency": "USD",
                "includes_tax": true
            },
            "value": {
                "amount": 40000,
                "currency": "USD",
                "includes_tax": true
            },
            "links": {},
            "meta": {
                "display_price": {
                    "with_tax": {
                        "unit": {
                            "amount": 40000,
                            "currency": "USD",
                            "formatted": "$400.00"
                        },
                        "value": {
                            "amount": 40000,
                            "currency": "USD",
                            "formatted": "$400.00"
                        }
                    },
                    "without_tax": {
                        "unit": {
                            "amount": 40000,
                            "currency": "USD",
                            "formatted": "$400.00"
                        },
                        "value": {
                            "amount": 40000,
                            "currency": "USD",
                            "formatted": "$400.00"
                        }
                    },
                    "tax": {
                        "unit": {
                            "amount": 40000,
                            "currency": "USD",
                            "formatted": "$400.00"
                        },
                        "value": {
                            "amount": 40000,
                            "currency": "USD",
                            "formatted": "$400.00"
                        }
                    }
                },
                "timestamps": {
                    "created_at": "2018-05-24T09:14:58.18733387Z",
                    "updated_at": "2018-05-24T09:14:58.18733387Z"
                }
            },
            "relationships": {
                "cart_item": {
                    "data": {
                        "type": "cart_item",
                        "id": "4c66bfa9-f9a7-4b6b-9e38-3fad4a8ae8bd"
                    }
                }
            },
            "catalog_id": "92073438-7640-4ace-9670-c8c5c1a89cd7",
            "catalog_source": "pim"
        }
    ]
}

The unit price object

AttributeTypeDescription
unit_price.amountintegerThe singular price of this item.
unit_price.currencystringThe unit price currency of this item.
unit_price.includes_taxbooleanIs the price inclusive of tax.

The value object

AttributeTypeDescription
value.amountintegerThe total price for this item (quantity * unit_price.amount).
value.currencystringThe value currency of this item.
value.includes_taxbooleanIs the price inclusive of tax.

The links object

AttributeTypeDescription

The meta object

AttributeTypeDescription
meta.display_priceobjectFormatted display prices based on the currency settings for this request.
meta.display_price.with_taxobjectTax inclusive totals.
meta.display_price.with_tax.unitobjectTax inclusive totals for a single instance of this order item.
meta.display_price.with_tax.unit.amountintegerThe raw price of a single instance this order item (inc tax).
meta.display_price.with_tax.unit.currencystringThe currency set for this order item.
meta.display_price.with_tax.unit.formattedstringThe tax inclusive formatted total of this order item line based on the currency.
meta.display_price.with_tax.valueobjectTax inclusive totals for this order item based on the quantity.
meta.display_price.with_tax.value.amountintegerThe raw total price this order item (inc tax).
meta.display_price.with_tax.value.currencystringThe currency set for this order item.
meta.display_price.with_tax.value.formattedstringThe tax inclusive formatted total of this order item line based on the currency.
meta.display_price.without_taxobjectTax exclusive totals.
meta.display_price.without_tax.unitobjectTax exclusive totals for a single instance of this order item.
meta.display_price.without_tax.unit.amountintegerThe raw price of a single instance this order item (ex tax).
meta.display_price.without_tax.unit.currencystringThe currency set for this order item.
meta.display_price.without_tax.unit.formattedstringThe tax exclusive formatted total of this order item line based on the currency.
meta.display_price.without_tax.valueobjectTax exclusive totals for this order item based on the quantity.
meta.display_price.without_tax.value.amountintegerThe raw total price for this order item (ex tax).
meta.display_price.without_tax.value.currencystringThe currency set for this order item.
meta.display_price.without_tax.value.formattedstringThe tax exclusive formatted total of this order item line based on the currency.
meta.display_price.taxobjectTax totals.
meta.display_price.tax.unitobjectTax totals for a single instance of this order item.
meta.display_price.tax.unit.amountintegerThe subtotal of the added tax value for a single instance of this order item.
meta.display_price.tax.unit.currencystringThe currency set for the tax.
meta.display_price.tax.unit.formattedstringThe formatted value for the tax subtotal.
meta.display_price.tax.valueobjectTax totals for this order item based on the quantity.
meta.display_price.tax.value.amountintegerThe subtotal of the added tax value.
meta.display_price.tax.value.currencystringThe currency set for the tax.
meta.display_price.tax.value.formattedstringThe formatted value for the tax subtotal.
meta.timestampsobjectTimestamps for this product.
meta.timestamps.created_atstringThe creation date of this product.
meta.timestamps.updated_atstringThe last updated date of this product.

The relationships object

AttributeTypeDescription
relationships.cart_itemobjectThe cart item.
relationships.cart_item.dataobjectThe associated cart.
relationships.cart_item.data.typestringThe type represents the object being returned.
relationships.cart_item.data.idstringThe unique identifier for this cart item.
relationships.taxesobjectThe taxes object.
relationships.taxes.dataarrayArray of tax items associated with the order item.
relationships.taxes.data.typestringThe type represents the object being returned.
relationships.taxes.data.idstringThe unique identifier for this tax item.

GET Get order items

https://api.moltin.com/v2/orders/:id/items

Parameters

Path parameters

NameRequiredTypeDescription
idRequiredstringThe ID of the order.

Headers

NameRequiredTypeDescription
AuthorizationRequiredstringThe Bearer token required to get access to the API.

Request examples

Curl

curl -X GET https://api.moltin.com/v2/orders/:id/items \
     -H "Authorization: Bearer XXXX"

JavaScript SDK

const MoltinGateway = require('@moltin/sdk').gateway
const Moltin = MoltinGateway({
  client_id: 'X',
  client_secret: 'X'
})
const orderId = 'XXXX'
Moltin.Orders.Items(orderId).then(items => {
  // Do something
})
// Or using includes
Moltin.Orders.With('items').All().then(orders => {
  // Do something
})

Response

200 OK

{
    "data": [
        {
            "type": "order_item",
            "id": "e8e2655f-3365-49f9-a2f0-1360a295019b",
            "quantity": 1,
            "product_id": "bf8a9d62-6ca9-45f6-85eb-f0d1d9ae7fdd",
            "name": "Woodsy",
            "sku": "WDLP100BRO",
            "unit_price": {
                "amount": 0,
                "currency": "GBP",
                "includes_tax": false
            },
            "value": {
                "amount": 0,
                "currency": "GBP",
                "includes_tax": false
            },
            "links": {},
            "meta": {
                "display_price": {
                    "with_tax": {
                        "unit": {
                            "amount": 0,
                            "currency": "GBP",
                            "formatted": "£0"
                        },
                        "value": {
                            "amount": 0,
                            "currency": "GBP",
                            "formatted": "£0"
                        }
                    },
                    "without_tax": {
                        "unit": {
                            "amount": 0,
                            "currency": "GBP",
                            "formatted": "£0"
                        },
                        "value": {
                            "amount": 0,
                            "currency": "GBP",
                            "formatted": "£0"
                        }
                    },
                    "tax": {
                        "unit": {
                            "amount": 0,
                            "currency": "GBP",
                            "formatted": "£0"
                        },
                        "value": {
                            "amount": 0,
                            "currency": "GBP",
                            "formatted": "£0"
                        }
                    }
                },
                "timestamps": {
                    "created_at": "2018-04-30T10:26:13.342815487Z",
                    "updated_at": "2018-04-30T10:26:13.342815487Z"
                }
            },
            "relationships": {
                "cart_item": {
                    "data": {
                        "type": "cart_item",
                        "id": "62d93144-74ab-4acc-9151-0c96d683c201"
                    }
                },
                "taxes": {
                    "data": [
                        {
                            "type": "tax_item",
                            "id": "6c111e80-9254-4592-b9f4-a30f22b5a8c4"
                        }
                    ]
                }
            },
            "catalog_id": "92073438-7640-4ace-9670-c8c5c1a89cd7",
            "catalog_source": "pim"
        }
    ]
}
Last updated on 5/19/2022
← Update an OrderExport Orders →