Checkouts
For more information on authenticating BigCommerce APIs, see Authentication.
Create and manage checkouts from existing carts using BigCommerce checkout logic.
Get a Checkout
GET https://api.bigcommerce.com/stores/{store_hash}/v3/checkouts/{checkoutId}Request
Returns a Checkout.
Notes
The cart ID and checkout ID are the same.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
object | application/json
dataobject
Update Customer Messages
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/checkouts/{checkoutId}Request
Change customer message pertaining to an existing Checkout.
Limits:
- 2000 characters for customer message
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
customer_message
is required (maximum length is 2000).
Body
object | application/json
example
Response
Body
object | application/json
dataobject
example
Did you find what you were looking for?