• Orders/
    Orders API/
    Order Items

    Order Items

    The Order Item Object

    The bundle_configuration object was misspelled in the cart, cart items, and order items. Therefore, on October 18, 2022, we have deprecated bundle_configuation(misspelled) and recommend that you use bundle_configuration to create a bundle configuration.

    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 pricing information about a single instance of this item.
    discountsobjectThe list of all promotion codes and corresponding discount amount applied for the item.
    valueobjectThe pricing information and total value of this order based on the quantity.
    linksobjectA collection of URLs related to this resource.
    componentsobjectThe bundle name, id, type, and quantity.
    bundle_configurationobjectThe list of all the selected_options.
    metaobjectAdditional information calculated for this order.
    relationshipsobjectThe relationships object.
    catalog_sourcestringThe catalog source. Always pim or legacy.
    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": "4f3d66d5-c42b-45d5-86fb-08e38f466fc7",
                "quantity": 1,
                "product_id": "24f50e56-b229-46ad-8ab6-eb0b8d51429f",
                "name": "$10 off your order!",
                "sku": "10off",
                "unit_price": {
                    "amount": -1000,
                    "currency": "USD",
                    "includes_tax": false
                },
                "value": {
                    "amount": -1000,
                    "currency": "USD",
                    "includes_tax": false
                },
                "links": {},
                "meta": {
                    "display_price": {
                        "with_tax": {
                            "unit": {
                                "amount": -1000,
                                "currency": "USD",
                                "formatted": "-$10.00"
                            },
                            "value": {
                                "amount": -1000,
                                "currency": "USD",
                                "formatted": "-$10.00"
                            }
                        },
                        "without_tax": {
                            "unit": {
                                "amount": -1000,
                                "currency": "USD",
                                "formatted": "-$10.00"
                            },
                            "value": {
                                "amount": -1000,
                                "currency": "USD",
                                "formatted": "-$10.00"
                            }
                        },
                        "tax": {
                            "unit": {
                                "amount": 0,
                                "currency": "USD",
                                "formatted": "$0.00"
                            },
                            "value": {
                                "amount": 0,
                                "currency": "USD",
                                "formatted": "$0.00"
                            }
                        },
                        "discount": {
                            "unit": {
                                "amount": 0,
                                "currency": "USD",
                                "formatted": "$0.00"
                            },
                            "value": {
                                "amount": 0,
                                "currency": "USD",
                                "formatted": "$0.00"
                            }
                        },
                        "without_discount": {
                            "unit": {
                                "amount": 0,
                                "currency": "USD",
                                "formatted": "$0.00"
                            },
                            "value": {
                                "amount": 0,
                                "currency": "USD",
                                "formatted": "$0.00"
                            }
                        }
                    },
                    "timestamps": {
                        "created_at": "2022-10-19T22:03:37Z",
                        "updated_at": "2022-10-19T22:03:37Z"
                    }
                },
                "relationships": {
                    "cart_item": {
                        "data": {
                            "type": "cart_item",
                            "id": "8561c752-9e6a-480c-b02f-57563144af36"
                        }
                    }
                }
            },
            {
                "type": "order_item",
                "id": "d3c5fcd1-80dc-4b3b-b8d3-a2ce0ebedc60",
                "quantity": 1,
                "product_id": "ed9faf9e-d131-44e9-ac60-9a4037c9bd09",
                "name": "nested bundle",
                "sku": "nested-bundle",
                "unit_price": {
                    "amount": 9999,
                    "currency": "USD",
                    "includes_tax": false
                },
                "value": {
                    "amount": 9999,
                    "currency": "USD",
                    "includes_tax": false
                },
                "discounts": [
                    {
                        "amount": {
                            "amount": -1000,
                            "currency": "USD",
                            "includes_tax": false
                        },
                        "code": "nested-bundle_10",
                        "id": "c2d58e64-aaf0-4780-bd1e-6bdbcbacdd74"
                    }
                ],
                "components": {
                    "component 2": {
                        "name": "component 2",
                        "options": [
                            {
                                "id": "7d28f075-0110-4cd4-8d58-15cda55c8b5b",
                                "type": "product",
                                "quantity": 1
                            }
                        ]
                    },
                    "component1": {
                        "name": "component1",
                        "options": [
                            {
                                "id": "3a16e947-fcb1-4673-b5a9-8b0778b08f5c",
                                "type": "product",
                                "quantity": 1
                            },
                            {
                                "id": "bd139213-3cd0-4bc5-bcd4-bd74adf00db2",
                                "type": "product",
                                "quantity": 1
                            }
                        ]
                    }
                },
                "bundle_configuration": {
                    "selected_options": {
                        "component 2": {
                            "7d28f075-0110-4cd4-8d58-15cda55c8b5b": 1
                        },
                        "component1": {
                            "3a16e947-fcb1-4673-b5a9-8b0778b08f5c": 1
                        }
                    }
                },
                "links": {},
                "meta": {
                    "display_price": {
                        "with_tax": {
                            "unit": {
                                "amount": 7999,
                                "currency": "USD",
                                "formatted": "$79.99"
                            },
                            "value": {
                                "amount": 7999,
                                "currency": "USD",
                                "formatted": "$79.99"
                            }
                        },
                        "without_tax": {
                            "unit": {
                                "amount": 7999,
                                "currency": "USD",
                                "formatted": "$79.99"
                            },
                            "value": {
                                "amount": 7999,
                                "currency": "USD",
                                "formatted": "$79.99"
                            }
                        },
                        "tax": {
                            "unit": {
                                "amount": 0,
                                "currency": "USD",
                                "formatted": "$0.00"
                            },
                            "value": {
                                "amount": 0,
                                "currency": "USD",
                                "formatted": "$0.00"
                            }
                        },
                        "discount": {
                            "unit": {
                                "amount": -2000,
                                "currency": "USD",
                                "formatted": "-$20.00"
                            },
                            "value": {
                                "amount": -2000,
                                "currency": "USD",
                                "formatted": "-$20.00"
                            }
                        },
                        "without_discount": {
                            "unit": {
                                "amount": 9999,
                                "currency": "USD",
                                "formatted": "$99.99"
                            },
                            "value": {
                                "amount": 9999,
                                "currency": "USD",
                                "formatted": "$99.99"
                            }
                        },
                        "discounts": {
                            "nested-bundle_10": {
                                "amount": -1000,
                                "currency": "USD",
                                "formatted": "-$10.00"
                            }
                        }
                    },
                    "timestamps": {
                        "created_at": "2022-10-19T22:03:37Z",
                        "updated_at": "2022-10-19T22:03:37Z"
                    }
                },
                "relationships": {
                    "cart_item": {
                        "data": {
                            "type": "cart_item",
                            "id": "f003b967-6d12-4289-8d39-4451ea0ea17a"
                        }
                    }
                },
                "catalog_id": "09b9359f-897f-407f-89a2-702e167fe781",
                "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 discounts Object

    AttributeTypeDescription
    discounts.amount.amountintegerThe discount amount for this item.
    discounts.amount.currencystringThe currency for this item.
    discounts.amount.includes_taxstringIs the discount inclusive of tax?
    discounts.codestringThe discount code.
    discounts.idstringThe unique identifier of the promotion.
    AttributeTypeDescription
    links.productstringA link to the product this cart item is a snapshot of (not for custom_items).

    The components Object

    AttributeTypeDescription
    components.namestringThe component name. The component name is the name that is displayed in your storefront.
    components.optionsarrayThe product options that make up this component.
    components.options.idstringThe unique Id of the product you want to add to their component.
    components.options.typestringMust be always product.
    components.options.quantitystringThe number of this product option that a shopper must purchase.

    The bundle_configuration Object

    AttributeTypeDescription
    bundle_configuration.selected_optionsobjectThe components a shopper has selected options from in a dynamic bundle.

    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.display_price.discountobjectThe discount object describes the unit discount value and total discount value.
    meta.display_price.discount.unitobjectThe unit object specifies the amount, currency, and formatted value of the total discounted amount applied to a unit item.
    meta.display_price.discount.unit.amountintegerThe discounted amount applied to individual unit item.
    meta.display_price.discount.unit.currencyintegerThe currency set for the order item.
    meta.display_price.discount.unit.formattedstringThe formatted value of the total discounted amount applied to the individual unit item.
    meta.display_price.discount.valueobjectThe value object specifies the amount, currency, and formatted value of the total discounted amount applied to the order based on the quantity.
    meta.display_price.discount.value.amountintegerThe total discounted amount applied to the order item based on the quantity.
    meta.display_price.discount.value.currencystringThe currency set for the order item.
    meta.display_price.discount.value.formattedstringThe formatted value of the total discounted amount applied to the order item based on the quantity.
    meta.display_price.without_discountobjectThe without_discount object describes the unit value and total value of the order without the discount.
    meta.display_price.without_discount.unitobjectThe unit object specifies the amount, currency, and formatted value applied to a unit item without the discount.
    meta.display_price.without_discount.unit.amountintegerThe total price applied to a unit item without the discount.
    meta.display_price.without_discount.unit.currencystringThe currency set for this order item.
    meta.display_price.without_discount.unit.formattedintegerThe total formatted amount for this item without the discount.
    meta.display_price.without_discount.valueobjectThe value object specifies the amount, currency, and formatted value of the order item without the discount based on the quantity.
    meta.display_price.without_discount.value.amountintegerThe total amount applied to the order item without the discount based on the quantity.
    meta.display_price.without_discount.value.currencystringThe currency set for this order item.
    meta.display_price.without_discount.value.formattedstringThe total amount applied to the order item without the discount based on the quantity.
    meta.display_price.discountsobjectThe list of all promotion codes and corresponding discount amount applied for the item.
    meta.display_price.discounts.amountintegerThe discounted amount applied to item.
    meta.display_price.discounts.currencystringThe currency set for this order item.
    meta.display_price.discounts.formattedstringThe formatted value of the discount price applied for this item.
    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.

    Was this helpful?

    Previous
    Get Order Items