commerce/quotes

Quotes support the eCommerce B2B feature by providing functionality similar to that of standard wishlists. However, comments can be added to quotes to provide clearer information to other users accessing the quote through the shared B2B account. These basic APIs provide the ability to create new quotes, update them, and retrieve their information.

These APIs are currently a work-in-progress and will be enhanced in the future as more functionality such as setting fixed prices, setting expiration, etc. is released. The current models may change and break backwards compatibility, so use caution if interacting with these APIs for now.

JSON Example

Quote Properties

Property	Description
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.
channelCode	type: string Code that identifies the channel associated with the site for the shopper's created shopping cart, order, and return.
comments	type: list of string Notes entered and saved with an order. These notes may be entered by a shopper on a wishlist or for an order. Comments may also be entered by Kibo eCommerce Admins on an order that may be visible only to authorized shoppers and users.
currencyCode	type: string The localized currency code for the monetary amount.
customerAccountId	type: int Unique identifer of the customer account. This ID is used to associate numerous types of data and object with the customer account, including orders, returns, wish lists, and in-store credit.
customerInteractionType	type: string The type of customer interaction used to create this shopping cart. Possible values are Website, Call, Store, or Unknown.
customerTaxId	type: string The tax identification number (TIN) of the customer who submitted the order. If the customer who submitted the order has a customer account defined for the tenant, the system sets this value when the order is submitted.
data	type: Mozu.Core.Api.Contracts.Json Additional data provided with the other properties.
destinations	type: list of destination The addresses that the purchaser intends to send these quote items to.
destination.data	type: Mozu.Core.Api.Contracts.Json A data bag that merchants can use for storing custom data. This one is tied to the associated destination.
destination.destinationContact	type: contact The contact associated with the destination.
destination.contact.address	type: address Address information to supply for a contact.
destination.contact.address.address1	type: string Physical or mailing address line one. Usually includes the street number and street name or it could be a P.O. Box. Max length: 200.
destination.contact.address.address2	type: string Physical or mailing address line two. Usually supplements the main street address with apartment, floor, suite, building, or unit information. Max length: 200.
destination.contact.address.address3	type: string Physical or mailing address line three. Max length: 200.
destination.contact.address.address4	type: string Physical or mailing address line four. Max length: 200.
destination.contact.address.addressType	type: string The type of address, which is commercial or residential.
destination.contact.address.cityOrTown	type: string The entered city or town for the address.
destination.contact.address.countryCode	type: string The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US.
destination.contact.address.isValidated	type: bool Indicates if the address has been validated. If true, the address has been verified by an address validation service.
destination.contact.address.postalOrZipCode	type: string The entered zip or postal code for an address.
destination.contact.address.stateOrProvince	type: string The entered state or province for an address.
destination.contact.companyOrOrganization	type: string The company or organization name entered for a customer account.
destination.contact.email	type: string The email address for the customer account and contact. This email may be used for login to the storefront, receiving in-stock product notifications, and subscription mailing lists.
destination.contact.firstName	type: string The full first name of a customer or contact name.
destination.contact.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
destination.contact.lastNameOrSurname	type: string The full last name or surname of a customer or contact name.
destination.contact.middleNameOrInitial	type: string Character string of the middle name or initial for the customer.
destination.contact.phoneNumbers	type: phone List of phone numbers associated with the customer account contact. The phone numbers include area codes.
destination.contact.phone.home	type: string Home phone number.
destination.contact.phone.mobile	type: string Mobile phone number.
destination.contact.phone.work	type: string Work phone number.
destination.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
destination.isDestinationCommercial	type: bool True if the destination is a commercial address.
dutyAmount	type: decimal The amount added to the order item for duty fees.
dutyTotal	type: decimal Duties or tariffs for the Order as well as OrderItems (e.g. if the Order has a $5 duty or tariff for any reason and an OrderItem has a $2 duty or tariff then the value in this property would be $7)
email	type: string The email address for the customer account and contact. This email may be used for login to the storefront, receiving in-stock product notifications, and subscription mailing lists.
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.
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.
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.
handlingDiscounts	type: list of appliedDiscount The handling discounts applied to the order's handling fee.
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.
appliedDiscount.discount	type: discount Name of the discount added and applied to a shopping cart and order for a shopper's purchase.
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.
appliedDiscount.discount.hasMultipleTargetProducts	type: bool Indicates whether the discount includes multiple products to be targeted. The target products are what the discount will be applied to, such as a bonus free item.
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
appliedDiscount.discount.itemIds	type: list of string List of cart or order items to which the discount applies, if applicable.
appliedDiscount.discount.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
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.
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.
handlingSubTotal	type: decimal Handling fees for the Order as well as OrderItems (e.g. if the Order has a $5 handling fee and an OrderItem has a $2 handling fee per item quantity then the value in this property would be $9)
handlingTax	type: decimal Calculated total tax amount for handling costs if the cart/order is subject to sales tax.
handlingTaxTotal	type: decimal Calculated total tax amount for handling costs if the cart/order is subject to sales tax.
handlingTotal	type: decimal The total fee for shipment handling.
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
ipAddress	type: string A captured and stored IP address. IP addresses are stored for the origin location of submitted orders and the tenant domain.
isTaxExempt	type: bool If true, the order is exempt from applied sales tax.
itemLevelHandlingDiscountTotal	type: decimal The handling discount total for the grouping item.
itemLevelProductDiscountTotal	type: decimal The applicable product discount for the order item.
itemLevelShippingDiscountTotal	type: decimal The applicable shipping discount for the grouping item.
items	type: list of orderItem A list of requested items. All returned data is provided in an items array. For a failed request, the returned response may be success with an empty item array.
orderItem.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.
orderItem.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.
orderItem.auditInfo.createBy	type: string Identifier of the user that created the object. System created and read only.
orderItem.auditInfo.createDate	type: DateTime The date and time in UTC format set when the object was created.
orderItem.auditInfo.updateBy	type: string Identifier of the user that updated the entity most recently.
orderItem.auditInfo.updateDate	type: DateTime The date and time in UTC format the object was updated most recently.
orderItem.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.
orderItem.data	type: Mozu.Core.Api.Contracts.Json Custom data for a given vendor set within the commerce process.
orderItem.destinationId	type: string The destination the order item will ship to.
orderItem.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.
orderItem.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.
orderItem.dutyAmount	type: decimal Duty or Tariff for this item
orderItem.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.
orderItem.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.
orderItem.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).
orderItem.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.
orderItem.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.
orderItem.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
orderItem.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.
orderItem.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.
orderItem.itemTaxTotal	type: decimal The total amount of calculated tax for items, used by carts, orders, and wish lists.
orderItem.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.
orderItem.localeCode	type: string The two character locale code, per the country code provided. This code determines the localized content to use and display.
orderItem.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.
orderItem.product	type: product The properties of a product, referenced and used by carts, orders, wish lists, and returns.
orderItem.product.allocationExpiration	type: DateTime Allocation ID associated with this product on this order.
orderItem.product.allocationId	type: int Allocation ID associated with this product on this order.
orderItem.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.
orderItem.product.bundledProduct.allocationExpiration	type: DateTime Allocation ID associated with this product on this order.
orderItem.product.bundledProduct.allocationId	type: int Allocation ID associated with this product on this order.
orderItem.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.
orderItem.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.
orderItem.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.
orderItem.product.bundledProduct.fulfillmentStatus	type: string Fulfillment status of the product.
orderItem.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.
orderItem.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.
orderItem.product.bundledProduct.measurements	type: packageMeasurements Dimensional properties (height, length, and width) of packages, products and bundles.
orderItem.product.bundledProduct.packageMeasurements.height	type: measurement Height of the package in imperial units of feet and inches.
orderItem.product.bundledProduct.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
orderItem.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.
orderItem.product.bundledProduct.packageMeasurements.length	type: measurement Length of the package in imperial units of feet and inches.
orderItem.product.bundledProduct.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
orderItem.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.
orderItem.product.bundledProduct.packageMeasurements.weight	type: measurement Weight of the package in imperial units of pounds and ounces.
orderItem.product.bundledProduct.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
orderItem.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.
orderItem.product.bundledProduct.packageMeasurements.width	type: measurement Width of the package in imperial units of feet and inches.
orderItem.product.bundledProduct.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
orderItem.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.
orderItem.product.bundledProduct.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
orderItem.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.
orderItem.product.bundledProduct.optionValue	type: object The value of the option attribute. These values are associated and used by product bundles and options.
orderItem.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.
orderItem.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.
orderItem.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.
orderItem.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.
orderItem.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
orderItem.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.
orderItem.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.
orderItem.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.
orderItem.product.discountsRestrictedEndDate	type: DateTime The date and time on which the discount restriction period ends.
orderItem.product.discountsRestrictedStartDate	type: DateTime The date and time on which the discount restriction period starts.
orderItem.product.fulfillmentStatus	type: string Fulfillment status of the product.
orderItem.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.
orderItem.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.
orderItem.product.imageAlternateText	type: string The alternate image description defined for the product, in the language specified in the locale code for the storefront.
orderItem.product.imageUrl	type: string The URL link for the image file associated with a product or category.
orderItem.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.
orderItem.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.
orderItem.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.
orderItem.product.measurements	type: packageMeasurements Dimensional properties (height, length, and width) of packages, products and bundles.
orderItem.product.packageMeasurements.height	type: measurement Height of the package in imperial units of feet and inches.
orderItem.product.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
orderItem.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.
orderItem.product.packageMeasurements.length	type: measurement Length of the package in imperial units of feet and inches.
orderItem.product.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
orderItem.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.
orderItem.product.packageMeasurements.weight	type: measurement Weight of the package in imperial units of pounds and ounces.
orderItem.product.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
orderItem.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.
orderItem.product.packageMeasurements.width	type: measurement Width of the package in imperial units of feet and inches.
orderItem.product.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
orderItem.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.
orderItem.product.mfgPartNumber	type: string The manufacturer's part number for the product.
orderItem.product.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
orderItem.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.
orderItem.product.productOption.attributeFQN	type: string The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name.
orderItem.product.productOption.dataType	type: string The data type of the source product property, typically of type Bool, DateTime, Number, or String.
orderItem.product.productOption.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
orderItem.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.
orderItem.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.
orderItem.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.
orderItem.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.
orderItem.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.
orderItem.product.productPrice.msrp	type: decimal The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier.
orderItem.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.
orderItem.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.
orderItem.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.
orderItem.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.
orderItem.product.productPrice.tenantOverridePrice	type: decimal The override price defined by the tenant for this cart or order item.
orderItem.product.productCode	type: string The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.
orderItem.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.
orderItem.product.productType	type: string A product type is like a product template.
orderItem.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).
orderItem.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.
orderItem.product.productProperty.attributeFQN	type: string The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name.
orderItem.product.productProperty.dataType	type: string The data type of the source product property, typically of type Bool, DateTime, Number, or String.
orderItem.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.
orderItem.product.productProperty.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
orderItem.product.productProperty.values	type: list of productPropertyValue List of value data for objects.
orderItem.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.
orderItem.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.
orderItem.product.upc	type: string The universal product code (UPC) is the barcode defined for the product. The UPC is unique across all sales channels.
orderItem.product.variationProductCode	type: string Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code.
orderItem.productDiscount	type: appliedLineItemProductDiscount The applicable product discount for an associated cart, order, or wish list.
orderItem.appliedLineItemProductDiscount.appliesToSalePrice	type: bool Determines if the discount applies to the sale price of the order.
orderItem.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.
orderItem.appliedLineItemProductDiscount.discount	type: discount Name of the discount added and applied to a shopping cart and order for a shopper's purchase.
orderItem.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.
orderItem.appliedLineItemProductDiscount.discount.hasMultipleTargetProducts	type: bool Indicates whether the discount includes multiple products to be targeted. The target products are what the discount will be applied to, such as a bonus free item.
orderItem.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
orderItem.appliedLineItemProductDiscount.discount.itemIds	type: list of string List of cart or order items to which the discount applies, if applicable.
orderItem.appliedLineItemProductDiscount.discount.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
orderItem.appliedLineItemProductDiscount.discountQuantity	type: int The number of the line items that are used for this particular discount.
orderItem.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.
orderItem.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.
orderItem.appliedLineItemProductDiscount.impactPerUnit	type: decimal The impact of a discount for each discount quantity.
orderItem.appliedLineItemProductDiscount.productQuantity	type: int Quantity of products priced. This is always one unless calculating pricing on the order or cart.
orderItem.productDiscounts	type: list of appliedLineItemProductDiscount List of product-level discounts projected to apply to a cart, order, or wish list.
orderItem.appliedLineItemProductDiscount.appliesToSalePrice	type: bool Determines if the discount applies to the sale price of the order.
orderItem.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.
orderItem.appliedLineItemProductDiscount.discount	type: discount Name of the discount added and applied to a shopping cart and order for a shopper's purchase.
orderItem.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.
orderItem.appliedLineItemProductDiscount.discount.hasMultipleTargetProducts	type: bool Indicates whether the discount includes multiple products to be targeted. The target products are what the discount will be applied to, such as a bonus free item.
orderItem.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
orderItem.appliedLineItemProductDiscount.discount.itemIds	type: list of string List of cart or order items to which the discount applies, if applicable.
orderItem.appliedLineItemProductDiscount.discount.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
orderItem.appliedLineItemProductDiscount.discountQuantity	type: int The number of the line items that are used for this particular discount.
orderItem.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.
orderItem.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.
orderItem.appliedLineItemProductDiscount.impactPerUnit	type: decimal The impact of a discount for each discount quantity.
orderItem.appliedLineItemProductDiscount.productQuantity	type: int Quantity of products priced. This is always one unless calculating pricing on the order or cart.
orderItem.purchaseLocation	type: string The location where the item was purchased.
orderItem.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.
orderItem.shippingAmountBeforeDiscountsAndAdjustments	type: decimal The total shipping amount for the line item before discounts and adjustments.
orderItem.shippingDiscounts	type: list of appliedLineItemShippingDiscount List of shipping discounts projected to apply to carts, orders, and wish lists and items at checkout.
orderItem.appliedLineItemShippingDiscount.discount	type: appliedDiscount Name of the discount added and applied to a shopping cart and order for a shopper's purchase.
orderItem.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.
orderItem.appliedLineItemShippingDiscount.appliedDiscount.discount	type: discount Name of the discount added and applied to a shopping cart and order for a shopper's purchase.
orderItem.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.
orderItem.appliedLineItemShippingDiscount.appliedDiscount.discount.hasMultipleTargetProducts	type: bool Indicates whether the discount includes multiple products to be targeted. The target products are what the discount will be applied to, such as a bonus free item.
orderItem.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
orderItem.appliedLineItemShippingDiscount.appliedDiscount.discount.itemIds	type: list of string List of cart or order items to which the discount applies, if applicable.
orderItem.appliedLineItemShippingDiscount.appliedDiscount.discount.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
orderItem.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.
orderItem.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.
orderItem.appliedLineItemShippingDiscount.discountQuantity	type: int The number of the line items that are used for this particular discount.
orderItem.appliedLineItemShippingDiscount.impactPerUnit	type: decimal The impact of a discount for each discount quantity.
orderItem.appliedLineItemShippingDiscount.methodCode	type: string Carrier-supplied, unique code that represents the shipping method service type associated with the shipping discount.
orderItem.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.
orderItem.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.
orderItem.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.
orderItem.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.
orderItem.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.
orderItem.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.
orderItem.totalWithoutWeightedShippingAndHandling	type: decimal The total charge for the line item without any weighted order level shipping and handling charges.
orderItem.totalWithWeightedShippingAndHandling	type: decimal The total charge for the line item with all weighted order level shipping and handling charges.
orderItem.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.
orderItem.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.
orderItem.commerceUnitPrice.listAmount	type: decimal The price the item is listed for in the storefront.
orderItem.commerceUnitPrice.overrideAmount	type: decimal The override price of the item set by the merchant for a given order.
orderItem.commerceUnitPrice.saleAmount	type: decimal The sale price set for the item.
orderItem.weightedOrderAdjustment	type: decimal The total weighted order level manual adjustment amount.
orderItem.weightedOrderDiscount	type: decimal The total weighted order level discount amount.
orderItem.weightedOrderDuty	type: decimal The total weighted order level duty charges.
orderItem.weightedOrderHandlingAdjustment	type: decimal The weighted order handling adjustment.
orderItem.weightedOrderHandlingFee	type: decimal The total weighted order level handling fee amount.
orderItem.weightedOrderHandlingFeeDiscount	type: decimal The total weighted order handling fee discount amount.
orderItem.weightedOrderHandlingFeeTax	type: decimal The total weighted order level handling fee tax amount.
orderItem.weightedOrderShipping	type: decimal The total weighted order level shipping charge.
orderItem.weightedOrderShippingDiscount	type: decimal The total weighted order level shipping discount amount.
orderItem.weightedOrderShippingManualAdjustment	type: decimal The total weighted order level shipping manual adjustment amount.
orderItem.weightedOrderShippingTax	type: decimal The total weighted order level shipping tax amount.
orderItem.weightedOrderTax	type: decimal The total weighted order level tax amount.
itemTaxTotal	type: decimal The total amount of calculated tax for items, used by carts, orders, and wish lists.
itemTotal	type: decimal The total cost for the item.
locationCode	type: string The unique, user-defined code that identifies a location. This location can be the location where the order was entered, location for newly in-stock products, and where products are returned.
name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
number	type: int The order item number.
orderDiscounts	type: list of appliedDiscount List of order-level discounts projected to apply to the cart at checkout or order.
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.
appliedDiscount.discount	type: discount Name of the discount added and applied to a shopping cart and order for a shopper's purchase.
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.
appliedDiscount.discount.hasMultipleTargetProducts	type: bool Indicates whether the discount includes multiple products to be targeted. The target products are what the discount will be applied to, such as a bonus free item.
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
appliedDiscount.discount.itemIds	type: list of string List of cart or order items to which the discount applies, if applicable.
appliedDiscount.discount.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
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.
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.
orderLevelHandlingDiscountTotal	type: decimal The handling discount total at the order level.
orderLevelProductDiscountTotal	type: decimal The applicable product discount for the order.
orderLevelShippingDiscountTotal	type: decimal The shipping level discount at the order level.
priceListCode	type: string If the order is associated with a price list, this is the unique code of the price list.
shippingAmount	type: decimal The calculated monetary amount of shipping for a line items within and an entire order.
shippingDiscounts	type: list of shippingDiscount List of shipping discounts projected to apply to carts, orders, and wish lists and items at checkout.
shippingDiscount.discount	type: appliedDiscount Name of the discount added and applied to a shopping cart and order for a shopper's purchase.
shippingDiscount.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.
shippingDiscount.appliedDiscount.discount	type: discount Name of the discount added and applied to a shopping cart and order for a shopper's purchase.
shippingDiscount.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.
shippingDiscount.appliedDiscount.discount.hasMultipleTargetProducts	type: bool Indicates whether the discount includes multiple products to be targeted. The target products are what the discount will be applied to, such as a bonus free item.
shippingDiscount.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
shippingDiscount.appliedDiscount.discount.itemIds	type: list of string List of cart or order items to which the discount applies, if applicable.
shippingDiscount.appliedDiscount.discount.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
shippingDiscount.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.
shippingDiscount.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.
shippingDiscount.methodCode	type: string Carrier-supplied, unique code that represents the shipping method service type associated with the shipping discount.
shippingMethodCode	type: string The code associated with a carrier's shipping method service type, used during fulfillment of packages and shipments. Service type codes include a prefix that indicates the carrier. For example: FEDEX_INTERNATIONAL_STANDARD and UPS_GROUND. If using a custom rate, this property corresponds to the Custom Code field in Admin when you navigate to System > Shipping > Carriers, and then click on an existing rate or on Create New Custom Rate.
shippingMethodName	type: string The carrier-supplied name for the shipping service type, such as "UPS Ground" or "2nd Day Air". If using a custom rate, this property corresponds to the Name field in Admin when you navigate to System > Shipping > Carriers, and then click on an existing rate or on Create New Custom Rate.
shippingSubTotal	type: decimal The shipping subtotal amount calculated without any applied discounts for line item and entire amounts of carts and orders. This property is not calculated for wish lists at this time.
shippingTax	type: decimal Amount of tax applied to shipping costs for line items in and entire orders.
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.
siteId	type: int Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site.
sourceDevice	type: string The device from which the order originated in the case of offline orders.
submittedDate	type: DateTime The date and time the order was submitted. System-supplied and read-only.
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.
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.
tenantId	type: int Unique identifier for the tenant.
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.
userId	type: string Unique identifier of the customer account (shopper or system user). System-supplied and read-only. If the shopper user is anonymous, the user ID represents a system-generated user ID string.
visitId	type: string Unique identifier of the customer visit in which the cart was created or last modified.
webSessionId	type: string Unique identifier of the web session in which the cart, order, return, or wish list was created or last modified.

Operations

Operation Name	Request URI	Description
CreateQuote	POST %3fresponseFields%3d%7bresponseFields%7d	Create a new quote.
DeleteQuote	DELETE %7bquoteId%7d	Delete a quote.
GetQuote	GET %7bquoteId%7d%3fresponseFields%3d%7bresponseFields%7d	Retrieve the information of an existing quote.
GetQuoteByName	GET customers%2f%7bcustomerAccountId%7d%2f%7bquoteName%7d%3fresponseFields%3d%7bresponseFields%7d	Retrieve the information of an existing quote based on the list's name.
GetQuotes	GET %3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26q%3d%7bq%7d%26qLimit%3d%7bqLimit%7d%26responseFields%3d%7bresponseFields%7d	Retrieve the information of multiple existing quotes.
UpdateQuote	PUT %7bquoteId%7d%3fresponseFields%3d%7bresponseFields%7d	Update an existing quote.