post

/checkouts/{checkoutId}/billing-address

Adds a billing address to an existing Checkout.

Required Fields

  • email
  • country_code

Request Parameters

1 Path Parameter
2 Headers

Request Body

Either email or countryCode is required.

1 Example
Schema
object
first_name
string
last_name
string
email
string
required
company
string
address1
string
address2
string
city
string
state_or_province
string

Represents state or province.

state_or_province_code
string
country_code
string
required
postal_code
string
phone
string
1 validation
custom_fields
array[object]

Responses

1 Example
Schema
object
id
string
1 validation
cart
object
billing_address
object
consignments
array[object]
taxes
array[object]
coupons
array[object]

Coupons applied at checkout level.

order_id
string
shipping_cost_total_inc_tax
number

Shipping cost before any discounts are applied including tax.

1 validation
shipping_cost_total_ex_tax
number

Shipping cost before any discounts are applied excluding tax.

1 validation
handling_cost_total_inc_tax
number

Handling cost for all consignments including tax.

1 validation
handling_cost_total_ex_tax
number

Handling cost for all consignments excluding tax.

1 validation
tax_total
number
1 validation
subtotal_inc_tax
number

Subtotal of the checkout before applying item level discounts including tax.

1 validation
subtotal_ex_tax
number

Subtotal of the checkout before applying item level discounts excluding tax.

1 validation
grand_total
number

The total payable amount, before applying any store credit or gift certificate.

1 validation
created_time
string

Time when the cart was created.

updated_time
string

Time when the cart was last updated.

customer_message
string

Shopper’s message provided as details for the order to be created from this checkout

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
2 path params not set
store_hash
checkoutId
$$.env
No $$.env variables are being used in this request.