commerce/wishlists

Use the Wish Lists resource to manage the shopper wish lists of products associated with a customer account. Although customer accounts are managed at the tenant level, the system stores shopper wish lists at the site level. This enables the same customer to have wish lists for each of a merchant's sites. Use the Wish List Items resource to manage items in a wish list.

JSON Example

Wishlist 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.

changeMessages

type: list of changeMessage

Collection (list or paged) of change messages logged for each modification made by a shopper to their carts, wishlists, orders, package, payment, pickup, and returns. Change log messages are system-supplied based on shopper actions and read only.

changeMessage.amount

type: decimal

The amount of the order-level adjustment, which can be a positive or negative amount.

changeMessage.appId

type: string

Unique identifier of an app available in your Kibo eCommerce tenant or within Kibo eCommerce Dev Center. This ID is unique across all apps installed, initialized, and enabled in the Admin and those in development through the Dev Center Console.

changeMessage.appKey

type: string

The application's key.

changeMessage.appName

type: string

The application's name.

changeMessage.correlationId

type: string

The unique identifier of the API request associated with the event action, which might contain multiple actions.

changeMessage.createDate

type: DateTime

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

changeMessage.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

changeMessage.identifier

type: string

Identifier for the object associated with the change message, which can represent a cart, cart item, or an order.

changeMessage.message

type: string

The text of the change message, such as "This product is no longer available." System-supplied and read-only.

changeMessage.metadata

type: object

Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views.

changeMessage.newValue

type: string

The new value of the object affected by the change, such as the new price of the product. System-supplied and read-only.

changeMessage.oldValue

type: string

The prior value of the object affected by the change, such as the price of the product when it was added to the cart. System-supplied and read-only.

changeMessage.subject

type: string

The text that appears on the subject line of the message, such as "The product price has changed."

changeMessage.subjectType

type: string

Represents the type of object affected by the change, such as Cart Item or Product. System-supplied and read-only.

changeMessage.success

type: bool

If true, the change associated with the message executed successfully.

changeMessage.userFirstName

type: string

The user's first name.

changeMessage.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.

changeMessage.userLastName

type: string

The user's last name.

changeMessage.userScopeType

type: string

The user type (e.g. Shopper, Admin, etc.).

changeMessage.verb

type: string

The action associated with this message. For example, if the price of a product changes, the verb could be "Increased" or "Decreased". If the product is no longer available, the verb could be "Invalidated". System-supplied and read-only.

channelCode

type: string

Code that identifies the channel associated with the site for the shopper's created shopping cart, order, and return.

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.

data

type: Mozu.Core.Api.Contracts.Json

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

discountedSubtotal

type: decimal

The aggregate total for all items in the cart, including costs associated with shopper-defined options or extras and any applied discounts.

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.

discountThresholdMessages

type: list of thresholdMessage

A list of threshold messages to display on the Wishlist page.

thresholdMessage.discountId

type: int

The unique identifier of the discount.

thresholdMessage.message

type: string

The text of the change message, such as "This product is no longer available." System-supplied and read-only.

thresholdMessage.requiresCouponCode

type: bool

Boolean field indicating whether or not threshold message requires the customer entering a coupon code to display.

thresholdMessage.showInCart

type: bool

Boolean field indicating whether or not the threshold message should be displayed on the Cart page.

thresholdMessage.showOnCheckout

type: bool

Boolean field indicating whether or not the threshold message should display on the Checkout page

thresholdMessage.thresholdValue

type: decimal

Numerical value representing the Cart minimum total to be satisfied in order to display the threshold message.

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.

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.

extendedProperties

type: list of extendedProperty

Extra properties (key-value pairs) that extend the primary object. Think of this as a property bag of string keys and string values.

extendedProperty.key

type: string

Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage.

For search synonym definitions, refer to Synonym Expansion Types for more information about the key usage.

extendedProperty.value

type: string

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.

externalId

type: string

Unique identifier used by an external program to identify a Kibo eCommerce order, customer account, or wish list.

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.

fulfillmentInfo

type: fulfillmentInfo

Properties of the information required to fulfill the cart, order, or wish list. Shoppers can fulfill ordered items by using in-store pickup or direct shipping.

fulfillmentInfo.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.

fulfillmentInfo.auditInfo.createBy

type: string

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

fulfillmentInfo.auditInfo.createDate

type: DateTime

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

fulfillmentInfo.auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

fulfillmentInfo.auditInfo.updateDate

type: DateTime

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

fulfillmentInfo.data

type: Mozu.Core.Api.Contracts.Json

Custom data originated by the shipping service.

fulfillmentInfo.fulfillmentContact

type: contact

The contact information of the person receiving the shipment or performing the pickup.

fulfillmentInfo.contact.address

type: address

Address information to supply for a contact.

fulfillmentInfo.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.

fulfillmentInfo.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.

fulfillmentInfo.contact.address.address3

type: string

Physical or mailing address line three. Max length: 200.

fulfillmentInfo.contact.address.address4

type: string

Physical or mailing address line four. Max length: 200.

fulfillmentInfo.contact.address.addressType

type: string

The type of address, which is commercial or residential.

fulfillmentInfo.contact.address.cityOrTown

type: string

The entered city or town for the address.

fulfillmentInfo.contact.address.countryCode

type: string

The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US.

fulfillmentInfo.contact.address.isValidated

type: bool

Indicates if the address has been validated. If true, the address has been verified by an address validation service.

fulfillmentInfo.contact.address.postalOrZipCode

type: string

The entered zip or postal code for an address.

fulfillmentInfo.contact.address.stateOrProvince

type: string

The entered state or province for an address.

fulfillmentInfo.contact.companyOrOrganization

type: string

The entered company or organization name entered for a customer account.

fulfillmentInfo.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.

fulfillmentInfo.contact.firstName

type: string

The full first name of a customer or contact name.

fulfillmentInfo.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

fulfillmentInfo.contact.lastNameOrSurname

type: string

The full last name or surname of a customer or contact name.

fulfillmentInfo.contact.middleNameOrInitial

type: string

Character string of the middle name or initial for the customer.

fulfillmentInfo.contact.phoneNumbers

type: phone

List of phone numbers associated with the customer account contact. The phone numbers include area codes.

fulfillmentInfo.contact.phone.home

type: string

Home phone number.

fulfillmentInfo.contact.phone.mobile

type: string

Mobile phone number.

fulfillmentInfo.contact.phone.work

type: string

Work phone number.

fulfillmentInfo.isDestinationCommercial

type: bool

If true, the shipping destination for a shipment is a commercial address.

fulfillmentInfo.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.

fulfillmentInfo.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.

handlingTaxTotal

type: decimal

Calculated total tax amount for handling costs if the cart/order is subject to sales tax.

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

importDate

type: DateTime

The date and time an order or wish list is imported into Kibo eCommerce. This is not the date and time it was created in the external application.

isImport

type: bool

Indicates if this object/data was imported from an outside source such as a data import or synchronization via an app or service. If true, this data was originally imported into Kibo eCommerce and accessible through your store database. Examples of imported objects/data include orders and customer accounts.

items

type: list of wishlistItem

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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.auditInfo.createBy

type: string

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

wishlistItem.auditInfo.createDate

type: DateTime

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

wishlistItem.auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

wishlistItem.auditInfo.updateDate

type: DateTime

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

wishlistItem.autoAddDiscountId

type: int

wishlistItem.comments

type: 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.

wishlistItem.data

type: Mozu.Core.Api.Contracts.Json

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

wishlistItem.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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.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

wishlistItem.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.

wishlistItem.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.

wishlistItem.itemTaxTotal

type: decimal

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

wishlistItem.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.

wishlistItem.localeCode

type: string

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

wishlistItem.priorityType

type: string

User-defined string that indicates the priority of an item in a wish list. Possible values are Lowest, Low, Medium, High, and Highest.

wishlistItem.product

type: product

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

wishlistItem.product.allocationExpiration

type: DateTime

Allocation ID associated with this product on this order.

wishlistItem.product.allocationId

type: int

Allocation ID associated with this product on this order.

wishlistItem.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.

wishlistItem.product.bundledProduct.allocationExpiration

type: DateTime

Allocation ID associated with this product on this order.

wishlistItem.product.bundledProduct.allocationId

type: int

Allocation ID associated with this product on this order.

wishlistItem.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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.product.bundledProduct.fulfillmentStatus

type: string

Fulfillment status of the product.

wishlistItem.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.

wishlistItem.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.

wishlistItem.product.bundledProduct.measurements

type: packageMeasurements

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

wishlistItem.product.bundledProduct.packageMeasurements.height

type: measurement

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

wishlistItem.product.bundledProduct.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

wishlistItem.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.

wishlistItem.product.bundledProduct.packageMeasurements.length

type: measurement

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

wishlistItem.product.bundledProduct.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

wishlistItem.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.

wishlistItem.product.bundledProduct.packageMeasurements.weight

type: measurement

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

wishlistItem.product.bundledProduct.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

wishlistItem.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.

wishlistItem.product.bundledProduct.packageMeasurements.width

type: measurement

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

wishlistItem.product.bundledProduct.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

wishlistItem.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.

wishlistItem.product.bundledProduct.name

type: string

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

wishlistItem.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.

wishlistItem.product.bundledProduct.optionValue

type: object

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

wishlistItem.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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.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

wishlistItem.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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.product.discountsRestrictedEndDate

type: DateTime

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

wishlistItem.product.discountsRestrictedStartDate

type: DateTime

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

wishlistItem.product.fulfillmentStatus

type: string

Fulfillment status of the product.

wishlistItem.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.

wishlistItem.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.

wishlistItem.product.imageAlternateText

type: string

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

wishlistItem.product.imageUrl

type: string

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

wishlistItem.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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.product.measurements

type: packageMeasurements

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

wishlistItem.product.packageMeasurements.height

type: measurement

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

wishlistItem.product.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

wishlistItem.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.

wishlistItem.product.packageMeasurements.length

type: measurement

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

wishlistItem.product.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

wishlistItem.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.

wishlistItem.product.packageMeasurements.weight

type: measurement

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

wishlistItem.product.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

wishlistItem.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.

wishlistItem.product.packageMeasurements.width

type: measurement

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

wishlistItem.product.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

wishlistItem.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.

wishlistItem.product.mfgPartNumber

type: string

The manufacturer's part number for the product.

wishlistItem.product.name

type: string

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

wishlistItem.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.

wishlistItem.product.productOption.attributeFQN

type: string

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

wishlistItem.product.productOption.dataType

type: string

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

wishlistItem.product.productOption.name

type: string

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

wishlistItem.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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.product.productPrice.msrp

type: decimal

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

wishlistItem.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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.product.productPrice.tenantOverridePrice

type: decimal

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

wishlistItem.product.productCode

type: string

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

wishlistItem.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.

wishlistItem.product.productType

type: string

A product type is like a product template.

wishlistItem.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).

wishlistItem.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.

wishlistItem.product.productProperty.attributeFQN

type: string

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

wishlistItem.product.productProperty.dataType

type: string

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

wishlistItem.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.

wishlistItem.product.productProperty.name

type: string

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

wishlistItem.product.productProperty.values

type: list of productPropertyValue

List of value data for objects.

wishlistItem.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.

wishlistItem.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.

wishlistItem.product.upc

type: string

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

wishlistItem.product.variationProductCode

type: string

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

wishlistItem.productDiscount

type: appliedLineItemProductDiscount

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

wishlistItem.appliedLineItemProductDiscount.appliesToSalePrice

type: bool

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

wishlistItem.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.

wishlistItem.appliedLineItemProductDiscount.discount

type: discount

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

wishlistItem.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.

wishlistItem.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

wishlistItem.appliedLineItemProductDiscount.discount.itemIds

type: list of string

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

wishlistItem.appliedLineItemProductDiscount.discount.name

type: string

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

wishlistItem.appliedLineItemProductDiscount.discountQuantity

type: int

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

wishlistItem.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.

wishlistItem.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.

wishlistItem.appliedLineItemProductDiscount.impactPerUnit

type: decimal

The impact of a discount for each discount quantity.

wishlistItem.appliedLineItemProductDiscount.productQuantity

type: int

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

wishlistItem.productDiscounts

type: list of appliedLineItemProductDiscount

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

wishlistItem.appliedLineItemProductDiscount.appliesToSalePrice

type: bool

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

wishlistItem.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.

wishlistItem.appliedLineItemProductDiscount.discount

type: discount

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

wishlistItem.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.

wishlistItem.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

wishlistItem.appliedLineItemProductDiscount.discount.itemIds

type: list of string

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

wishlistItem.appliedLineItemProductDiscount.discount.name

type: string

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

wishlistItem.appliedLineItemProductDiscount.discountQuantity

type: int

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

wishlistItem.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.

wishlistItem.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.

wishlistItem.appliedLineItemProductDiscount.impactPerUnit

type: decimal

The impact of a discount for each discount quantity.

wishlistItem.appliedLineItemProductDiscount.productQuantity

type: int

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

wishlistItem.purchasableStatusType

type: string

The status of the item that indicates whether an item in a wish list can be purchased. Possible values are "Purchasable" which indicates the item can be purchased, "NotPurchasable" which indicates the item is out of stock or otherwise unavailable, or "Missing" which indicates the item has been deleted from the catalog since it was added to the wish list.

wishlistItem.purchaseLocation

type: string

The location where the order item(s) was purchased.

wishlistItem.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.

wishlistItem.shippingAmountBeforeDiscountsAndAdjustments

type: decimal

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

wishlistItem.shippingDiscounts

type: list of appliedLineItemShippingDiscount

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

wishlistItem.appliedLineItemShippingDiscount.discount

type: appliedDiscount

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

wishlistItem.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.

wishlistItem.appliedLineItemShippingDiscount.appliedDiscount.discount

type: discount

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

wishlistItem.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.

wishlistItem.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

wishlistItem.appliedLineItemShippingDiscount.appliedDiscount.discount.itemIds

type: list of string

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

wishlistItem.appliedLineItemShippingDiscount.appliedDiscount.discount.name

type: string

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

wishlistItem.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.

wishlistItem.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.

wishlistItem.appliedLineItemShippingDiscount.discountQuantity

type: int

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

wishlistItem.appliedLineItemShippingDiscount.impactPerUnit

type: decimal

The impact of a discount for each discount quantity.

wishlistItem.appliedLineItemShippingDiscount.methodCode

type: string

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

wishlistItem.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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.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.

wishlistItem.totalWithoutWeightedShippingAndHandling

type: decimal

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

wishlistItem.totalWithWeightedShippingAndHandling

type: decimal

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

wishlistItem.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.

wishlistItem.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.

wishlistItem.commerceUnitPrice.listAmount

type: decimal

The price the item is listed for in the storefront.

wishlistItem.commerceUnitPrice.overrideAmount

type: decimal

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

wishlistItem.commerceUnitPrice.saleAmount

type: decimal

The sale price set for the item.

wishlistItem.weightedOrderAdjustment

type: decimal

The total weighted order level manual adjustment amount.

wishlistItem.weightedOrderDiscount

type: decimal

The total weighted order level discount amount.

wishlistItem.weightedOrderDuty

type: decimal

The total weighted order level duty charges.

wishlistItem.weightedOrderHandlingAdjustment

type: decimal

The adjustment to apply to the order handling fee.

wishlistItem.weightedOrderHandlingFee

type: decimal

The total weighted order level handling fee amount.

wishlistItem.weightedOrderHandlingFeeDiscount

type: decimal

The total weighted order handling fee discount amount.

wishlistItem.weightedOrderHandlingFeeTax

type: decimal

The total weighted order level handling fee tax amount.

wishlistItem.weightedOrderShipping

type: decimal

The total weighted order level shipping charge.

wishlistItem.weightedOrderShippingDiscount

type: decimal

The total weighted order level shipping discount amount.

wishlistItem.weightedOrderShippingManualAdjustment

type: decimal

The total weighted order level shipping manual adjustment amount.

wishlistItem.weightedOrderShippingTax

type: decimal

The total weighted order level shipping tax amount.

wishlistItem.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.

lastValidationDate

type: DateTime

The date in UTC Date/Time when the items in the cart were last validated against the site's product catalog. System-supplied and read-only.

lineItemSubtotalWithOrderAdjustments

type: decimal

The total charge for the line item with all weighted order level manual adjustments.

name

type: string

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

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.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.

privacyType

type: string

The type of privacy to apply to this wish list. Possible values are "Private" which makes the wish list viewable only to the shopper, "DirectShare" which makes the wish list viewable only to people with whom the shopper shares the wish list link, or "Public" which makes the wish list available to everyone. At this time, the system treats all shopper wish lists as "Public" regardless of the defined privacy type.

shippingAmountBeforeDiscountsAndAdjustments

type: decimal

The total shipping amount for the wishlist before discounts and adjustments.

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.

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.

sortOrder

type: int

The integer that represents the sequential order of this wish list in the customer's collection of wish lists.

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.

suggestedDiscounts

type: list of suggestedDiscount

Refers to the BOGA discounts that are currently satisfied but whose free item has not yet been added.

suggestedDiscount.autoAdd

type: bool

Indicates whether the free BOGA item should automatically be added to cart. If the free item has been added before and the shopper removed the free item (rejected it), the value will be false.

suggestedDiscount.discountId

type: int

The unique identifier of the discount.

suggestedDiscount.productCode

type: string

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

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.

taxTotal

type: decimal

The total monetary sum of sales tax estimated for a cart or order.

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.

typeTag

type: string

User-defined string that defines the type of wish list to define, such as wish list, baby registry, or Christmas list.

version

type: string

The current version number of the order, wish list, document list, or document type list.

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
CreateWishlist POST %3fresponseFields%3d%7bresponseFields%7d

Creates a new shopper wish list for the associated customer account. Although customer accounts are maintained at the tenant level, the system stores wish lists at the site level. Newly created wish lists do not have any items.

DeleteWishlist DELETE %7bwishlistId%7d

Deletes the shopper wish list specified in the request and all items associated with it.

GetWishlist GET %7bwishlistId%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of the shopper wish list specified in the request.

GetWishlistByName GET customers%2f%7bcustomerAccountId%7d%2f%7bwishlistName%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of a wish list by supplying the wish list name.

GetWishlists 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

Retrieves a list of shopper wish lists according to any filter and sort criteria.

UpdateWishlist PUT %7bwishlistId%7d%3fresponseFields%3d%7bresponseFields%7d

Updates one or more properties of a shopper wish list defined for a customer account.