Docs
Storefront API
Checkouts

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.
  • This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

Parameters

  • store_domain in path - string
  • include in query with default of consignments.availableShippingOptions - array
    • cart.lineItems.physicalItems.options - physical options
    • cart.lineItems.digitalItems.options - digital options
    • cart.lineItems.physicalItems.categoryNames - physical categories
    • cart.lineItems.digitalItems.categoryNames - digital categories
    • cart.lineItems.customItems.categoryNames - custom categories
    • customer - customer
    • customer.customerGroup - customer group
    • payments - payments
    • promotions - promotions
    • consignments.availableShippingOptions - shipping options
    • consignments.availablePickupOptions - pickup options

    Type: array[string]

    Allowed: cart.lineItems.physicalItems.options | cart.lineItems.digitalItems.options | cart.lineItems.physicalItems.categoryNames | cart.lineItems.digitalItems.categoryNames | cart.lineItems.customItems.categoryNames | customer | customer.customerGroup | payments | promotions | consignments.availableShippingOptions | consignments.availablePickupOptions

example

Response

Body

object | application/json
  • data
    object

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.
  • This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

Parameters

  • store_domain in path - string
  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

object | application/json
  • customerMessage
    string

example

Response

Body

object | application/json
  • data
    object

example

Did you find what you were looking for?