Checkouts
Add Checkout Billing Address
POST /stores/{store_hash}/v3/checkouts/{checkoutId}/billing-address
Request
Adds a billing address to an existing checkout.
Required Fields
- country_code
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- checkoutId in path - stringrequired
ID of the checkout; the same as 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
object | application/json
first_namestring
last_namestring
emailstring
requiredcompanystring
address1string
address2string
citystring
state_or_provincestring
Represents state or province.
state_or_province_codestring
country_codestring
requiredpostal_codestring
phonestring
custom_fieldsarray[object]
You can retrieve custom fields from the Get Form Fields endpoint.
example
Response
Body
object | application/json
dataobject
metaobject
Response metadata.
example
Update Checkout Billing Address
PUT /stores/{store_hash}/v3/checkouts/{checkoutId}/billing-address/{addressId}
Request
Updates an existing billing address on a checkout.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- checkoutId in path - stringrequired
ID of the checkout; the same as 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.
- addressId in path - integerrequired
Body
object | application/json
first_namestring
last_namestring
emailstring
requiredcompanystring
address1string
address2string
citystring
state_or_provincestring
Represents state or province.
state_or_province_codestring
country_codestring
requiredpostal_codestring
phonestring
custom_fieldsarray[object]
You can retrieve custom fields from the Get Form Fields endpoint.
example
Response
Body
object | application/json
dataobject
metaobject
Response metadata.
example
Did you find what you were looking for?