Order and Cart Capture Fields

Order and cart capture fields used when implementing cart and order capture with JavaScript code.

Overview

Build your JavaScript cart and order capture code using these fields. Field names are case sensitive.
Note:
  • If you want to capture the contact email address, and you do not use a contact capture selector, then do not remove emailAddress. Only remove emailAddress if you do not plan to capture the contact email address.
  • If you want to capture line items, then quantity and totalPrice are required.
  • For order capture only, grandTotal is required.

Parameters

Name Type Comments
customerCartId string The Bronto ID for the cart. This value will be auto-generated if not set.
  • 255 characters maximum
phase string The current stage of checkout. The default phase is SHOPPING. For order capture, the cart phase must be set to ORDER_COMPLETE to convert a cart to an order. Valid values are:
  • SHOPPING: default if no phase is set.
  • BILLING: optional phase to track customer progress.
  • PAYMENT: optional phase to track customer progress.
  • SHIPPING_INFO: optional phase to track customer progress.
  • SHIPPING_METHOD: optional phase to track customer progress.
  • ORDER_REVIEW: optional phase to track customer progress.
  • ORDER_COMPLETE: final cart stage that will convert a cart to an order.
currency string The currency code for the order. You can only have one currency code per order.
  • ISO 4217 currency format (Example: USD)
subtotal number The subtotal from your commerce system before shipping, tax, and/or discount amounts are applied.
  • No more than 6 decimal places, maximum value is 999,999,999.999999
  • All currency amounts are numbers with a period as a decimal separator. The total 1234.56 is valid and 1.234,56 is not valid.
discountAmount number The discount amount associated with your order from your commerce system.
  • No more than 6 decimal places, maximum value is 999,999,999.999999
  • All currency amounts are numbers with a period as a decimal separator. The total 1234.56 is valid and 1.234,56 is not valid.
taxAmount number The tax amount associated with your order from your commerce system.
  • No more than 6 decimal places, maximum value is 999,999,999.999999
  • All currency amounts are numbers with a period as a decimal separator. The total 1234.56 is valid and 1.234,56 is not valid.
grandTotal
Note: This is a required field for order capture.
number The grand total from your commerce system, after shipping, tax, and discount amounts are applied.
  • No more than 6 decimal places, maximum value is 999,999,999.999999
  • All currency amounts are numbers with a period as a decimal separator. The total 1234.56 is valid and 1.234,56 is not valid.
customerOrderId string The order ID from your commerce system. This is not necessary for cart capture.
  • 255 characters maximum
emailAddress
Note: This is a required field for order and cart capture. If you are using contact capture selector(s) for cart capture, you do not need to send emailAddress with your cart data.
email The email address of the customer placing the order. emailAddress should only be mapped when it contains a value. Do not include emailAddress when the field is blank/null.
  • Validly formatted email address
cartUrl string The URL of the shopping cart.
  • 4,096 characters maximum
shippingAmount number The shipping amount associated with your order from your commerce system. This is not necessary for cart capture.
  • No more than 6 decimal places, maximum value is 999,999,999.999999
shippingDate date The date the order did or will ship. This is not necessary for cart capture.
  • ISO 8601 time format (Example: 2019-11-02T18:47:57+00:00)
shippingTrackingURL string The FedEx, UPS, or other mail service URL associated with a shipment. This is not necessary for cart capture.
  • 4,096 characters maximum
shippingDetails string Information associated with a shipment. This is not necessary for cart capture.
  • 10,000 characters maximum
shippingTrackingURL string The FedEx, UPS, or other mail service URL associated with a shipment. This is not necessary for cart capture.
  • 4,096 characters maximum
mobilePhoneNumber string The mobile phone number of the contact. This is not used for cart capture and is stored for orders only.
  • E.164 phone format (Example: 19195551212)
orderSmsConsentChecked boolean Indicates whether the customer consented being contacted via SMS. This is not used for cart capture and is stored for orders only.
  • true or false
lineItems: [
sku string The SKU for the item. It should match your product catalog and use the same capitalization.
  • 100 characters maximum
name string The name of the line item.
  • 200 characters maximum
description string A description of the line item.
  • 10,000 characters maximum
category string The category of the line item.
  • 1,000 characters maximum
other string Additional information about the line item.
  • 2,500 characters maximum
unitPrice number Normal price for the product.
  • No more than 6 decimal places, maximum value is 999,999,999.999999
  • All currency amounts are numbers with a period as a decimal separator. The total 1234.56 is valid and 1.234,56 is not valid.
salePrice number If the product is on sale, the sales price for the product.If the product is not on sale, the sale price will match the unit price.
  • No more than 6 decimal places, maximum value is 999,999,999.999999
  • All currency amounts are numbers with a period as a decimal separator. The total 1234.56 is valid and 1.234,56 is not valid.
quantity
Note: This is a required field for cart and order capture when line items are included.
number The quantity purchased of a specific line item. This field cannot be null.
  • No more than 6 decimal places, maximum value is 999,999,999.999999
totalPrice
Note: This is a required field for cart and order capture when line items are included.
number Price for an individual product in the order without shipping or tax included. This field cannot be null.
  • No more than 6 decimal places, maximum value is 999,999,999.999999
  • All currency amounts are numbers with a period as a decimal separator. The total 1234.56 is valid and 1.234,56 is not valid.
imageUrl string The URL path to an image of the line item.
  • 20,000 characters maximum
productUrl string The URL path to the product in your commerce system.
  • 2,000 characters maximum
]