commerce/carts/messages

Use the Cart Messages resource to retrieve messages for live carts that the system logs when a product's price or inventory level changes.

JSON Example

ChangeMessage Properties

Property Description
amount

type: decimal

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

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.

appKey

type: string

The application's key.

appName

type: string

The application's name.

correlationId

type: string

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

createDate

type: DateTime

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

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

identifier

type: string

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

message

type: string

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

metadata

type: object

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

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.

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.

subject

type: string

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

subjectType

type: string

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

success

type: bool

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

userFirstName

type: string

The user's first name.

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.

userLastName

type: string

The user's last name.

userScopeType

type: string

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

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.

Operations

Operation Name Request URI Description
GetMessages GET current%2fmessages%3fresponseFields%3d%7bresponseFields%7d

Retrieves the messages associated with the current shopper's cart.

RemoveAllMessages DELETE current%2fmessages

Deletes all messages associated with the cart of the current shopper.

RemoveMessage DELETE current%2fmessages%2f%7bmessageId%7d

Removes a single message associated with the cart of the current shopper.