Cart Object

{
   "id":"e40b1abb-af80-4a4e-b6f0-4746c0e8a90a",
   "mode":"LIVE",
   "status":"IN_PROGRESS",
   "language":"en",
   "email":"[email protected]",
   "currency":"USD",
   "items":[
      {
         "type":"PHYSICAL_PRODUCT",
         "id":"e40b1abb-af80-4a4e-b6f0-4746c0e8a90a",
         "added":"2023-02-01T18:24:26.700Z",
         "product_id":"string",
         "variation_id":"string",
         "external_product_id":"string",
         "external_variation_id":"string",
         "name":"My product name",
         "image":"https://example.org/image.jpg",
         "options":[
            {
               "name":"Color",
               "value":"Red"
            }
         ],
         "shippable":true,
         "quantity":3,
         "unit_price":"25.35",
         "unit_weight":"20.16",
         "unit_dimensions":{
            "height":"20",
            "width":"30",
            "length":"30"
         },
         "discounts":[
            {
               "id":"e40b1abb-af80-4a4e-b6f0-4746c0e8a90a",
               "name":"My discount",
               "savings":"10.25",
               "type":"RATE"
            }
         ],
         "tax_code":"",
         "taxes":[
            {
               "name":"Federal tax",
               "rate":"0.15",
               "amount":"10.25"
            }
         ],
         "total":"75.96",
         "combined_weight":"60.48",
         "metadata":{},
				 "sku":"string"
      }
   ],
   "billing_address":{
      "first_name":"string",
      "last_name":"string",
      "full_name":"string",
      "address_1":"string",
      "address_2":"string",
      "street_number":"string",
      "street_name":"string",
      "city":"string",
      "sub_locality":"string",
      "region":"string",
      "country":"string",
      "postal_code":"string",
      "phone":"string"
   },
   "shipping_address":{
      "first_name":"string",
      "last_name":"string",
      "full_name":"string",
      "address_1":"string",
      "address_2":"string",
      "street_number":"string",
      "street_name":"string",
      "city":"string",
      "sub_locality":"string",
      "region":"string",
      "country":"string",
      "postal_code":"string",
      "phone":"string"
   },
   "shipping_method":{
      "name":"Express shipping",
      "cost":"12.45"
   },
   "shipping_instructions":"string",
   "discounts":[
      {
         "id":"e40b1abb-af80-4a4e-b6f0-4746c0e8a90a",
         "savings":"42.36",
         "name":"15OFF",
         "type":"RATE"
      }
   ],
   "taxes":[
      {
         "name":"Federal tax",
         "amount":"10.23",
         "rate":"0.15"
      }
   ],
   "custom_fields":[
      {
         "id":"cf_89c341606fea47f1be19a09106d877c4",
         "label":"Do you want to add a gift message with your order?",
         "type":"DATE",
         "value":"Yes",
         "zone":"CONTACT_INFO",
         "includes_time":true,
         "date_range_policy":"ANY"
      }
   ],
   "subtotal":"10.54",
   "total":"10.54",
   "created":"2023-02-01T18:24:26.700Z",
   "updated":"2023-02-01T18:24:26.700Z",
   "user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (HTML, like Gecko) Chrome/105.0.0.0 Safari/537.36",
   "ip_address":"1.1.1.1",
   "metadata":"string"
}

Field	Description
idstring	The unique identifier for the cart.
modestring	The mode of the cart, can be one of LIVE or TEST.
statusstring	The current status of the cart, can be one of IN_PROGRESS or ABANDONED.
languagestring	The primary language set on the cart as a two character string in [ISO_3166-1_alpha-2(https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
emailstring	The cart owner's email address.
currencystring	The selected currency set on the cart items as a three character string in ISO_4217 format.
itemsarray	An array of cart items.
billing_addressobject	The billing address of the cart owner.
shipping_addressobject	The shipping address of the cart owner.
shipping_methodobject	The shipping method selected by the cart owner.
shipping_instructionsstring	Additional shipping instructions entered by the cart owner.
discountsarray	An array of discounts applied to the cart.
tax_codestring	Tax code applied to the cart.
taxesarray	An array of taxes applied to the cart.
custom_fields array of objects	Array of custom fields that were configured when the order was placed.
subtotalstring	Subtotal of all items in the cart.
totalstring	Total of all items, discounts, taxes and shipping costs in the cart.
createdstring	Timestamp of cart creation.
updatedstring	Timestamp for last cart update.
user_agentstring	User agent string of device used to create the cart
ip_addressstring	IP address of the device used to create the cart
metadatastring

Cart Items

Field	Description
id string	The unique identifier for this cart item. note: this is different from the product identifier
type string	The type of product added to the cart. Possible options: PHYSICAL_PRODUCT, MEMBERSHIP, SHIPPING, DIGITAL_PRODUCT, BOOKING
added string	Datetime stamp of when this item was added to the cart.
product_id string	The unique identifier for the product backing this cart item.
variation_id string	The unique identifier for the product variation backing this cart item.
external_product_id string	The external id of the product backing this cart item.
external_variation_id string	The external id of the product variation backing this cart item.
name string	The name of the product backing this cart item.
image string	URL to an image of the product backing this cart item.
options array	An array of options chosen by the cart owner for the product backing this cart item.
shippable bool	Indicates if this item requires shipping.
quantity integer	The number of this item, variation and option combination in the cart.
unit_price string	The price per unit of this cart item.
unit_weight float	The weight (in grams) per unit of this cart item.
unit_dimensions object	The per unit `height`, `weight` and `length` (in cm) of this cart item.
discounts array	An array of discounts for this cart item. This value applies across the entire quantity of the item.
taxes array	An array of taxes for this cart item. This value applies across the entire quantity of the item.
total string	The total amount for all units in this cart item.
combined_weight string	The combined weight (in grams) of all the items in the cart.
metadata object
sku string	The SKU of the cart item.

Address

Field	Description
first_name string	First Name attached to the address.
last_name string	Last Name attached to the address.
full_name string	Full Name attached to the address.
address_1 string	The first line of the address.
address_2 string	The second line of the address.
street_number string	The street number note: this may be part of the address_1 or address_2 values, but is available here as a separate value.
street_name string	The street name note: this may be part of the address_1 or address_2 values, but is available here as a separate value.
city string	Name of city attached to the address.
sub_locality string	Sub-locality attached to the address (ex: county or district name).
region string	Region attached to the address (ex. the state or province name).
country string	Country attached to the address.
postal_code string	Postal code attached to the address.
phone string	Phone number of contact located at this address.

Shipping Method

Field	Description
name string	Name of the shipping method.
cost string	Total cost for this shipping method.

Discounts

Field	Description
id string	The unique identifier for this discount.
name string	Descriptive name of the discount.
savings string	Total amount saved by this discount.
type string	The type of discount. Will be one of RATE (percentage off of the initial price) or AMOUNT (fixed discount amount off the initial price)

Taxes

Field	Description
name string	Descriptive name of the tax.
amount string	The total amount of this tax.
rate float	The rate applied for this tax in decimal format (ex: .15 or .05).

Custom Fields

Property	Description
id string	Id of the custom field.
label string	Label displayed alongside the input in the checkout inputs, emails, and in the merchant dashboard.
type string	Input type of the custom fields. Possible input types are: TEXT, TEXTAREA, SELECT, RADIO_LIST, CHECKBOX, DATE
value string	String value entered by the customer. This value can be null when the type is CHECKBOX and the customer did not check the input at checkout. When a custom field has type DATE, its value is an ISO datetime string in UTC time. If includes_time is true, then the time is midnight UTC.
zone string	Enum value where the custom field was located in the checkout process. Possible values: CONTACT_INFO, SHIPPING_ADDRESS, SHIPPING_METHODS, BILLING_ADDRESS, PAYMENT_METHODS
includes_time boolean	When true, the date custom field stores a timestamp; when false, date-only. Required in settings request when type is DATE. Only allowed when type is DATE.
date_range_policy string	Range policy for date custom fields. Required in settings request when type is DATE. Only allowed when type DATE. Enum values: ANY, PAST_ONLY, FUTURE_ONLY

Options

Field	Description
name string	Descriptive name of the option.
value string	Value of the specified option.