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.

Any vouchers added 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.

Deprecated: undefined

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.

A reference to the OfferCode (if any).

The amount of this adjustment.

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

If this adjustment is not created by an offer this parameter will specify the source of adjustment.

A list of OfferItemDetails representing the qualifier items where this adjustment was from.

The quantity per offer usage of the target item that this adjustment is for.

The quantity of the current line item that this offer was applied to.

The number of times that the offer this adjustment was created from is applied.

The campaign tracking id (if any) for this adjustment.

The serviceLevel that this adjustment applies to (typically used only with fulfillment group offers to indicate that the discount applies to the portion of the fulfillment price related to a specific service level. For example, for a group containing some items shipped by STANDARD and some as EXPRESS it is possible the discount only applies to the EXPRESS items. A blank value would indicate the discount applies to all service levels.

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 type of cart.

The status of this cart.

A reference to the customer that owns this cart.

The cart approver’s email address.

This field is only needed for B2B carts to represent the cart approver’s email address.

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.

Any vouchers added to cart as the result of applied offers.

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.

Deprecated: These are no longer stored on the cart.

The list of payments associated with this cart.

Deprecated: These are no longer stored on the 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.

The checkout submissions made for this cart where each key is the request ID of a checkout and the value is a timestamp of when the checkout was made.

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 last time the cart was fully repriced with the most updated catalog pricing.

The expiration date of the cart. This is typically only used for QUOTE carts.

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 id of the sales rep assignment assinged to the cart.

The email of the sales rep assignment assinged to the cart.

The context ID of the cart action audit.

The ID of the cart this cart action audit was created after.

The action type of this audit.

The old {@link Cart.status} prior the cart action in which this audit was created for.

The new {@link Cart.status} after the cart action in which this audit was created for.

For example, this field would be {@link DefaultCartStatus.REJECTED} if the {@link Cart} was rejected.

The type of user who performed the cart action.

For example, this could be an account approver.

The id of the user who performed the cart action.

For example, this would be the id of the account approver who rejected the cart.

The email of the user who performed the cart action.

For example, this would be the email of the account approver who rejected the cart.

A comment related to the audit

The time at which the {@link CartActionAudit} was created

Additional or custom audit information

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 type of the cart to create.

The name of the cart. Typically blank except for quotes

The expiration date if a quote. Often left blank.

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

Prorated adjustments for this item from order-level offers.

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 context ID of the note.

The id of the Cart that this note belongs to.

The id of the CartItem that this note belongs to, this field is only relevant for CartItem-level notes.

The content of the note

A list of notes representing the replies.

When this note was created.

The type of the user that created this note.

The id of the user that created this note.

The email of the user that created this note.

Whether this note is for internal view only. Internal notes are only visible to sellers.

Map to hold additional data.

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 [DefaultCartItemType] EXTRA_FEE.

Indicates if any taxes are included in the subtotal.

The amount of taxes that are included in the subtotal (VAT).

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 PaymentNextActions describing the required next steps for the payment.

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

The hierarchy of accounts, from the root account to the account member’s account.

The tax address should be populated from FulfillmentGroup #address.

The tax address should be populated from the billing address of the payment with the maximum amount in the active payment.

This value indicates that the adjustment was added by the price proration of the bundle price to its items.

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.

Represents a quote item that is a custom item specified by the customer.

This is used for supporting [DefaultCartTypes] QUOTE for buyers to specify any custom items, e.g. training hours, additional service, or items that they couldn’t find the matching catalog items for.

Represents a customer.

Represents a sales representative.

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.

Indicates that the Cart payment is sent to the payment gateway but awaiting transaction result. Note that if one of the transactions is awaiting result in a multiple-payment scenario, the cart would still have this status.

Indicates that the Cart had a pending payment but is now failed. <p> This can happen when the transaction result is pending during the checkout flow, but later failed from receiving the latest transaction result.

Indicates that the Cart is actively being used by the scheduled job to check its payment results and update the Cart accordingly.

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.

Collect on Delivery is selected for this fulfillment group

Collect on Delivery is not selected for this fulfillment group

This goes with [InventoryType] NONE and indicates that no fulfillment method is required.

Indicates that an item will be shipped, often to a customer’s home. This is applicable to [InventoryType] PHYSICAL items.

This (a.k.a. SDD) is essentially the same as SHIP (with a SAME_DAY_DELIVERY service level). This simply allows "SAME_DAY_DELIVERY" to be its own, special Fulfillment Method.

Indicates that an item will be picked up by the customer, often at a store or pickup location. This is applicable to [InventoryType] PHYSICAL items. This is often known as Buy-Online- Pickup-In-Store (or BOPIS).

This should also be able to handle Delayed BOPIS, as the only things that may change are the fulfillment dates and maybe the price.

Indicates that an item will be fulfilled virtually (e.g. via digital download, print, etc.) This is applicable to [InventoryType] VIRTUAL items.

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.

Used to represent the action of a Cart from [DefaultCartTypes] STANDARD to [DefaultCartTypes] QUOTE.

Used to represent the action of requesting the quote to the seller.

Used to represent the action of canceling a quote.

Used to represent the action of assigning a sales rep to work on the quote.

Used to represent the action of publishing the quote back to the buyer.

Used to represent the action of rejecting the quote.

Used to represent the action of purchasing the quote.

Used to represent the action of revising prices in the quote.

Used to represent the action of modifying an item in the quote.

Used to represent the action of adding an item to the quote.

Used to represent the action of removing an item from the quote.

Used to represent an unknown action.

Represents an item.

This is typically used for buyers to request an item in the quote by only specifying an item number, etc.

Represents a service, e.g. training hours, additional service, etc.

Indicates that the quote is being drafted and have not been submitted to the sellers.

It’s typically used for carts that have just been converted into a quote.

Indicates that the quote has been requested to the seller.

Indicates that the quote is assigned to a sales rep.

Indicates that the quote has been responded back to the requester with the quoted prices.

Indicates that the quote is being edited by the buyer after the seller’s response.

Indicates that the quote is expired.

Indicates that the quote has been purchased.

Indicates that the quote is rejected.

Indicates that the quote is canceled.

Represents a customer user who is an account member.

Represents a customer user who has permission to approve account carts.

Represents a customer.

Represents a sales representative.

Typically used for users who can manage and respond to quotes.

Represents the system.

Typically used for system originated changes such as a scheduled job to mark quotes as expired.

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.

In the case of a SpecificItemChoice, this will be populated with the override price of the parent ItemChoice.

In the case of a SpecificItemChoice, this will be populated with the pricing key of the parent ItemChoice.

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.

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

Use pricedFulfillmentOption if using Fulfillment Services rather than Shipping Services.

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.

Sum of the group’s adjustments.

Prorated amount of the fulfillment adjustments that applies to the #groupFulfillmentPriceBeforeAdjustments. Fulfillment-level adjustments are prorated between the charges of the group and those of the individual 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.

Use this instead of fulfillmentOption if using Fulfillment Services instead of Shipping Services.

Additional attributes for this order fulfillment.

A map of total prices for all PricedFulfillmentOption #serviceLevel for FulfillmentItems in this group. This will aggregate the fulfillment prices for all items that have the same service level.

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 amount prorated to this item from group adjustments.

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.

Whether or not any offers or promotions can be applied to the cart item.

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.

Whether this is a VAT tax.

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.

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.

Map of options by the fulfillment group reference number

Map of options by the fulfillment item reference number

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.

ID associated with this. May be a DB ID, or another arbitrary ID.

Strategy that defines how a particular context expects Fulfillment Groups to be priced. This indicates if the PricedFulfillmentOption is on the FulfillmentGroup or FulfillmentItem.

The default service level to use if an item or group has not set the level.

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.

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.

Inventory should never be checked.

Inventory should be checked when the item is added to the cart.

Inventory should never be reserved.

Inventory should be reserved when the item is added to the cart.

Inventory should be reserved when the order is submitted for checkout.

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 unit proration amount.

The total quantity.

The SKU being referred.

The ID of the product being referred.

The ID of the variantId being referred.

The gateway-provided url that can redirect to the next action the customer must take. This URL can be used for redirecting to hosted payments page, displaying a 3D Secure form, etc. 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.

The type of action that must be taken.

Map holding any additional attributes not matching any defined properties.

The page number.

The size of the page.

The field and sort direction.

The offer id where this item is a qualifier or target of.

The id of the item that is a qualifier or target.

The quantity per offer usage of the item that is a qualifier or target.

The quantity of the qualifier or target item that this offer was applied to.

The number of times the offer is applied.

Indicates if this detail is for a fulfillment item.

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 id of the payment.

The next step required for the payment gateway to continue processing this payment.

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

The full name of the owner of this payment. For example, the customer’s full name.

The email address of the owner of this payment.

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 shipping address associated with this payment.

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.