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 /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 header - required
Parameters
- store_hash in path - string
- checkoutId in path - string - required
ID of the checkout; the same as the cart ID.
- Accept in header with default of application/json - string - required
The MIME type of the response body.
- include in query - string
cart.line_items.physical_items.options
- physical optionscart.line_items.digital_items.options
- digital optionsconsignments.available_shipping_options
- shipping optionspromotions.banners
- promotion options
Allowed values: cart.line_items.physical_items.options | cart.line_items.digital_items.options | consignments.available_shipping_options | promotions.banners
example
Response
Body
object | application/json
dataobject
metaobject
Response metadata.
Update Customer Messages
PUT /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 header - required
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - string - required
The MIME type of the request body.
customer_message
is required (maximum length is 2000).
Body
object | application/json
customer_messagestring
required
example
Response
Body
object | application/json
dataobject
metaobject
Response metadata.