Storefront Checkouts
Add Checkout Billing Address
POST /checkouts/{checkoutId}/billing-address
Request
Adds a billing address to an existing Checkout.
Required Fields
- country_code
Note
- The
email
property is only required if the customer is a guest shopper. Otherwise, it is set automatically. - Sending
email
property as a payload in POST request triggers the abandoned cart notification process. - Substitute your storefront domain for
yourstore.example.com
. - The Send a Test Request feature is not currently supported for this endpoint.
Parameters
- store_domain in path - string
- checkoutId in path - stringrequired
The ID of the subject checkout. Identical to the cart ID.
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
firstNamestring
lastNamestring
emailstring
companystring
address1string
address2string
citystring
stateOrProvincestring
Represents state or province.
stateOrProvinceCodestring
countryCodestring
requiredISO 3166-1 alpha-2 country code. (See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
postalCodestring
phonestring
customFieldsarray[object]
example
Response
Body
idstring
cartobject
A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data.
billingAddressobject
consignmentsarray[object]
couponsarray[object]
Coupons applied at the checkout level.
orderIdstring or null
shippingCostTotalnumber
Shipping cost before any discounts are applied.
giftWrappingCostTotalnumber
Gift wrapping cost for all items, including or excluding tax.
handlingCostTotalnumber
Handling cost for all consignments including or excluding tax.
taxTotalnumber
taxesarray[object]
subtotalnumber
Subtotal of the checkout before applying item-level discounts. Tax inclusive based on the store settings.
grandTotalnumber
The total payable amount, before applying any store credit or gift certificate.
giftCertificatesarray[array]
Applied gift certificate (as a payment method).
createdTimestring
Time when the cart was created.
updatedTimestring
Time when the cart was last updated.
customerMessagestring
Shopperʼs message provided as details for the order to be created from this cart
outstandingBalancenumber
grandTotal
subtract the store-credit amountisStoreCreditAppliedboolean
true
value indicates StoreCredit has been applied.
example
Update Checkout Billing Address
PUT /checkouts/{checkoutId}/billing-address/{addressId}
Request
Updates an existing billing address on Checkout.
Note
- Substitute your storefront domain for
yourstore.example.com
. - The Send a Test Request feature is not currently supported for this endpoint.
Parameters
- store_domain in path - string
- checkoutId in path - stringrequired
The ID of the subject checkout. Identical to the cart ID.
- addressId in path - numberrequired
The ID of the subject address.
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
firstNamestring
lastNamestring
emailstring
companystring
address1string
address2string
citystring
stateOrProvincestring
Represents state or province.
stateOrProvinceCodestring
countryCodestring
requiredISO 3166-1 alpha-2 country code. (See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
postalCodestring
phonestring
customFieldsarray[object]
example
Response
Body
idstring
cartobject
A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data.
billingAddressobject
consignmentsarray[object]
couponsarray[object]
Coupons applied at the checkout level.
orderIdstring or null
shippingCostTotalnumber
Shipping cost before any discounts are applied.
giftWrappingCostTotalnumber
Gift wrapping cost for all items, including or excluding tax.
handlingCostTotalnumber
Handling cost for all consignments including or excluding tax.
taxTotalnumber
taxesarray[object]
subtotalnumber
Subtotal of the checkout before applying item-level discounts. Tax inclusive based on the store settings.
grandTotalnumber
The total payable amount, before applying any store credit or gift certificate.
giftCertificatesarray[array]
Applied gift certificate (as a payment method).
createdTimestring
Time when the cart was created.
updatedTimestring
Time when the cart was last updated.
customerMessagestring
Shopperʼs message provided as details for the order to be created from this cart
outstandingBalancenumber
grandTotal
subtract the store-credit amountisStoreCreditAppliedboolean
true
value indicates StoreCredit has been applied.