commerce/orders/orderitems

Use this subresource to retrieve details about items in an active order.

JSON Example

OrderItem Properties

Property Description
adjustedLineItemSubtotal

type: decimal

The adjusted subtotal of the line item, including all manual adjustments, discounts, shipping charges and discounts, and duty or any other additional line item fees.

auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

autoAddDiscountId

type: int

If an item was automatically added as a result of a BOGA discount (i.e. this is the free item), this field will be populated with the corresponding BOGA discount ID.

data

type: Mozu.Core.Api.Contracts.Json

Custom data for a given vendor set within the commerce process.

destinationId

type: string

The destination the order item will ship to.

discountedTotal

type: decimal

The subtotal of the cart, order, and wishlist items, including any applied discount calculations. Wishlist subtotals may change depending on the length of time, available discounts, and stock amounts of products at the time of review by shoppers.

discountTotal

type: decimal

Estimated amount of discounts applied to all items in the carts and orders. System-supplied and read-only. This value will be available at the wish list, cart item, order item, and wish list item level at a later time.

dutyAmount

type: decimal

Duty or Tariff for this item

extendedTotal

type: decimal

Represents the total price of the cart item extended to the shopper. This begins with the Unit Price, then uses any of the following prices if they are defined, in the following order: Override Amount, Sale Amount, List Amount. This value is not calculated for wish lists at this time.

feeTotal

type: decimal

The monetary sum of all fees incurred in the cart, order, line item in a cart, or line item in an order. This value is not calculated for wish lists at this time.

fulfillmentLocationCode

type: string

The code that identifies the location used to fulfill the cart/cart item or order/order item. This code can include physical store locations for in-store pickup, warehouse locations providing the products for shipment, or the location for the digital file(s).

fulfillmentMethod

type: string

The method used to fulfill this cart or order item. The method includes direct ship or in-store pickup. The available methods depend on the supported fulfillment types for the product.

handlingAmount

type: decimal

The combined price for all handling costs calculated together for shipped orders, not for digital or in-store pickup. This includes all handling costs per the product line items and options, excluding taxes and discounts.

id

type: string

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

isRecurring

type: bool

Indicates if the product in a cart, order, or wish list is purchased on a recurring schedule. If true, the item can be purchased or fulfilled at regular intervals, such as a monthly billing cycle. For example, digital or physical product subscriptions are recurring cart items. This property is not used at this time and is reserved for future functionality.

isTaxable

type: bool

Indicates if the item is subject to taxation, used by products, options, extras, cart and order items, line items, and wish lists. If true, the entity is subject to tax based on the relevant tax rate and rules.

itemTaxTotal

type: decimal

The total amount of calculated tax for items, used by carts, orders, and wish lists.

lineId

type: int

The line id assigned to the order item. Visible only in the Admin, this is set from the Admin or in CommerceRuntime when a cart is converted to an order.

localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

originalCartItemId

type: string

The unique identifier of the item when it was applied to a cart, prior to checkout, when the cart became an order.

product

type: product

The properties of a product, referenced and used by carts, orders, wish lists, and returns.

product.allocationExpiration

type: DateTime

Allocation ID associated with this product on this order.

product.allocationId

type: int

Allocation ID associated with this product on this order.

product.bundledProducts

type: list of bundledProduct

Properties of a collection of component products that make up a single product bundle with its own product code. Tenants can define product bundles for any product type that supports the Bundle product usage.

product.bundledProduct.allocationExpiration

type: DateTime

Allocation ID associated with this product on this order.

product.bundledProduct.allocationId

type: int

Allocation ID associated with this product on this order.

product.bundledProduct.creditValue

type: decimal

The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards.

product.bundledProduct.deltaPrice

type: decimal

If the product is in relative pricing mode, this is the difference between associated prices for a product, variation option, or extra. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. For example, if a product with a defined monogram extra costs an additional $10, the `deltaPrice `value is "10". Between options, a price for a medium may be $10 and a large $12 giving a `deltaPrice `value of "2".

Refer to Product Variant Pricing and Weight in the Products guides topic for more information.

product.bundledProduct.description

type: string

The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types.

product.bundledProduct.fulfillmentStatus

type: string

Fulfillment status of the product.

product.bundledProduct.goodsType

type: string

The type of goods in a bundled product. A bundled product is composed of products associated to sell together. Possible values include “Physical” and “DigitalCredit”. This comes from the `productType `of the product. Products are defaulted to a Physical `goodsType`. Gift cards have a `goodsType `of DigitalCredit.

product.bundledProduct.isPackagedStandAlone

type: bool

Indicates if the product must be shipped alone in a container. This is used for products and products within a bundle. If true, this product cannot be shipped in a package with other items and must ship in a package by itself.

product.bundledProduct.measurements

type: packageMeasurements

Dimensional properties (height, length, and width) of packages, products and bundles.

product.bundledProduct.packageMeasurements.height

type: measurement

Height of the package in imperial units of feet and inches.

product.bundledProduct.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

product.bundledProduct.packageMeasurements.measurement.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

product.bundledProduct.packageMeasurements.length

type: measurement

Length of the package in imperial units of feet and inches.

product.bundledProduct.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

product.bundledProduct.packageMeasurements.measurement.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

product.bundledProduct.packageMeasurements.weight

type: measurement

Weight of the package in imperial units of pounds and ounces.

product.bundledProduct.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

product.bundledProduct.packageMeasurements.measurement.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

product.bundledProduct.packageMeasurements.width

type: measurement

Width of the package in imperial units of feet and inches.

product.bundledProduct.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

product.bundledProduct.packageMeasurements.measurement.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

product.bundledProduct.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

product.bundledProduct.optionAttributeFQN

type: string

Fully qualified name of the selected option's attribute. Bundledproducts result from a static bundle or are dynamically added as a result of the shopper selecting products as extras. When the bundled item is dynamic, it includes the attribute's fully qualified name of the extra that it came from. When `optionAttributeFQN `is null, the bundled item was statically defined. When not null, the item came from an extra selection.

product.bundledProduct.optionValue

type: object

The value of the option attribute. These values are associated and used by product bundles and options.

product.bundledProduct.productCode

type: string

The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.

product.bundledProduct.productReservationId

type: int

Unique identifier of the product reservation associated with the component product in a product bundle or item in a cart/order. System-supplied and read only.

product.bundledProduct.quantity

type: int

The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations.

product.categories

type: list of category

The list of all categories associated with the product. These categories contain products, can have discounts associated, and define the grouping of products to display on the storefront.

product.category.id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

product.category.parent

type: Mozu.CommerceRuntime.Contracts.Products.Category

If applicable, the parent category in the category tree. This can be associated to a product as the parent category.

product.description

type: string

The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types.

product.discountsRestricted

type: bool

Indicates if the discount is restricted. If true, the system cannot apply any discounts to this product. Discount restrictions are defined at the master catalog level. Client administrators cannot override discount restrictions at the catalog level, but they can limit the restriction to a defined time interval.

For price list entries, specifies whether discounts are restricted for the specific entry if discountRestrictedMode is set to Overridden.

Refer to Discount Restriction in the Price Lists guides topic for more information.

product.discountsRestrictedEndDate

type: DateTime

The date and time on which the discount restriction period ends.

product.discountsRestrictedStartDate

type: DateTime

The date and time on which the discount restriction period starts.

product.fulfillmentStatus

type: string

Fulfillment status of the product.

product.fulfillmentTypesSupported

type: list of string

List of supported types of fulfillment for the product or variation. The types include direct ship, in-store pickup, or both.

product.goodsType

type: string

The type of goods in a bundled product. A bundled product is composed of products associated to sell together. Possible values include “Physical” and “DigitalCredit”. This comes from the `productType `of the product. Products are defaulted to a Physical `goodsType`. Gift cards have a `goodsType `of DigitalCredit.

product.imageAlternateText

type: string

The alternate image description defined for the product, in the language specified in the locale code for the storefront.

product.imageUrl

type: string

The URL link for the image file associated with a product or category.

product.isPackagedStandAlone

type: bool

Indicates if the product must be shipped alone in a container. This is used for products and products within a bundle. If true, this product cannot be shipped in a package with other items and must ship in a package by itself.

product.isRecurring

type: bool

Indicates if the product in a cart, order, or wish list is purchased on a recurring schedule. If true, the item can be purchased or fulfilled at regular intervals, such as a monthly billing cycle. For example, digital or physical product subscriptions are recurring cart items. This property is not used at this time and is reserved for future functionality.

product.isTaxable

type: bool

Indicates if the item is subject to taxation, used by products, options, extras, cart and order items, line items, and wish lists. If true, the entity is subject to tax based on the relevant tax rate and rules.

product.measurements

type: packageMeasurements

Dimensional properties (height, length, and width) of packages, products and bundles.

product.packageMeasurements.height

type: measurement

Height of the package in imperial units of feet and inches.

product.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

product.packageMeasurements.measurement.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

product.packageMeasurements.length

type: measurement

Length of the package in imperial units of feet and inches.

product.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

product.packageMeasurements.measurement.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

product.packageMeasurements.weight

type: measurement

Weight of the package in imperial units of pounds and ounces.

product.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

product.packageMeasurements.measurement.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

product.packageMeasurements.width

type: measurement

Width of the package in imperial units of feet and inches.

product.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

product.packageMeasurements.measurement.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

product.mfgPartNumber

type: string

The manufacturer's part number for the product.

product.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

product.options

type: list of productOption

List of option attributes configured for an object. These values are associated and used by products, product bundles, and product types.

product.productOption.attributeFQN

type: string

The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name.

product.productOption.dataType

type: string

The data type of the source product property, typically of type Bool, DateTime, Number, or String.

product.productOption.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

product.productOption.shopperEnteredValue

type: object

The value a shopper entered for an attribute that requires additional input for the product on a storefront. This entered value is a selected option or entered content for an extra, such as selecting a color or entering content for a monogram.

product.productOption.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

product.productOption.value

type: object

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

product.price

type: productPrice

The price of either the product or shipping.

This amount can be affected by discounts and/or fees. For products, this amount can also be affected by price lists.

product.productPrice.creditValue

type: decimal

The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards.

product.productPrice.msrp

type: decimal

The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier.

product.productPrice.price

type: decimal

The price of either the product or shipping.

This amount can be affected by discounts and/or fees. For products, this amount can also be affected by price lists.

product.productPrice.priceListCode

type: string

If the product's price comes from a price list, this property is the code of the price list with which the product is associated.

product.productPrice.priceListEntryMode

type: string

The price list entry mode of the product. This property is for future funtionality and currently should only be Simple.

product.productPrice.salePrice

type: decimal

The set sale price for a product consisting of a price with a discount already applied.

For price list entries, this property is the product's sale price if the priceListEntryPrice.salePriceMode is set to Overridden.

product.productPrice.tenantOverridePrice

type: decimal

The override price defined by the tenant for this cart or order item.

product.productCode

type: string

The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.

product.productReservationId

type: int

Unique identifier of the product reservation associated with the component product in a product bundle or item in a cart/order. System-supplied and read only.

product.productType

type: string

A product type is like a product template.

product.productUsage

type: string

The usage type that applies to this product, which is Standard (a single product without configurable options), Configurable (a product that includes configurable option attributes), Bundle (a collection of products sold as a single entity), or Component (an invididual product that represents a component in a bundle).

product.properties

type: list of productProperty

Collection of property attributes defined for the object. Properties are associated to all objects within Kibo eCommerce, including documents, products, and product types.

product.productProperty.attributeFQN

type: string

The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name.

product.productProperty.dataType

type: string

The data type of the source product property, typically of type Bool, DateTime, Number, or String.

product.productProperty.isMultiValue

type: bool

Indicates if the object has or can have multiple properties or values. If true, the object can have more than one value, selectable by shoppers through the storefront or configurable through the catalogs.

product.productProperty.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

product.productProperty.values

type: list of productPropertyValue

List of value data for objects.

product.productProperty.productPropertyValue.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

product.productProperty.productPropertyValue.value

type: object

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

product.upc

type: string

The universal product code (UPC) is the barcode defined for the product. The UPC is unique across all sales channels.

product.variationProductCode

type: string

Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code.

productDiscount

type: appliedLineItemProductDiscount

The applicable product discount for an associated cart, order, or wish list.

appliedLineItemProductDiscount.appliesToSalePrice

type: bool

Determines if the discount applies to the sale price of the order.

appliedLineItemProductDiscount.couponCode

type: string

The coupon code that a shopper uses to redeem an associated discount on a purchase. This is also the unique identifier of the coupon itself.

appliedLineItemProductDiscount.discount

type: discount

Name of the discount added and applied to a shopping cart and order for a shopper's purchase.

appliedLineItemProductDiscount.discount.expirationDate

type: DateTime

Date and time in UTC format when a discount, credit, wish list, or cart expires. An expired discount no longer can be redeemed. An expired wish list is no longer available. An expired credit can no longer be redeemed for a purchase. Acart becomes inactive and expired based on a system-calculated interval. For example, if an anonymous shopper has 14 days of inactivity, the cart is considered abandoned after that period of inactivity. System-supplied and read-only.

appliedLineItemProductDiscount.discount.id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

appliedLineItemProductDiscount.discount.itemIds

type: list of string

List of cart or order items to which the discount applies, if applicable.

appliedLineItemProductDiscount.discount.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

appliedLineItemProductDiscount.discountQuantity

type: int

The number of the line items that are used for this particular discount.

appliedLineItemProductDiscount.excluded

type: bool

Indicates if a discount is not used for the product or product line item in an order. If true, the system ignores this discount when pricing the order.

appliedLineItemProductDiscount.impact

type: decimal

The value of the discount applied to the cart or order, represented as a negative currency amount to apply to the original price.

appliedLineItemProductDiscount.impactPerUnit

type: decimal

The impact of a discount for each discount quantity.

appliedLineItemProductDiscount.productQuantity

type: int

Quantity of products priced. This is always one unless calculating pricing on the order or cart.

productDiscounts

type: list of appliedLineItemProductDiscount

List of product-level discounts projected to apply to a cart, order, or wish list.

appliedLineItemProductDiscount.appliesToSalePrice

type: bool

Determines if the discount applies to the sale price of the order.

appliedLineItemProductDiscount.couponCode

type: string

The coupon code that a shopper uses to redeem an associated discount on a purchase. This is also the unique identifier of the coupon itself.

appliedLineItemProductDiscount.discount

type: discount

Name of the discount added and applied to a shopping cart and order for a shopper's purchase.

appliedLineItemProductDiscount.discount.expirationDate

type: DateTime

Date and time in UTC format when a discount, credit, wish list, or cart expires. An expired discount no longer can be redeemed. An expired wish list is no longer available. An expired credit can no longer be redeemed for a purchase. Acart becomes inactive and expired based on a system-calculated interval. For example, if an anonymous shopper has 14 days of inactivity, the cart is considered abandoned after that period of inactivity. System-supplied and read-only.

appliedLineItemProductDiscount.discount.id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

appliedLineItemProductDiscount.discount.itemIds

type: list of string

List of cart or order items to which the discount applies, if applicable.

appliedLineItemProductDiscount.discount.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

appliedLineItemProductDiscount.discountQuantity

type: int

The number of the line items that are used for this particular discount.

appliedLineItemProductDiscount.excluded

type: bool

Indicates if a discount is not used for the product or product line item in an order. If true, the system ignores this discount when pricing the order.

appliedLineItemProductDiscount.impact

type: decimal

The value of the discount applied to the cart or order, represented as a negative currency amount to apply to the original price.

appliedLineItemProductDiscount.impactPerUnit

type: decimal

The impact of a discount for each discount quantity.

appliedLineItemProductDiscount.productQuantity

type: int

Quantity of products priced. This is always one unless calculating pricing on the order or cart.

purchaseLocation

type: string

The location where the item was purchased.

quantity

type: int

The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations.

shippingAmountBeforeDiscountsAndAdjustments

type: decimal

The total shipping amount for the line item before discounts and adjustments.

shippingDiscounts

type: list of appliedLineItemShippingDiscount

List of shipping discounts projected to apply to carts, orders, and wish lists and items at checkout.

appliedLineItemShippingDiscount.discount

type: appliedDiscount

Name of the discount added and applied to a shopping cart and order for a shopper's purchase.

appliedLineItemShippingDiscount.appliedDiscount.couponCode

type: string

The coupon code that a shopper uses to redeem an associated discount on a purchase. This is also the unique identifier of the coupon itself.

appliedLineItemShippingDiscount.appliedDiscount.discount

type: discount

Name of the discount added and applied to a shopping cart and order for a shopper's purchase.

appliedLineItemShippingDiscount.appliedDiscount.discount.expirationDate

type: DateTime

Date and time in UTC format when a discount, credit, wish list, or cart expires. An expired discount no longer can be redeemed. An expired wish list is no longer available. An expired credit can no longer be redeemed for a purchase. Acart becomes inactive and expired based on a system-calculated interval. For example, if an anonymous shopper has 14 days of inactivity, the cart is considered abandoned after that period of inactivity. System-supplied and read-only.

appliedLineItemShippingDiscount.appliedDiscount.discount.id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

appliedLineItemShippingDiscount.appliedDiscount.discount.itemIds

type: list of string

List of cart or order items to which the discount applies, if applicable.

appliedLineItemShippingDiscount.appliedDiscount.discount.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

appliedLineItemShippingDiscount.appliedDiscount.excluded

type: bool

Indicates if a discount is not used for the product or product line item in an order. If true, the system ignores this discount when pricing the order.

appliedLineItemShippingDiscount.appliedDiscount.impact

type: decimal

The value of the discount applied to the cart or order, represented as a negative currency amount to apply to the original price.

appliedLineItemShippingDiscount.discountQuantity

type: int

The number of the line items that are used for this particular discount.

appliedLineItemShippingDiscount.impactPerUnit

type: decimal

The impact of a discount for each discount quantity.

appliedLineItemShippingDiscount.methodCode

type: string

Carrier-supplied, unique code that represents the shipping method service type associated with the shipping discount.

shippingTaxTotal

type: decimal

The total amount of tax incurred on the shipping charges in the cart and order. This property is not calculated at this time for wish lists.

shippingTotal

type: decimal

The calculated total shipping amount estimated for carts or orders, including tax. This amount is not calculated for wish lists at this time.

subtotal

type: decimal

Estimated amount of the cart or order without sales tax, shipping costs, and other fees. This amount is not calculated for wish lists at this time.

taxableTotal

type: decimal

The monetary amount of an item in the cart that is subject to tax. This amount typically represents the line item subtotal before applied discounts for an order.

taxData

type: Mozu.Core.Api.Contracts.Json

Leverage this property within a tax Arc.js action to supplement the tax information for this item or object with custom JSON data.

total

type: decimal

Total is used to indicate the monetary, estimated total amount of the cart or order, including items, sales tax, shipping costs, and other fees. Totals are not estimated for wish lists at this time.

totalWithoutWeightedShippingAndHandling

type: decimal

The total charge for the line item without any weighted order level shipping and handling charges.

totalWithWeightedShippingAndHandling

type: decimal

The total charge for the line item with all weighted order level shipping and handling charges.

unitPrice

type: commerceUnitPrice

Properties of the price per unit of a product, associated with cart and order items. This price is not used for wish lists at this time.

commerceUnitPrice.extendedAmount

type: decimal

Represents the total price of the line item extended to the shopper. This begins with the Unit Price, then uses any of the following prices if they are defined, in the following order: Override Amount, Sale Amount, List Amount.

commerceUnitPrice.listAmount

type: decimal

The price the item is listed for in the storefront.

commerceUnitPrice.overrideAmount

type: decimal

The override price of the item set by the merchant for a given order.

commerceUnitPrice.saleAmount

type: decimal

The sale price set for the item.

weightedOrderAdjustment

type: decimal

The total weighted order level manual adjustment amount.

weightedOrderDiscount

type: decimal

The total weighted order level discount amount.

weightedOrderDuty

type: decimal

The total weighted order level duty charges.

weightedOrderHandlingAdjustment

type: decimal

The weighted order handling adjustment.

weightedOrderHandlingFee

type: decimal

The total weighted order level handling fee amount.

weightedOrderHandlingFeeDiscount

type: decimal

The total weighted order handling fee discount amount.

weightedOrderHandlingFeeTax

type: decimal

The total weighted order level handling fee tax amount.

weightedOrderShipping

type: decimal

The total weighted order level shipping charge.

weightedOrderShippingDiscount

type: decimal

The total weighted order level shipping discount amount.

weightedOrderShippingManualAdjustment

type: decimal

The total weighted order level shipping manual adjustment amount.

weightedOrderShippingTax

type: decimal

The total weighted order level shipping tax amount.

weightedOrderTax

type: decimal

The total weighted order level tax amount.

Operations

Operation Name Request URI Description
CreateOrderItem POST %7borderId%7d%2fitems%3fupdatemode%3d%7bupdateMode%7d%26version%3d%7bversion%7d%26skipInventoryCheck%3d%7bskipInventoryCheck%7d%26responseFields%3d%7bresponseFields%7d

Adds a new item to a defined order.

DeleteOrderItem DELETE %7borderId%7d%2fitems%2f%7borderItemId%7d%3fupdatemode%3d%7bupdateMode%7d%26version%3d%7bversion%7d

Removes a previously added item from a defined order.

GetOrderItem GET %7borderId%7d%2fitems%2f%7borderItemId%7d%3fdraft%3d%7bdraft%7d%26responseFields%3d%7bresponseFields%7d

Retrieves the details of a single order item.

GetOrderItems GET %7borderId%7d%2fitems%3fdraft%3d%7bdraft%7d%26responseFields%3d%7bresponseFields%7d

Retrieves the details of all items in an order.

GetOrderItemViaLineId GET %7borderId%7d%2fitems%2f%7blineId%7d%3fdraft%3d%7bdraft%7d%26responseFields%3d%7bresponseFields%7d

Retrieves an order item with the order line ID.

UpdateItemDuty PUT %7borderId%7d%2fitems%2f%7borderItemId%7d%2fdutyAmount%2f%7bdutyAmount%7d%3fupdatemode%3d%7bupdateMode%7d%26version%3d%7bversion%7d%26responseFields%3d%7bresponseFields%7d

Update the duty fee information for an order item.

UpdateItemFulfillment PUT %7borderId%7d%2fitems%2f%7borderItemId%7d%2ffulfillment%3fupdatemode%3d%7bupdateMode%7d%26version%3d%7bversion%7d%26responseFields%3d%7bresponseFields%7d

Updates the item fulfillment information for the order specified in the request.

UpdateItemProductPrice PUT %7borderId%7d%2fitems%2f%7borderItemId%7d%2fprice%2f%7bprice%7d%3fupdatemode%3d%7bupdateMode%7d%26version%3d%7bversion%7d%26responseFields%3d%7bresponseFields%7d

Override the price of an individual product on a line item in the specified order.

UpdateItemQuantity PUT %7borderId%7d%2fitems%2f%7borderItemId%7d%2fquantity%2f%7bquantity%7d%3fupdatemode%3d%7bupdateMode%7d%26version%3d%7bversion%7d%26responseFields%3d%7bresponseFields%7d

Update the quantity of an item in an order.

UpdateOrderItemDiscount PUT %7borderId%7d%2fitems%2f%7borderItemId%7d%2fdiscounts%2f%7bdiscountId%7d%3fupdatemode%3d%7bupdateMode%7d%26version%3d%7bversion%7d%26responseFields%3d%7bresponseFields%7d

Update the discount applied to an item in an order.