Skip to main content
Skip to Content
DocsManagement APICheckouts

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 /checkouts/{checkoutId}

Request

Returns a Checkout.

Notes

The cart ID and checkout ID are the same.

Authentication

  • X-Auth-Token in header

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 - array
    • cart.line_items.physical_items.options
      • physical options
    • cart.line_items.digital_items.options
      • digital options
    • consignments.available_shipping_options
      • shipping options
    • promotions.banners
      • promotion options
    Type: array[string]

    Allowed: cart.line_items.physical_items.options | cart.line_items.digital_items.options | consignments.available_shipping_options | promotions.banners

example

Response

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

Update Customer Messages

PUT /checkouts/{checkoutId}

Request

Change customer message pertaining to an existing Checkout.

Limits:

  • 2000 characters for customer message

Authentication

  • X-Auth-Token in header

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.
  • 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_message    string
    required

  • version    integer

    The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
    Example: 1

example

Response

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
Site Checkout URLCheckout Billing Address