Various attributes of this cart.
POST here to create a browser session link.
Custom fields applied to this cart.
Customer who created this cart.
Discounts applied to the products in this cart.
Items in this cart.
Store this cart was created in.
Subscription linked to this cart.
This resource.
The first line of billing street address.
The second line of the billing street address.
The name of the billing address. This is also the value used as the shipto entry for a multiship item.
The city of this address.
The company associated with the billing address.
The country code of the billing address.
The given name associated with the billing address.
The surname associated with the billing address.
The phone of the billing address.
The postal code of the billing address.
The two character code for states in the United States. Other countries may call this a province. When a two character code isn't available, use the full region name.
The 3 character ISO code for the currency. This value may be unavailable in some carts.
The currency symbol, such as $, £, €, etc. This value may be unavailable in some carts.
This value will be populated when customer_uri is set, but can be set separately (for instance, if the customer is unknown or new. This is not used for pre-population on the checkout, but can be helpful in certain situations (such as cart abandonment tracking).
Note that setting customer_uri will overwrite this value, and you will receive an error if you set both customer_email and customer_uri with a mismatched email address.
The full API URI of the customer this cart is associated with. You can not POST a cart into a transaction (ie. charge a customer's saved payment method) unless this value is set to a valid customer with an active default payment method.
Guest (ie. is_anonymous=1 customer resources can be used, but be aware that guest customer payment methods are purged regularly and according to various internal criteria. As such, so you should not rely on a guest customer's saved credit card being usable indefinitely. In general, you shouldn't rely on a saved payment method persisting more than 60 days, though this value is subject to change. (And, of course, there's no guarantee for any saved payment method that it will work in the future, so always be sure to handle payment errors on your end.)
Note that when this value is included, the customer's shipping_* and billing_* values will populate and override any existing values on the cart resource (unless the address values are PUT or PATCHed in the same request, in which case the explicitly set values will be used).
Note that if you are using the customer_uri value, you'll likely either want to explicitly set the use_customer_shipping_address value.
The date this resource was created.
The date this resource was last modified.
The language defined by the template set being used.
The full API URI of the fx:payments resource, from a previous transaction. This can be used in addition to the customer_uri, to specify a specific payment method used in the past. Without this value, the customer's default saved payment method will be used instead.
This can be helpful in certain situations, such as when a customer may use multiple different payment methods, but you need to use the API to charge a specific payment method. For instance, if a customer makes 3 transactions with 3 different credit cards, and you need to add a charge to the 2nd card used. Without this payment_method_uri, the most recent card would be charged.
IMPORTANT NOTES:
payment_method_uri from a transaction that had used an earlier payment method for that gateway. These include PayPal Express Checkout Reference Transaction, Amazon Pay, Stripe Connect, Square and Adyen Embedded.The first line of shipping street address.
The second line of the shipping street address.
The name of the shipping address. This is also the value used as the shipto entry for a multiship item.
The city of this address.
The company associated with the shipping address.
The country code of the shipping address.
The given name associated with the shipping address.
The surname associated with the shipping address.
The phone of the shipping address.
The postal code of the shipping address.
The two character code for states in the United States. Other countries may call this a province. When a two character code isn't available, use the full region name.
The full API URI of the template set for this cart, if one has been specified.
If this cart has any shippable subscription items which will process in the future, this will be the total amount of shipping costs for those items.
Total amount of the items in this cart.
Total order amount of this cart including all items, taxes, shipping costs and discounts.
Total amount of the shipping costs for this cart.
Total amount of the taxes for this cart.
This value determines how an attached customer's addresses should be handled in the event the cart resource is POSTed to. When false, the customer's billing address will be used for both the billing and shipping addresses. Defaults to true, so a customer's shipping address will be used if it exists.
Generated using TypeDoc
Coupon codes applied to the items in this cart.