Storefront Checkouts
Manage checkout operations and data on BigCommerce-hosted storefronts. To work with headless storefronts, use the GraphQL Storefront API.
The REST Storefront API uses CORS (opens in a new tab) headers for authentication, and therefore has no required scopes. You do not need to send any BigCommerce-specific tokens with your requests to these endpoints.
For info about authenticating BigCommerce APIs, see Authentication and Example Requests.
Get a Checkout
GET /checkouts/{checkoutId}
Request
Returns a Checkout.
The cart ID and checkout ID are the same.
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
- include in query with default of consignments.availableShippingOptions - array
cart.lineItems.physicalItems.options
- physical optionscart.lineItems.digitalItems.options
- digital optionscart.lineItems.physicalItems.categoryNames
- physical categoriescart.lineItems.digitalItems.categoryNames
- digital categoriescart.lineItems.customItems.categoryNames
- custom categoriescustomer
- customercustomer.customerGroup
- customer grouppayments
- paymentspromotions
- promotionsconsignments.availableShippingOptions
- shipping optionsconsignments.availablePickupOptions
- pickup options
example
Response
Body
object | application/json
dataobject
example
Update Customer Messages
PUT /checkouts/{checkoutId}
Request
Updates Checkout customer messages.
Limits
- 2000 character limit
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
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
object | application/json
customerMessagestring
example
Response
Body
object | application/json
dataobject
example
Did you find what you were looking for?