Skip to main content
API docs by Redocly

Checkout Flows (1.0)

Download OpenAPI specification:Download

URL: https://developer-dashboard.boldcommerce.com/default/contactus Terms of Service

The Checkout Flows API allows a third party integration to gather information about flows, enable existing flows, or create new flows for a particular merchant.

NOTE: These endpoints are currently in development and are considered experimental. Note that the endpoints may change parameter requirements, payloads, and/or behavior.

For more information about Checkout flows, refer to the Checkout Flows Overview.

Flows

Use these endpoints to interact with Checkout flows at a store-level.

List Enabled Flows

Lists all flows currently enabled for the shop.

Authorizations:
APIAccessToken
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint.

Responses

Response samples

Content type
application/json
Example
{
  • "flows": [
    ]
}

List Available Flows

Lists all flows currently available for the shop, excluding enabled flows.

If a store meets all requirements to enable a flow, the flow is available. Requirements differ between flows. Contact your Bold account manager to determine the necessary configurations for your store.

Authorizations:
APIAccessToken
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint.

Responses

Response samples

Content type
application/json
Example
{
  • "flows": [
    ]
}

Enable Flow

Enables a flow for the shop.

Authorizations:
APIAccessToken
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint.

flow_id
required
string
Example: self-hosted-flow-1

The identifier of the checkout flow, which can be retrieved by making a request to the List Available Flows endpoint.

Responses

Response samples

Content type
application/json
{
  • "flows": [
    ]
}

Disable Flow

Disables a flow for the shop.

Authorizations:
APIAccessToken
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint.

flow_id
required
string
Example: self-hosted-flow-1

The identifier of the checkout flow, which can be retrieved by making a request to the List Available Flows endpoint.

Responses

Response samples

Content type
application/json
{
  • "flows": [
    ]
}