Cart Types

The attributes’s key.

The attribute’s value.

The code to add.

The updated cart related to the add code submission

The code which was sent.

The response of the request.

Any additional messages from the server, typically an error message.

Any adjustments to cart as the result of applied offers.

The add item request that failed

The type of failure that this request encountered.

If type is 'VALIDATION', this object represents the invalid cart item that was built based on the provided addItemRequest.

Set of ids representing the Item Lists that are to be added to cart.

The id of the variant for this add item request. Used to retrieve variant information for the cart item.

The id of the product for this add item request. Used to retrieve product information for the cart item.

The SKU code for the item (e.g., Product or Variant).

The amount of this item to be added to the cart.

Miscellaneous attributes that should be copied to the cart item’s attributes for this request.

Attribute choices that should be copied to cart item’s attribute choices for this request.

Attributes that should be copied to the cart’s attributes for this request.

A list of additional AddItemRequests that should be processed as dependent items of the resulting parent item of this current AddItemRequest.

If this AddItemRequest is one within dependentCartItems, this is the key to use to relate to this cart item to a configured product item choice.

Miscellaneous attributes that can be set to this request in cart to inform business logic for adding a cart item.

How to determine the pricing of this chosen item relative to its parent product - i.e. included or an additional cost.

The price of this choice, only relevant when the pricing model of this choice is ADD_TO_PARENT.

System-wide unique identifier to configure specific pricing for the choice.

The type of the item to which this pricing belongs, for example SKU or PRICING_KEY.

The first name of the individual at this address.

The last name of the individual at this address.

The combined names of the individual at this address. It is considered better UX to use a full name field in place of separate first and last name fields.

The email address of the individual at this physical address.

The name of the company at this address.

Primary address information, typically street name and building number.

Secondary address information, like apartment, suite, or unit number.

Tertiary address information, typically for international addresses.

The city, town or village of this address.

The county of this address.

The state, province or region of this address.

The country for this address.

Postal code or ZIP code for this address.

The primary phone number for this address.

The secondary phone number for this address.

The fax number for this address.

Whether this address is the default address of the owner.

Whether this address is an active address of the owner.

Any additional custom attributes included on this customer address.

List of global configuration errors for the CartItem

The key would be the attribute’s name like COLOR.

The key would be the item’s identifier like a choiceKey.

A reference to the offer that originated this adjustment.

The amount of this adjustment.

The code used (if any) that triggered the application of the offer for this adjustment.

The label shown to customers for the option.

What the customer sees for display.

The value based on what the user selected.

The most up-to-date cart that includes all requests that were successfully processed

All failures that occurred during the add process.

A text identifier used to track a specific campaign.

The user provided text code that refers to the campaign.

The unique id for this cart.

A unique name for the cart, used for retrieval. This field is not displayed anywhere.

The status of this cart.

A reference to the customer that owns this cart.

The customer’s email address.

The unique number associated with this Cart.

The date that the originating cart was first created.

The date that this cart was submitted.

The locale for this cart.

All the pricing information on this cart.

Items that are contained within this cart. Typically represents a good or service that the customer is purchasing.

A list of fulfillment information for this cart. A cart can have many fulfillment groups associated with it in cart to support multi-address and multi-type shipping.

Adjustments to cart pricing that were applied to the subtotal.

A list of offer codes that were added to this cart. Used to apply Adjustments to different aspects of the cart.

A list of campaign references that are attached to this cart.

The list of payments associated with this cart.

The list of payments associated with this cart.

Miscellaneous attributes for this cart.

Miscellaneous internal attributes for this cart.

Attribute choices for this cart driven by its items' product options, where each key is the attributeName from an attribute choice.

Whether this cart has been fully priced.

Whether the taxes on the cart are estimates.

The version of this cart. Used for checking that the requested version of the cart is up-to-date before saving changes.

The list of the alerts for this cart. NOTE: This is a transient property that is not persisted in the database.

The currency unit used for the pricing of this Cart.

Whether or not the cart is for an anonymous user.

The number of items in this cart.

The type of the alert.

The message for this alert.

Contains the additional information about this alert.

A comment a user wishes to include with this action.

A map of additional fields suitable for adding any data not currently represented.

The most up-to-date cart.

Miscellaneous attributes that can be set to this response in order to provide more information on validation failures.

The current cart version.

Optional guest checkout token.

The initial AddItemRequest to populate the cart.

The initial PriceCartRequest to price the cart.

The unique id for this cart item.

The name of this item. Typically derived from the product or sku name.

The navigable uri of the corresponding catalog entry (e.g. product) for this cart item.

The number of this item in the Cart.

CartItems that depend on this CartItem. Also could be called "child items".

If this CartItem is a dependent cart item, this contains additional details about the dependent CartItem’s dependency on its parent.

Whether the price of this CartItem was specifically overridden, whether from a CSR or an automatic process.

The id of the price list used to get the pricing for this CartItem.

The individual unit price for an CartItem.

The type of the unit price for an CartItem. Typically "salePrice", "standardPrice", or "basePrice".

The total adjustment price for all adjustments of an CartItem.

The subtotal price of this CartItem.

The total price of this CartItem.

Adjustments to item pricing that should be applied to the subtotal

The id to the corresponding variant for this item.

The id to the corresponding product for this item.

The ids to the corresponding categories for this item’s product. Used for validating item choice configuration and offers.

Represents a SKU code, similar to productId or variantId, except this is a unified, unique concept across both products and variants.

The image asset for this item, usually sourced from the product.

Whether this item can be applied to any offers or promotions.

A reference to the corresponding vendor for this item.

The merchandising context for this cart item.

Miscellaneous attributes for this item.

Miscellaneous internal attributes for this item.

Attribute choices for this item driven by product options, where each key is the attributeName from an attribute choice.

Flag to indicate whether this item has been priced.

List of global configuration errors.

Map of configuration errors for related to this item’s attribute choices that are derived from ProductOptions where the key is the attribute name.

Map of configuration errors for related to this item’s dependent cart items where the key is the item’s identifier such as ProductOption choiceKey.

List of details about any price overrides which have been performed on this item.

Whether this item is taxable.

The Cart’s version. Used for version checking when the cart is not part of the request.

A reference to the corresponding catalog for this item.

Computed unit price with dependent items included.

Computed subtotal with dependent items included.

Computed adjustments total with dependent items included.

Computed total with dependent items included.

For dependent cart items, this strategy is used to indicate how the price should be incorporated into the overall cart subtotal - i.e. whether this cart item’s price should be added to the subtotal (the ADD_TO_PARENT strategy) or if the parent cart item’s price already includes this item’s price (the INCLUDED_IN_PARENT strategy). By default, the ADD_TO_PARENT strategy is used.

>Note: Regardless of this strategy, if the dependent cart item has a related FulfillmentItem, then there will likely be a tax amount related to the item that be included in the cart’s overall price.

System-wide unique identifier to configure specific pricing for the choice.

The list of simple labels used to categorize the corresponding product for this item.

The id to the corresponding data driven enum for this item’s product’s brand. Used for validating offers.

The id to the corresponding data driven enum for this item’s product’s merchandising type. Used for validating offers.

The id to the corresponding data driven enum for this item’s product’s target demographic. Used for validating offers.

The type of this cart item.

see DefaultCartItemType

The currency unit used for the pricing of this Cart.

The total tax amount for this Cart.

The total fulfillment price of this Cart, including adjustments.

The subtotal price of this Cart.

The total adjustment price for all adjustments of an Cart and its cart items.

The total price of this Cart.

The total fees of this Cart. This is the sum of all subtotals for cart items with type {@link DefaultCartItemType.EXTRA_FEE}

The current cart version.

Optional guest checkout token.

A unique id used to represent the request. This value can be used to link various persisted entities/values to the originating request.

The cart related to the checkout submission.

Whether the checkout submission was successful.

Whether or not the cart was submitted for checkout but awaiting payment result.

The type of checkout failure which can be used programmatically by the client application to react to the failure.

Message intended to inform why the checkout submission failed if success is false.

Line item error messages used to describe issues with individual fields, cart items, etc. For example, this may consist of map entries where the key is a cart item id (or name) & the value is an explanation of why the item is misconfigured.

A collection of payment summaries related to the cart.

A collection of payment transaction failure details describing how the transaction(s) failed.

The id representing the customer’s request to checkout

The error code for this configuration error. Intended to be used with auditing or mapping to a human readable explanation.

The error message for this configuration error. Intended to be shown to the customer as a human readable explanation.

Email addresses that should be used as a point of contact for the cart.

Describes the owner of the payment. For example, the payment could have originated with a cart or a subscription, therefore this value might be BLC_CART or BLC_SUBSCRIPTION.

The id of the entity that owns this payment. For example, this may be a cart id, or a subscription billing cycle id.

Describes the type of the owning user of the payment. For example, the payment could belong to a Broadleaf customer or an account, therefore this value might be BLC_CUSTOMER, or BLC_ACCOUNT.

Describes the name of the owning user of the payment.

Describes the email address of the owning user of the payment.

The unique currency code, the effective code depends on the currency.

The numeric currency code. within the ISO-4217 name space.

The ID of the customer that owns this cart.

The customer’s username.

The customer’s fullname.

Whether this customer is registerd.

The id of the account this customer belongs to.

The id of the root account the account member belongs to.

A normal cart item with typical behavior.

Represents a fee applied to the cart such as for Collect on Delivery or other payment options. These are not to be included in the cart subtotal or quantity.

Represents a fee applied to the cart for Collect on Delivery. These are not to be included in the cart subtotal or quantity.

The Cart is in process and can be modified.

Used to represent a cart that requires approval. This is typically used for B2B account carts.

Used to represent a cart that has been rejected. This is typically used for B2B account carts.

Used to represent a cart that has been locked while its transactions requiring reversal are being processed. Setting this status is primarily meant to ensure that no other threads are able to simultaneously modify the cart.

Used to represent a cart that has been submitted by the customer & the processing of that submission is in progress. While in this status, the cart should be locked from modification by any customer requests.

Used to represent a cart that has been submitted by the customer & the processing of that submission has been successfully completed. This means that the cart can no longer be modified and is locked in. This also means that the cart should have its Cart#getOrderNumber set.

The cart has been cancelled either by the customer, a CSR, or an automated process.

Represents a cart which is being managed by a CSR for the customer. A cart in this status is not visible to the customer. This cart was either created by a CSR or cloned from an existing customer’s cart, and can be transferred back as the customer’s IN_PROCESS cart.

Represents an anonymous cart which is primed to be transferred to a user. This cart has no other uses prior to being transferred.

Represents a cart which is being managed by an admin in preview mode. This cart cannot be submitted during checkout.

Since 1.5.3

Since 1.5.3

Represents a Broadleaf-managed cart.

Represents a Broadleaf-managed subscription.

Represents a Broadleaf-managed customer.

Represents a Broadleaf-managed account.

The price of the dependent cart item will be added to the parent item’s price.

The price of the dependent cart item is considered to be already included in the parent item’s price.

The set of item list IDs that were deleted.

From the list of provided IDs, this represents the set of item list IDs that the user does not have permission to delete.

The key to use to relate to this cart item to a configured product item choice.

Dictates how the dependent item should be priced.

Pricing overrides if specific variants of the main product this item belongs to are added to the cart.

The reference number of the FulfillmentGroup this fulfillment was created from.

The type of means by which this fulfillment is fulfilled. This could be SHIP, PICKUP, or VIRTUAL, for example.

see DefaultFulfillmentType

The fulfillment option chosen for the type

This is an optional field where the ID or reference number of the expected InventoryLocation is stored.

The shipping address for this fulfillment.

Where to find the address to be used for tax calculation on this fulfillment group.

The shipping price of this fulfillment group before adjustments are applied.

The total shipping price of this fulfillment group’s fulfillment items.

The amount of the total fulfillment price that can be taxed, including item shipping prices.

The total shipping price of this fulfillment group, including adjustments and item shipping prices. This does not include taxes on the fulfillment price. This does not include taxes.

Whether the total fulfillment price of this order fulfillment was specifically overridden, whether from a CSR or an automatic process.

The total tax of this fulfillment, including merchandise and fulfillment tax.

Adjustments to fulfillment pricing that should be applied to fulfillment charge.

Items within this fulfillment, each of which should relate back to a OrderItem.

Flag to indicate whether this group has been priced.

List of details about any price overrides which have been performed on this fulfillment.

The fulfillment option chosen for the type.

Additional attributes for this order fulfillment.

The reference number for this fulfillment item.

The id of the OrderItem to be represented by this fulfillment item.

The quantity of the item to be fulfilled by this fulfillment.

The unit price of the related cart item multiplied by quantity.

The amount prorated to this item from order adjustments.

The amount that can be taxed based on the cart item price and usually less any prorated order-adjustments.

The total tax of the item merchandise based on the price of the related cart item.

The fulfillment price of this cart item before adjustments are applied.

The total of all the item fulfillment adjustments for this item.

The total fulfillment price of this item, including adjustments. This does not include taxes.

Adjustments to item fulfillment pricing that should be applied to the total of unitFulfillmentCharge.

Whether or not this product is available online - ie inventory is available somewhere to fulfill this product

The inventory check strategy of the item. This value helps to determine when an inventory check is required.

The reservation strategy of the item. This value helps to determine when an inventory reservation is required.

The tax details for this fulfillment item.

The fulfillment option chosen for the type.

Additional attributes for this fulfillment item.

The amount of taxes calculated.

The amount that was taxable to determine the calculated tax.

The tax rate

The jurisdiction type, e.g. city, state, county, etc.

The tax jurisdiction name. This may be a state, city, county, etc. For example, "California", "New York City", etc.

The 2 digit country code.

The region that this tax was calculated.

The tax name for this tax detail. Describes the tax (e.g. TX STATE TAX)

The transaction ID for this tax detail.

The name of the fulfilment option.

A description for the fulfillment option.

Whether the fulfillment option uses flat rates.

The tax code for the fulfillment option.

Whether this fulfillment option is taxable.

User-defined service level. This will typically include values like "SAME_DAY", "FIRST_CLASS", "OVERNIGHT", "STANDARD", etc. for {@link DefaultFulfillmentType.SHIP}; or "IN_STORE" or "CURBSIDE" for DefaultFulfillmentType.PICKUP This will depend on how clients (tenants or applications) define their available Fulfillment Option Service levels.

If AbstractFulfillmentOption.inventoryType is NONE then this must return NONE as well.

Broad categorization of how this fulfillment option is fulfilled. For instance, SHIP, PICKUP, or VIRTUAL.

Human-readable description (e.g. First Class, USPS First Class, or Pickup at Store #53).

The list of calculatorIds which were used to compute the price for this option.

This is either the ID of the Fulfillment Group or Fulfillment Item, depending on the value of PricedFulfillmentOption.pricingStrategy.

The minimum number of days estimated for delivery. Null value is possible and means that the estimated days to deliver is unknown.

The maximum number of days expected for delivery. Null value is possible meaning no max days to fulfill has been configured.

This will be the price of using this Fulfillment Option. This may be ZERO.

Indicate if this fulfillment price is taxable.

A tax code for this fulfillment option.

Map to hold arbitrary additional attributes.

Id of the config.

string

string

The updated address.

The updated cart.

The updated fulfillment options.

Map of options by the fulfillment group reference number.

Map of options by the fulfillment item reference number

Indicates that fulfillment pricing should be applied to the Fulfillment Group, rather than each individual item.

Indicates that fulfillment pricing should be applied to the Fulfillment Item, rather than the containing Fulfillment Group. This is the default.

Street address line 1. This is often not required for calculating fulfillment charges, but is included for completeness and in case this detail is required in some cases.

Street address line 2. This is often not required for calculating fulfillment charges, but is included for completeness and in case this detail is required in some cases.

Street address line 3. This is often not required for calculating fulfillment charges, but is included for completeness and in case this detail is required in some cases.

The name of a city in which this address or partial address is located.

State, Province, or Region in which this address or partial address is located.

Country code. This should not be null. We should know in which country, at least, this address (or partial address) is located.

Postal code (or ZIP code in the US) in which this address or partial address is located.

Indicates if this address or partial address is a Post Office (PO) Box. Some shipping providers cannot ship to a PO Box.

Latitude for GPS coordinates. Typically, latitude and longitude can be used to determine an exact location, and can be used instead of other properties like region, city, and postal code. These are usually determined by a geolocation service and are required for distance or radius searches, for example.

Longitude for GPS coordinates. Typically, latitude and longitude can be used to determine an exact location, and can be used instead of other properties like region, city, and postal code. These are usually determined by a geolocation service and are required for distance or radius searches, for example.

The description of the fulfillment option.

The name of the fulfillment option.

A tax code for the option.

Whether the fulfillment option is taxable

Whether this option uses flat rates.

The total fulfillment price calculated.

The estimated delivery date.

The pricing infos for each of the line items, keyed by item id.

The id of the line item for this fulfillment pricing info.

The sku code for the item.

Whether the calculated price is an estimate.

The fulfillment price calculated for a unit of the item.

The combined total for all units.

The id of the cart associated with this guest checkout token.

The actual guest checkout token.

When the token expires.

The cart associated with this guest token.

The actual guest checkout token.

Whether the token is valid.

The guest checkout token.

The fully-resolvable content-URL to the binary data of the asset.

Text that corresponds to the HTML alt attribute that should be used when this asset is rendered in a browser.

Text that corresponds to the HTML title attribute that should be used when this asset is rendered in a browser.

The ID of this Item List Item.

The name of this item list.

The collection of catalog items.

Miscellaneous attributes for this item list.

The cart related to the add to cart submission

From the list of ids that the user attempted to add to cart, this represents the set of item list ids that the user does not have access to

Map of item list ids to a collection of item list item ids that could not be added to cart

The ID of this Item List Item.

The ID of the parent Item List.

A reference to the catalog item.

undefined

Miscellaneous attributes for this item list item.

Miscellaneous internal attributes for this item.

undefined

A list of Item List Items.

A list of Item Lists.

The SKU being referred.

The ID of the product being referred.

The ID of the variantId being referred.

The monetary amount.

The currency.

The page number.

The size of the page.

The field and sort direction.

The id of the offer.

The name of the offer.

A description of what benefits the offer provides to a customer.

A label for this offer typically used by the storefront.

The user ID of the admin user who performed the override.

The admin user who performed the override.

The type of override performed, e.g. a Cart Item Price override or a Fulfillment Group Price override.

The amount contained in the field prior to being overridden.

The amount which the field has been overridden to.

The reason the override was performed, for example, "Price Match".

The optional, long-form comment explaining any extra context for the override.

The new price value.

The reason the override was performed.

Optional, long-form comment explaining any extra context for the override.

Whether this page is the first page.

Whether this page is the last page.

The number of elements currently on this page.

The implementation of Pageable that should be used to fetch pages of non-narrowed entities with a standard paging strategy.

The sorting parameters for this page.

Object to return

The number of the page when fetching results.

The size of the page.

Is this paged

Is this unpaged

The id of this payment.

The name of this payment. This name is typically something like "Visa ending in 1234".

The id of the customer’s saved payment account that was used to build this payment object.

Deprecated: in favor of #savedPaymentMethodId for more accurate naming.

The id of the owning user’s saved payment method that was used to build this payment object.

Whether or not the underlying payment method can only be used once.

In most cases, we’re managing a single-use token that represents a credit card. This flag is especially important for managing payments with successful transactions. In those cases, the token has already been used and cannot be reused. If we need modify the payment’s amount, then we may actually need to archive the existing payment, and create a new payment, with a new underlying token.

Additionally, this flag is helpful when needing to re-authorize an expired authorization transaction. In that case, if the payment represents a single-use payment method, then the re-authorization may not be possible, and you’ll need to seek an alternative form of payment.

Should the payment method be saved to the customer.

Deprecated: In favor of #shouldSavePaymentForFutureUse to support owning user types other than a customer (i.e. account).

Should the payment method be saved to the owning user (i.e. customer or account).

The status of the payment. See DefaultCartStatus.

The type of this payment like Credit Card or Gift Card.

The gateway used to process this payment.

The amount for which this payment is allotted.

The payment’s total usually excluding adjustments, tax, and fulfillment.

The payment’s adjustments (a.k.a discounts) total, usually excluding fulfillment discounts.

The payment’s total shipping cost

The payment’s total tax cost

The billing address associated with this payment.

Map to capture any gateway-specific information needed to perform gateway transactions

General use map to capture any additional attributes needed for this Payment

General use map to capture any display properties for this Payment.

Transaction data representing each payment gateway interaction related to this payment.

Whether this payment has been archived.

The current payment version.

The type of this payment like Credit Card or Gift Card.

The gateway configured for this payment method.

The names of the allowed fulfillment options. <p> Will only be applied in the case of Collect on Delivery (COD) type payments by default. We will eventually extend out of box support to any payment options. </p>

The list of applicable fees for this payment option. Can be discountable and/or taxable. <p> Will only be applied in the case of Collect on Delivery (COD) type payments by default. We will eventually extend out of box support to any payment options. </p>

The maximum total a cart can have for this payment method, per currency. <p> Will only be applied in the case of Collect on Delivery (COD) type payments by default. We will eventually extend out of box support to any payment options. </p>

The minimum total a cart can have for this payment method, per currency. <p> Will only be applied in the case of Collect on Delivery (COD) type payments by default. We will eventually extend out of box support to any payment options. </p>

The name of this payment. This name is typically something like "Visa ending in 1234".

The id of the customer’s saved payment account that was used to build this payment object.

Note: This property is only relevant if the user desires to use a saved payment account to pay for their order. Otherwise, this value should remain unset.

Deprecated: in favor of #savedPaymentMethodId for more accurate naming.

The id of the owning user’s saved payment method that was used to build this payment object.

Note: This property is only relevant if the user desires to use a saved payment method to pay for their order. Otherwise, this value should remain unset.

Whether or not the underlying payment method can only be used once.

In most cases, we’re managing a single-use token that represents a credit card. This flag is especially important for managing payments with successful transactions. In those cases, the token has already been used and cannot be reused. If we need modify the payment’s amount, then we may actually need to archive the existing payment, and create a new payment, with a new underlying token.

Additionally, this flag is helpful when needing to re-authorize an expired authorization transaction. In that case, if the payment represents a single-use payment method, then the re-authorization may not be possible, and you’ll need to seek an alternative form of payment.

The type of this payment like Credit Card or Gift Card. Defaults to CREDIT_CARD.

see DefaultPaymentType

The gateway used to process this payment. Only a SINGLE payment gateway can modify transactions on a particular payment.

The amount for which the payment is allotted.

The payment’s total usually excluding adjustments, tax, and fulfillment.

The payment’s adjustments (a.k.a discounts) total, usually excluding fulfillment discounts.

The payment’s total fulfillment cost.

The payment’s total tax cost

The billing address associated with this payment.

Should the payment method be saved to the customer. Defaults to false.

Deprecated: In favor of #shouldSavePaymentForFutureUse to support owning user types other than a customer (i.e. account).

Should the payment method be saved to the owning user (i.e. customer or account).

Map to capture any gateway-specific information needed to perform gateway transactions

Map to capture any additional information about the payment

General use map to capture any display properties for this Payment.

The id of this payment.

The name of this payment. This name is typically something like "Visa ending in 1234".

The type of this payment like Credit Card or Gift Card.

The gateway used to process this payment. Only a SINGLE payment gateway can modify transactions on a particular payment.

General use map to capture any additional attributes needed for this Payment

General use map to capture any display properties for this Payment.

Whether or not the underlying payment method can only be used once.

In most cases, we’re managing a single-use token that represents a credit card. This flag is especially important for managing payments with successful transactions. In those cases, the token has already been used and cannot be reused. If we need modify the payment’s amount, then we may actually need to archive the existing payment, and create a new payment, with a new underlying token.

Additionally, this flag is helpful when needing to re-authorize an expired authorization transaction. In that case, if the payment represents a single-use payment method, then the re-authorization may not be possible, and you’ll need to seek an alternative form of payment.

The amount for which this payment is allotted.

The payment’s total usually excluding adjustments, tax, and fulfillment.

The payment’s adjustments (a.k.a discounts) total, usually excluding fulfillment discounts.

The payment’s total fulfillment cost

The payment’s total tax cost

The total authorized amount for capture. This value is calculated as "total authorized - total reverse-authed".

The total captured amount. This value is calculated as "total captured - total refunded - total voided".

The total refunded amount.

The total voided amount.

The total settled amount.

The total detached credit amount.

The version of this payment. Used for checking that the requested version of the payment is up-to-date before saving changes. Required for any request which results in an update being made to the payment. This should never be manually incremented/decremented.

Whether a portion of an authorization transaction can be reversed, or if the full authorization transaction must be reversed. Defaults to false

Whether the client is responsible for settling captured payments. If false, this implies that the gateway is responsible for managing payment settlement. Defaults to false.

A list of payments.

The id of this payment transaction.

The type of this transaction (authorize, capture, refund, etc.)

The status of the transaction

The transaction id known by the payment gateway.

The id used to represent the request that produced this transaction.

The amount related to this transaction.

The timestamp when this transaction response was recorded

The response code provided by the payment gateway which may represent a success or failure

The type of transaction failure

The type of transaction failure (hard vs soft failure)

The string representation of the serialized response from the gateway.

The id of the parent PaymentTransaction.

Map of specific attributes that have been gathered from the raw response.

The customer IP address that instigated this transaction

Tells if this transaction has an indeterminate result.

The id of the payment.

The type of transaction that was executed.

The id of the executed transaction.

The transaction id known by the payment gateway.

The management state of this transaction, after it’s been executed.

The status of the transaction.

The type of transaction failure

The type of transaction failure (hard vs soft failure)

The response code provided by the payment gateway which may represent a success or failure.

Message describing the result of the transaction

The gateway-provided url where the customer must verify that they are in fact the owner of the payment method. The customer is typically redirected to this location, but the page can also be rendered within an iframe if this is supported by the gateway.

Whether or not this transaction has an indeterminate result.

The transaction amount that was executed against the payment summary.

The id representing the customer’s request to execute the transaction.

The timestamp when this transaction response was recorded

Map of specific attributes that have been gathered from the raw response.

Note: It’s very important that this does not include sensitive payment method data.

The country calling code that acts as a prefix to the main telephone number.

The telephone number, including the area code.

The internal extension for this phone.

Whether the cart should be priced or not. Default is true.

Whether the cart should be priced or not. Default is true.

The locale to price the cart against.

The currency to price the cart against.

Whether to calculate actual taxes.

Deprecated: use the estimated flag. If false, it’s assumumed that we want actual calculations.

Hint as to whether to estimate taxes. This can be used to assist in determining a tax provider that might be more efficient or less expensive when an estimate is all that is required. Default is false.

The list of cart statuses used to resolve the authenticated customer’s cart.

The ID of the item list being shared. This will be populated from the request path.

Describes the expected format of the value property for each Target (e.g email address, customer ID, etc.).

The role that will be granted to each target.

Describes who this list is being shared with.

The property to order for.

The direction in which to sort. Can be ascending (ASC) or descending (DESC).

Whether or not the sorting will be case sensitive.

string A hint to the data store (may not be respected) regarding how to sort null values. Possible values

NATIVE (let the data store decide what to do) NULLS_FIRST NULLS_LAST

ID of the variant this pricing should be used with.

System-wide unique identifier to configure specific pricing for the choice. Relevant if pricing data is managed in a separate system or data store, like the Broadleaf pricing services.

The price to use for this item when the related variant is selected.

Current state of the cart.

Identifies who the item list is to be shared with. The format of this value is dictated by the valueType of this Target’s related ShareItemListRequest. An example may be an email address or a customer ID.

Additional attributes used to describe the target. This collection may include the target’s name or other information that may be useful when the user is notified that they have been granted access.

The token string that is used to authorize that a request has access to transfer the given cart.

The expiration time of the transfer cart token in UTC. This is used to inform clients of when to expect the token to be expired.

The username of the author associated with the transfer cart token.

The ID of the cart the token is authorized to transfer.

The type of means by which this fulfillment group is fulfilled. This could be SHIP, PICKUP, or VIRTUAL, for example.

The fulfillment option chosen for the type.

The fulfillment option chosen for the type.

The shipping address for this fulfillment group.

Map to capture any additional information about the fulfillment group.

The id of the cart item to update.

The id of the variant for this add item request. Used to retrieve variant information for the cart item.

The amount of this item to be added to the cart.

Miscellaneous attributes that should be copied to the cart item’s attributes for this request.

Attribute choices that should be copied to cart item’s attribute choices for this request.

Attributes that should be copied to the cart’s attributes for this request.

A list of additional UpdateItemRequests that should be processed as children items of the resulting parent item of this current request.

The id of the parent cart item for this add item request. This would create a child cart item of the parent.

The ID of the payment to update. Will be pre-populated in Cart Operations from the request.

The name of this payment. This name is typically something like "Visa ending in 1234".

The id of the customer’s saved payment account that was used to build this payment object.

Note: This property is only relevant if the user desires to use a saved payment account to pay for their order. Otherwise, this value should remain unset.

Deprecated: in favor of #savedPaymentMethodId for more accurate naming.

The id of the owning user’s saved payment method that was used to build this payment object.

Note: This property is only relevant if the user desires to use a saved payment method to pay for their order. Otherwise, this value should remain unset.

Whether or not the underlying payment method can only be used once.

In most cases, we’re managing a single-use token that represents a credit card. This flag is especially important for managing payments with successful transactions. In those cases, the token has already been used and cannot be reused. If we need modify the payment’s amount, then we may actually need to archive the existing payment, and create a new payment, with a new underlying token.

Additionally, this flag is helpful when needing to re-authorize an expired authorization transaction. In that case, if the payment represents a single-use payment method, then the re-authorization may not be possible, and you’ll need to seek an alternative form of payment.

Should the payment method be saved to the customer. Defaults to false.

Deprecated: In favor of #shouldSavePaymentForFutureUse to support owning user types other than a customer (i.e. account).

Should the payment method be saved to the owning user (i.e. customer or account).

The type of this payment like Credit Card or Gift Card. Defaults to CREDIT_CARD.

see DefaultPaymentType

The gateway used to process this payment. Only a SINGLE payment gateway can modify transactions on a particular payment.

The amount for which the payment is allotted.

The payment’s total usually excluding adjustments, tax, and shipping.

The payment’s adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.

The payment’s total fulfillment cost.

The payment’s total tax cost.

The billing address associated with this payment.

Describes the type of the owning user of the payment. For example, the payment could belong to a Broadleaf customer or an account, therefore this value might be BLC_CUSTOMER, or BLC_ACCOUNT.

Map to capture any gateway-specific information needed to perform gateway transactions

Map to capture any additional information about the payment.

General use map to capture any display properties for this Payment.