Customer Types

The context ID of the account.

The account’s parent account.

The status of this account. By default, the account is active.

The name of the account.

A business-driven unique identifier for the account.

A simple categorization that can be used to group accounts or enforce business logic.

The unique tax id for the account’s related organization.

Dynamic attributes that are a part of the account. This is an admin-entered field.

The unique id for this account address relationship.

The account-provided name of the address.

The type of address for this account.

Specifies whether or not this is the default for this type of address.

The account in the relationship.

Describes the type of this address' visibility to child accounts

The context ID of the invite.

The email address of the customer.

The main phone number of the customer.

The context ID of the account for the invite.

The ID of customer who performed the invite.

The date that this invitation expires.

The customer’s roles within the account. These map to role IDs in the auth service.

Additional attributes that are used to describe the account member

Information for the pending account invitation.

The email address of the customer to be invited.

The main phone number of the customer to be invited.

The customer’s roles within the account they are invited to. These map to role IDs in the auth service.

The context ID of the relationship.

The account in the relationship.

The customer in the relationship.

The email of the account member — used for invited members.

The customer’s roles within the account. These map to role IDs in the auth service.

Additional attributes that are used to describe the account member

Flag that indicates if the account member has been successfully added to the account (either by invite or admin) or has yet to accept the invite

The account’s id.

The account’s name.

The type of the additional phone. For example "FAX", "MOBILE", etc. or "OTHER"

The phone number.

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.

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.

A text identifier used to track a specific campaign.

The user provided text code that refers to the campaign.

The name of this saved payment method.

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

The id of the entity that owns this saved payment method. For example, this may be a customer id, or an account id.

Whether this saved payment is the default payment method for the owner entity.

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

The payment gateway associated with this saved payment method.

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

General use map to capture any additional attributes needed for this saved payment method.

General use map to capture any display properties for this saved payment method.

The billing address associated with this saved payment method.

Describes the type of this payment’s visibility to child accounts

The reference ID for this payment method known by payment gateway. It is used when we need to update the saved payment method from the webhook event. In this case we have to find the saved payment method by this reference ID.

For example, this can be the Stripe SetupIntent id.

The next action to execute to complete setup this payment method

The id of this credit account.

The type of this credit account.

Generated code that can be used to reference the credit account.

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

The reference to the user that owns this credit account. For example, this may be a customer id, an account id, or the anonymous user’s email address.

Describes an alternative owning user type of the credit account, that can be used instead of the owningUserType.

Describes an alternative owning user reference for the credit account, that can be used instead of the owningUserRef.

The current balance for this credit account.

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

The currency gathered from the balance.

A unique identifier associating a credit account object to a customer. By default, this equals to "owningUserRef".

Additional attributes that are used to describe the credit account.

The unique identifier for this customer.

The first name of the customer, if the fullName is not being used for the customer.

The middle name of the customer, if the fullName is not being used for the customer.

The last name of the customer, if the fullName is not being used for the customer.

The full name of the customer, if the component parts firstName, middleName, and lastName are not being used to comprise the full name.

The username of the customer, used to log in.

The email address of the customer.

The id that associates this user with an external system.

The main phone number of the customer.

Additional phone numbers associated with the customer.

The id of the default payment account.

Deprecated: In favor of using {@code SavedPaymentMethod} in PaymentTransactionServices to manage saved payment methods.

Dynamic attributes that are a part of the customer.

The type of the customer, if it’s in a special circumstance.

The unique id for this customer address relationship.

The customer-provided name of the address.

Specifies whether or not the address is the default shipping address for the customer.

Specifies whether or not the address is the default billing address for the customer.

The customer in the relationship.

The customer’s id.

The customer’s username.

The customer’s email address.

Indicates an account entity is not visible to children accounts. For example, the account address or saved payment method is only visible to its own account but not sub-accounts.

Indicates an account entity is visible to children accounts. For example, the account address or saved payment method is both visible to its own account and sub-accounts.

A normal order 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 Broadleaf-managed customer.

Represents a Broadleaf-managed account.

The name of this option.

The description of this option.

Whether to use flat rates for this option.

The tax code for this option.

Whether any shipping prices should be taxable for this option.

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 number of seconds from the epoch of 1970-01-01T00:00:00Z.

The number of nanoseconds, later along the time-line, from the seconds field. This is always positive, and never exceeds 999,999,999.

The id of the offer.

The name of the offer.

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

The unique id for this order.

The unique id of the original cart for this order.

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

The status of this order.

The ID of the customer that owns this order.

The name of the customer that owns this order.

The customer’s email address.

The unique number associated with this Order.

The date that the originating cart was first created.

The date that this order was submitted.

The locale for this order.

All the pricing information on this order.

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

Adjustments to order pricing that were applied to the subtotal.

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

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

The list of payments associated with this order.

The list of payments associated with this order.

Miscellaneous attributes for this order.

Miscellaneous internal attributes for this item.

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

The currency unit used for the pricing of this Order.

The owner of this order (i.e. customerId)

The unique identifier for this fulfillment.

Intended to hold any unique identifier for this fulfillment as assigned by an external system.

The number for this individual fulfillment, unique within the order.

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

A soft reference to the parent Order this fulfillment belongs to.

The status of this fulfillment.

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

The fulfillment option chosen for the type

The priced fulfillment option. This is a more complex domain than fulfillment option. Both may be undefined and instead the individual FulfillmentItems would define a PricedFulfillmentOption.

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

The shipping address for this fulfillment.

The primary shipment details for this fulfillment.

All additional shipment details for this fulfillment.

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

The merchandise total for all items in the fulfillment, including item adjustments and prorated order adjustments.

The shipping charge for this fulfillment before adjustments are applied.

The total shipping price of this fulfillment, including adjustments and item shipping prices

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

The grand total of this fulfillment, including merchandise costs, all shipping costs including items, and tax.

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

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

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

A reference to the corresponding vendor for this fulfillment.

The currency unit used for the pricing of this order fulfillment.

Whether this OrderFulfillment requires at least part of the payment to be collected on delivery.

Additional attributes for this order fulfillment.

The unique ID of this fulfillment item.

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 individual unit price for the merchandise. This is the same as OrderItem.unitPrice.

The unitMerchandisePrice multiplied by quantity.

The total of all the item adjustments for the merchandise. Does not include proratedOrderAdjustments.

The merchandise total for the item quantity, including merchandiseSubtotal and item merchandiseAdjustmentsTotal.

The amount prorated to this item from order adjustments.

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

The unit shipping charge of each 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.

The fulfillment option chosen for the type.

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 unique id for this tax detail.

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.

Additional attributes for this tax detail.

The currency for this tax detail.

The unique id for this order 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 order item.

The number of this item in the Order.

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

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

The individual unit price for an OrderItem.

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

The total adjustment price for all adjustments of an OrderItem.

The subtotal price of this OrderItem.

The total price of this OrderItem.

The id to the corresponding variant for this item.

The id to the corresponding product for this item.

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.

A reference to the corresponding catalog for this item.

OrderItems that depend on this OrderItem. Also could be called "child items".

Adjustments to item pricing that should be applied to the subtotal

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.

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

The type of this order item.

see DefaultOrderItemType

The currency unit used for the pricing of this Order.

The total tax amount for this Order.

The total fulfillment price of this Order, including adjustments.

The subtotal price of this Order.

he total adjustment price for all adjustments of an Order and its order items.

The total price of this Order.

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

The fulfillemnts associated with this order.

The return authorizations associated with this order.

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

The size of the page.

Any sorting params to apply to the response.

The direction to sort by.

Deprecated: This is not used. Direction should be part of the sort param, e.g., sort=name,asc.

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.

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 unique identifier for the payment account.

The customer associated with this payment account.

The user-friendly name provided for the payment account.

This represents the type of payment that is associated with this account.

The specific card type, i.e. Visa, Mastercard, Discover, etc.

Deprecated: This is no longer desired as a 1st class property. Instead, place it in the displayAttributes if desired.

The payment gateway associated with this payment account.

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

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

Partial information about the payment account, e.g. last four numbers of a credit card.

Deprecated: This is no longer desired as a 1st class property. Instead, place it in the displayAttributes if desired.

The name associated with this payment account.

Deprecated: This is no longer desired as a 1st class property. Instead, place it in the displayAttributes if desired.

The month the payment gateway account associated with this payment account will expire.

Deprecated: This is no longer desired as a 1st class property. Instead, place it in the displayAttributes if desired.

The year the payment gateway account associated with this payment account will expire.

Deprecated: This is no longer desired as a 1st class property. Instead, place it in the displayAttributes if desired.

The combined names of the individual at this billing address.

Primary address information associated with this payment account, typically street name and building number.

Secondary address information associated with this payment account, typically apartment, suite, or unit number.

Tertiary address information associated with this payment account, typically for international addresses.

The city, town or village of this billing address.

The county of this billing address.

The state, province or region of this address.

The country for this billing address.

Postal code or ZIP code for this billing address.

The primary phone number for this billing address.

The secondary phone number for this billing address.

The timestamp of the last transaction made by this payment account.

The result code returned from the gateway on the last transaction.

Whether the account is deactivated.

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

User-defined service level. This will typically include values like "SAME_DAY", "FIRST_CLASS", "OVERNIGHT", "STANDARD", etc. for [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.

The unique id of the return authorization.

The context ID of the order from which items are returned.

The status of the return.

Optional tracking number for the return shipment of items.

The estimated merchandise total which can be refunded.

The estimated fulfillment total which can be refunded.

The estimated tax total which can be refunded. This contains all taxes, including merchandise and fulfillment taxes.

The estimated grand total which can be refunded.

The estimated charge to the customer to ship back the items to return.

The merchandise total which has been refunded.

The fulfillment total which has been refunded.

The tax total which has been refunded. This contains all taxes, including merchandise and fulfillment taxes.

The estimated grand total which has been refunded.

The amount charged to the customer to ship back the items to return.

The items which are being returned.

The currency unit used for monetary amounts.

The id of this return authorization item.

The context ID of the OrderFulfillmentItem being returned.

The quantity of the item being returned.

The primary reason for the return.

The secondary reason for the return, providing more detail in addition to the primary return reason.

The condition of the item expected when returned.

The type of the return, indicating how it should be processed.

An optional note containing extra information about the item being returned.

The estimated merchandise total which can be refunded.

The estimated fulfillment total which can be refunded.

The estimated tax total which can be refunded. This contains all taxes, including merchandise and fulfillment taxes.

The estimated grand total which can be refunded.

The portions of this item which have been confirmed as returned.

The id of this return confirmation.

The status of the returned item.

The quantity of the item which was returned.

The actual condition of the returned item received.

An optional note containing extra information about the item being returned.

Whether the fulfillment charge should be refunded.

The merchandise total which can be refunded.

The fulfillment total which can be refunded.

The tax total which can be refunded. This contains all taxes, including merchandise and fulfillment taxes.

The grand total which can be refunded.

The overridden grand total to refund.

The action type.

The status of this action. Defaults to PENDING.

Any details for the current action status.

Any additional attributes for this action.

The current saved payment method version.

The id of this saved payment method.

The name of this saved payment method.

The status of this saved payment method.

Whether this saved payment is the default payment method for the owner entity.

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

The id of the entity that owns this saved payment method. For example, this may be a customer id, or an account id.

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

The payment gateway associated with this saved payment method.

General use map to capture any additional attributes needed for this saved payment method.

General use map to capture any display properties for this saved payment method.

The billing address associated with this saved payment method.

The timestamp of the last transaction made by this saved payment method.

The result code returned from the gateway on the last transaction.

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

Describes the type of this payment’s visibility to child accounts

The reference ID for this payment method known by payment gateway. It is used when we need to update the saved payment method from the webhook event. In this case we have to find the saved payment method by this reference ID.

For example, this can be the Stripe SetupIntent id.

The next action to execute to complete setup this payment method

The tracking number for this shipment.

The URL to the tracking page for this shipment.

The date the shipment was shipped.

The shipper responsible for the shipment, for example a carrier.

Whether it is sorted.

Whether it is NOT sorted.

Whether it is empty.

The customer’s roles within the account. These map to role IDs in the auth service.

Additional attributes that are used to describe the account member

The id of this saved payment method.

The name of this saved payment method.

Whether this saved payment method is the default payment method for the owner entity.

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

The payment gateway associated with this saved payment method.

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

General use map to capture any additional attributes needed for this saved payment method.

General use map to capture any display properties for this saved payment method.

The billing address associated with this saved payment method.

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

Describes the type of this payment’s visibility to child accounts

The next action to execute to complete setup this payment method

The id of the user permission.

The name of the user permission.

The context ID of the user role.

The name of the user role.

Set to true when the role is soft-deleted/unavailable for assignment.

Indicates when the role was last updated.

Permissions that this role has been assigned and has inherited from the parent role as indicated by the parentRoleId.

The id of the parent role for this role, if any.

Set to true if the role is for accounts only.

The name that is formatted for display purposes for this role.

The description of this role.