Emporix · Schema
cartItemResponse
Cart item details.
CompanyCommerceE-CommerceB2B CommerceHeadless CommerceComposable CommerceCommerce OrchestrationAgentic CommerceiPaaSSoftware-as-a-Service
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/emporix/main/json-schema/emporix-cart-item-response-schema.json",
"title": "cartItemResponse",
"description": "Cart item details.",
"x-generated": "2026-10-18",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/emporix-cart-openapi.yml#/components/schemas/cartItemResponse",
"allOf": [
{
"$ref": "#/$defs/baseCartItemResponse"
},
{
"type": "object",
"properties": {
"price": {
"allOf": [
{
"$ref": "#/$defs/priceRow"
},
{
"type": "object",
"description": "**This field is deprecated**. Please use `unitPrice` instead. The `unitPrice` field provides the same value with updated functionality."
}
],
"deprecated": true
},
"linePrice": {
"description": "Externally calculated total line price (`unit price × quantity`). When provided, this overrides internal calculations.",
"properties": {
"effectiveAmount": {
"type": "number",
"minimum": 0
},
"originalAmount": {
"type": "number",
"minimum": 0
},
"currency": {
"type": "string"
}
},
"required": [
"effectiveAmount",
"originalAmount",
"currency"
]
},
"lineTax": {
"allOf": [
{
"$ref": "#/$defs/taxValueWithQuantity"
}
],
"description": "Externally calculated total tax for the item line. Only allowed when `itemType = EXTERNAL`.",
"required": [
"netValue",
"grossValue",
"rate",
"quantity"
]
},
"couponDiscounts": {
"allOf": [
{
"$ref": "#/$defs/couponDiscounts"
},
{
"type": "object",
"description": "**This field is deprecated**. Please use `calculatedPrice.totalDiscounts.appliedDiscounts` instead. The `calculatedPrice.totalDiscount.appliedDiscounts` field provides the same value with updated functionality."
}
],
"deprecated": true
},
"itemPrice": {
"allOf": [
{
"$ref": "#/$defs/price"
},
{
"type": "object",
"description": "**This field is deprecated**. Please use `unitPrice` instead. The `unitPrice` field provides the same value with updated functionality."
}
],
"deprecated": true
},
"itemTaxInfo": {
"type": "array",
"deprecated": true,
"description": "**This field is deprecated**. Please use `calculatedPrice.price` instead.",
"items": {
"$ref": "#/$defs/taxValue"
}
},
"fees": {
"allOf": [
{
"$ref": "#/$defs/feeAggregate"
},
{
"type": "object",
"description": "**This field is deprecated**. Please use `calculatedPrice.fees` instead. The `calculatedPrice.fees` field provides the same value with updated functionality."
}
],
"deprecated": true
},
"authorizedAmount": {
"allOf": [
{
"$ref": "#/$defs/price"
},
{
"type": "object",
"description": "**This field is deprecated**. Please use `calculatedPrice.upliftValue` instead. The `calculatedPrice.upliftValue` field how much should be payment authorization increased for given item."
}
],
"deprecated": true
},
"totalDiscount": {
"allOf": [
{
"$ref": "#/$defs/price"
},
{
"type": "object",
"description": "**This field is deprecated**. Please use `calculatedPrice.totalDiscount` instead. The `calculatedPrice.totalDiscount` field provides the same value with updated functionality."
}
],
"deprecated": true
},
"externalFees": {
"type": "array",
"deprecated": true,
"description": "**This field is deprecated**. Please use `calculatedPrice.fees` instead. A fee has an enum value that allows to distinguish external prices",
"items": {
"$ref": "#/$defs/externalFee"
}
}
},
"required": [
"quantity",
"effectiveQuantity"
]
}
],
"$defs": {
"YRN": {
"type": "string",
"title": "YRN",
"description": "A unique identifier of a global resource, which stores information about the resource, such as its type, ID or name of the tenant.",
"minLength": 1
},
"baseCartItemResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Cart item's unique identifier generated when the item is added to cart."
},
"keepAsSeparateLineItem": {
"type": "boolean",
"description": "Indicates that products are maintained as individual entries in the cart, rather than being consolidated. When identical products are added multiple times, each addition creates a new line item instead of increasing the quantity of an existing one."
},
"yrn": {
"$ref": "#/$defs/YRN"
},
"product": {
"$ref": "#/$defs/cartItemResponseProduct"
},
"itemYrn": {
"$ref": "#/$defs/YRN"
},
"type": {
"$ref": "#/$defs/itemType"
},
"quantity": {
"type": "number",
"minimum": 0,
"format": "double",
"description": "Quantity of the product added to cart."
},
"effectiveQuantity": {
"type": "number",
"minimum": 0,
"format": "double",
"description": "Effective quantity of the product added to cart."
},
"calculatedPrice": {
"$ref": "#/$defs/itemCalculatedPrice"
},
"taxCode": {
"description": "Tax code. Tax indicated in this field overrides the site's default tax value.",
"type": "string"
},
"unitPrice": {
"allOf": [
{
"$ref": "#/$defs/calculatedPrice"
},
{
"type": "object",
"description": "Product unit price with tax values"
}
]
},
"totalTax": {
"type": "number",
"minimum": 0,
"description": "Product total tax amount.",
"format": "double"
},
"metadata": {
"$ref": "#/$defs/metadataRequest"
},
"mixins": {
"type": "object",
"additionalProperties": true
},
"externalDiscounts": {
"type": "array",
"description": "External discounts applied to this cart item.",
"items": {
"$ref": "#/$defs/externalDiscount"
}
}
},
"required": [
"quantity",
"effectiveQuantity"
],
"description": "Cart item details."
},
"calculatedAppliedDiscount": {
"title": "calculatedAppliedDiscount",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the applied discount."
},
"value": {
"type": "number",
"format": "double",
"description": "The calculated value of the discount."
},
"price": {
"allOf": [
{
"$ref": "#/$defs/calculatedPrice"
},
{
"type": "object",
"description": "Applied discount's price. When discount is applied before tax the value equals `price.netValue` and `price.grossValue` for discount applied after tax."
}
]
},
"discountType": {
"type": "string",
"enum": [
"PERCENT",
"ABSOLUTE",
"FREE_SHIPPING"
],
"description": "The discount type which shows how the discount was calculated. PERCENT refers to a percentage discount for example 10%. ABSOLUTE is a monetary amount."
},
"origin": {
"type": "string",
"enum": [
"INTERNAL",
"EXTERNAL"
],
"description": "Indicates whether the discount is from internal coupon (INTERNAL) or external discount (EXTERNAL)."
}
}
},
"calculatedFee": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the fee."
},
"origin": {
"enum": [
"INTERNAL",
"EXTERNAL"
],
"type": "string",
"description": "INTERNAL defined in commerce engine, EXTERNAL specified when an item is added to the cart"
},
"type": {
"type": "string",
"enum": [
"PERCENT",
"ABSOLUTE",
"ABSOLUTE_MULTIPLY_ITEMQUANTITY"
],
"description": "Type of the fee."
},
"name": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Localized names of the fee."
},
"price": {
"allOf": [
{
"$ref": "#/$defs/calculatedPrice"
},
{
"type": "object",
"description": "The calculated fee price."
}
]
},
"discountedPrice": {
"allOf": [
{
"$ref": "#/$defs/calculatedPriceWithDiscounts"
},
{
"type": "object",
"description": "The discounted fee value."
}
]
}
}
},
"calculatedPrice": {
"type": "object",
"properties": {
"netValue": {
"type": "number",
"format": "double",
"description": "Net value of the price, price without tax."
},
"grossValue": {
"type": "number",
"format": "double",
"description": "Gross value of the price, price with tax."
},
"taxValue": {
"type": "number",
"format": "double",
"description": "Tax value of the price, it's the actual amount of tax that has to be paid."
},
"taxCode": {
"type": "string",
"description": "Tax code applied to the price, a tax code is a country's set of tax rules."
},
"taxRate": {
"type": "number",
"format": "double",
"description": "Tax rate applied to the price, it's the percentage at which an individual or business is taxed."
}
},
"description": "A price calculation model containing net and gross amounts along with their associated tax details."
},
"calculatedPriceWithDiscounts": {
"allOf": [
{
"$ref": "#/$defs/calculatedPrice"
},
{
"type": "object",
"properties": {
"appliedDiscounts": {
"type": "array",
"description": "List of applied discounts for the calculated price.",
"items": {
"$ref": "#/$defs/calculatedAppliedDiscount"
}
}
},
"description": "A price calculation model showing the final amount after applying discounts."
}
]
},
"calculatedTotalDiscount": {
"title": "calculatedTotalDiscount",
"type": "object",
"description": "The total combined value of all applied discounts.",
"properties": {
"calculationType": {
"type": "string",
"enum": [
"ApplyDiscountBeforeTax",
"ApplyDiscountAfterTax"
],
"description": "Indicates whether discounts were calculated using net or gross price values."
},
"value": {
"type": "number",
"format": "double",
"description": "The calculated amount of all discounts."
},
"price": {
"allOf": [
{
"$ref": "#/$defs/calculatedPrice"
},
{
"type": "object",
"description": "Total discounts price. When discounts are applied before tax the value equals `price.netValue` and `price.grossValue` for discounts applied after tax."
}
]
},
"appliedDiscounts": {
"type": "array",
"description": "All applied discounts that are parts of the sum. Sum of all `discountedPrice.appliedDiscounts[].value` and `fees[].discountedPrice.appliedDiscounts[].value`.",
"items": {
"$ref": "#/$defs/calculatedAppliedDiscount"
}
}
}
},
"cartItemResponseProduct": {
"allOf": [
{
"$ref": "#/$defs/product"
},
{
"type": "object",
"properties": {
"vendor": {
"$ref": "#/$defs/vendor"
}
}
}
]
},
"couponDiscount": {
"type": "object",
"properties": {
"couponId": {
"type": "string",
"description": "ID of coupon."
},
"value": {
"type": "number",
"description": "Absolute value indicating how much given coupon lowered the price of given item."
}
}
},
"couponDiscounts": {
"type": "array",
"description": "Collection of couponId-value pairs indicating how much particular coupon lowered absolute price of given item. Coupons of FREE_SHIPPING discount type are not taken into account.",
"items": {
"$ref": "#/$defs/couponDiscount"
}
},
"externalDiscount": {
"type": "object",
"description": "External discount that can be applied to cart items.",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the external discount."
},
"discountType": {
"$ref": "#/$defs/externalDiscountType"
},
"value": {
"type": "number",
"format": "double",
"minimum": 0.0,
"maximum": 100.0,
"description": "Value of the discount (percentage e.g 15.00 -> 15% or absolute amount e.g 10.00 -> 10 EUR depending on the discountType)."
},
"includeFees": {
"type": "boolean",
"description": "Flag indicating whether the discount should be also applied to fees."
},
"sequence": {
"type": "integer",
"description": "Sequence number determining the order in which discounts are applied. The lowest sequence number is applied first."
}
},
"required": [
"id",
"discountType",
"value"
]
},
"externalDiscountType": {
"type": "string",
"description": "Type of the external discount.",
"enum": [
"PERCENT",
"ABSOLUTE"
]
},
"externalFee": {
"type": "object",
"required": [
"feeType"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the fee."
},
"name": {
"allOf": [
{
"$ref": "#/$defs/localizedValue"
},
{
"type": "object",
"description": "Fee name."
}
]
},
"yrn": {
"type": "string",
"description": "Unique identifier of the fee."
},
"feeType": {
"type": "string",
"description": "Type of the fee.",
"enum": [
"PERCENT",
"ABSOLUTE",
"ABSOLUTE_MULTIPLY_ITEMQUANTITY"
]
},
"feePercentage": {
"type": "number",
"description": "Value of fee as percentage. It must be provided when feeType equals `PERCENT`."
},
"feeAbsolute": {
"type": "object",
"description": "Value of fee as absolute. It must be provided when feeType equals `ABSOLUTE` or `ABSOLUTE_MULTIPLY_ITEMQUANTITY`.",
"required": [
"currency",
"amount"
],
"properties": {
"currency": {
"type": "string",
"description": "Currency of fee absolute."
},
"amount": {
"type": "number",
"description": "Value of fee absolute."
}
}
},
"taxable": {
"type": "boolean",
"description": "Whether tax should be included to the fee or not."
},
"taxCode": {
"type": "string",
"description": "Tax code of the fee."
},
"taxValues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the tax."
},
"rate": {
"type": "number",
"description": "Rate of the tax."
},
"taxable": {
"type": "number",
"description": "The taxable amount."
},
"value": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Currency of the tax."
},
"amount": {
"type": "number",
"description": "Value of the tax."
}
}
}
}
}
}
}
},
"fee": {
"title": "fee",
"type": "object",
"properties": {
"yrn": {
"$ref": "#/$defs/YRN"
},
"name": {
"$ref": "#/$defs/localizedValue"
},
"taxCode": {
"type": "string"
},
"amount": {
"type": "number",
"format": "double",
"minimum": 0,
"description": ""
},
"totalTax": {
"type": "number",
"format": "double",
"minimum": 0
},
"total": {
"$ref": "#/$defs/total"
},
"taxValues": {
"type": "array",
"items": {
"$ref": "#/$defs/taxValue"
}
}
},
"required": [
"amount",
"totalTax",
"total"
]
},
"feeAggregate": {
"type": "object",
"properties": {
"elements": {
"description": "",
"type": "array",
"items": {
"$ref": "#/$defs/fee"
}
},
"total": {
"$ref": "#/$defs/total"
}
}
},
"itemCalculatedPrice": {
"type": "object",
"properties": {
"price": {
"allOf": [
{
"$ref": "#/$defs/calculatedPrice"
},
{
"type": "object",
"description": "The price is calculated by multiplying the unit price (taken from priceMatch) by the quantity."
},
{
"properties": {
"calculated": {
"type": "string",
"description": "Indicates how the line item price was determined. - `INTERNAL` — Calculated by Emporix using unit price × quantity. - `EXTERNAL` — Provided externally with `lineTax`.",
"enum": [
"INTERNAL",
"EXTERNAL"
]
}
}
}
]
},
"upliftValue": {
"allOf": [
{
"$ref": "#/$defs/calculatedPrice"
},
{
"type": "object",
"description": "Maximum additional amount authorized for payment to cover potential price adjustments during packaging of weight-based products. For example, if the item’s `price.netValue=12`, the `upliftValue.netValue=1,2`, with 10% uplift configured. If the uplift value is not configured for an item, it's not returned in the response.",
"properties": {
"netValue": {
"type": "number",
"format": "double",
"description": "Net value of the uplift amount, value without tax."
},
"grossValue": {
"type": "number",
"format": "double",
"description": "Gross value of the uplift amount, value with tax."
},
"taxValue": {
"type": "number",
"format": "double",
"description": "Tax value of the uplift amount, it's the actual amount of tax that has to be paid."
},
"taxCode": {
"type": "string",
"description": "Tax code applied to uplift amount, a tax code is a country's set of tax rules."
},
"taxRate": {
"type": "number",
"format": "double",
"description": "Tax rate applied to the uplift amount, it's the percentage at which an individual or business is taxed."
}
}
}
]
},
"discountedPrice": {
"allOf": [
{
"$ref": "#/$defs/calculatedPriceWithDiscounts"
},
{
"type": "object",
"description": "The total price for the item line calculated by multiplying the unit price by the quantity, with applied discounts. If there are no applied discounts to the given line item, the attribute is not returned in the response.",
"properties": {
"netValue": {
"type": "number",
"format": "double",
"description": "The net value after applying discounts, calculated if `includesTax=false`."
},
"grossValue": {
"type": "number",
"format": "double",
"description": "The gross value after applying discounts, calculated if `includesTax=true`."
},
"taxValue": {
"type": "number",
"format": "double",
"description": "The difference between `grossValue` and `netValue`."
},
"taxRate": {
"type": "number",
"format": "double",
"description": "Tax rate applied to the discounted price, it's the percentage at which an individual or business is taxed."
},
"taxCode": {
"type": "string",
"description": "Tax code applied to the discounted price, a tax code is a country's set of tax rules."
},
"appliedDiscounts": {
"type": "array",
"description": "A list of discounts applied to the line item.",
"items": {
"allOf": [
{
"$ref": "#/$defs/calculatedAppliedDiscount"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Discount identifier."
},
"value": {
"type": "number",
"format": "double",
"description": "Value of the discount that was applied."
},
"discountType": {
"type": "string",
"enum": [
"PERCENT",
"ABSOLUTE",
"FREE_SHIPPING"
],
"description": "PERCENT for percentage discounts and ABSOLUTE for amount applied to the line item."
}
}
}
]
}
}
}
}
]
},
"fees": {
"type": "array",
"description": "A list of fees applied to the line item. If there are no fees on the item line, it's not returned in the response.",
"items": {
"allOf": [
{
"$ref": "#/$defs/calculatedFee"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Fee identifier."
},
"type": {
"type": "string",
"enum": [
"PERCENT",
"ABSOLUTE",
"ABSOLUTE_MULTIPLY_ITEMQUANTITY"
],
"description": "PERCENT for fee percentage of the item's line `price.netValue` - unit price x quantity. ABSOLUTE for the absolute amount assigned to the item line. ABSOLUTE_MULTIPLY_ITEMQUANTITY for the monetary amount multiplied by the item quantity and assigned to the item line."
},
"origin": {
"enum": [
"INTERNAL",
"EXTERNAL"
],
"type": "string",
"description": "INTERNAL defined in commerce engine, EXTERNAL specified when an item is added to the cart."
},
"name": {
"type": "object",
"description": "Fee name."
},
"price": {
"description": "The calculated price of the fee.",
"properties": {
"netValue": {
"type": "number",
"format": "double",
"description": "Monetary amount of the fee, depends on the fee type."
},
"grossValue": {
"type": "number",
"format": "double",
"description": "Value calculated based on the `taxCode` and the `taxRate` if `taxable=true`."
},
"taxRate": {
"type": "number",
"format": "double",
"description": "If a fee is defined with the attribute `taxable=true`, the tax rate is calculated based on the provided `taxCode` at the fee level. A taxable fee must have a defined `taxCode`."
},
"taxCode": {
"type": "string",
"description": "Tax code defined on the fee level, for example STANDARD. The value should match the available tax codes in the system configuration."
},
"discountedPrice": {
"allOf": [
{
"$ref": "#/$defs/calculatedPriceWithDiscounts"
},
{
"type": "object",
"description": "The total price for the item line calculated by multiplying the unit price by the quantity, with applied discounts. If there are no applied discounts to the given line item, the attribute is not returned in the response.",
"properties": {
"netValue": {
"type": "number",
"format": "double",
"description": "The net value after applying discounts, calculated if `includesTax=false`."
},
"grossValue": {
"type": "number",
"format": "double",
"description": "The gross value after applying discounts, calculated if `includesTax=true`."
},
"taxValue": {
"type": "number",
"format": "double",
"description": "The difference between `grossValue` and `netValue`."
},
"taxRate": {
"type": "number",
"format": "double",
"description": "Refers to `fees[].price.taxRate`."
},
"taxCode": {
"type": "string",
"description": "Refers to `fees[].price.taxCode`."
},
"appliedDiscounts": {
"type": "array",
"description": "A list of discounts applied to the line item.",
"items": {
"allOf": [
{
"$ref": "#/$defs/calculatedAppliedDiscount"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Discount identifier."
},
"value": {
"type": "number",
"format": "double",
"description": "Monetary amount of the discount applied to the price for the given discount ID."
},
"discountType": {
"type": "string",
"enum": [
"PERCENT",
"ABSOLUTE",
"FREE_SHIPPING"
],
"description": "PERCENT for percentage discounts and ABSOLUTE for amount applied to the line item."
}
}
}
]
}
}
}
}
]
}
}
}
}
}
]
}
},
"totalFee": {
"allOf": [
{
"$ref": "#/$defs/calculatedPriceWithDiscounts"
},
{
"type": "object",
"description": "Sum of all fees applied to the item. It's calculated by summarizing `fees[].discountedPrice` if any discounts were applied to the fee, or `fees[].price` for an pre-discounted fee. If there are no fees applied to the line item, it's not returned in the response. The `totalFee` is the value after all the discounts, if any dis
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://artifacts.apis.io/emporix/json-schema/emporix-cart-item-response-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/emporix-cart-item-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.