Skip to main content
API docs by Redocly

Subscription Builder Storefront API (1.0)

Download OpenAPI specification:Download

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

Note: Subscription Builder requires Bold Checkout to be installed on your store. Therefore, it is not available to merchants using Shopify. For information on build-a-box subscriptions on Shopify, refer to the Help Center.

Subscription Builder makes it possible to create advanced build-a-box style subscription boxes, where customers can choose the contents of each subscription order. Merchants must be using Bold Checkout to use this functionality.

The Subscription Builder Storefront API contains endpoints specific to storefront functionality and does not require special authentication.

Refer to the changelog for the latest updates to this API.

For more information about Subscription Builder, refer to the Overview.

Boxes

Contains information about subscription boxes, including shop IDs and subscription groups. Use these endpoints to get and list subscription boxes.

List Boxes

List subscription boxes in a store.

Authorizations:
None
path Parameters
shop_identifier
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "pagination": {
    }
}

Get Box

Get a subscription box by its ID.

Authorizations:
None
path Parameters
shop_identifier
required
string
box_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Box Sizes

A child resource of Boxes. Contains information about subscription box sizes, including subscription box ID and shop ID. Use these endpoints to list subscription box sizes.

Get Box Sizes

Get box sizes by a subscription box ID.

Authorizations:
None
path Parameters
shop_identifier
required
string
box_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "pagination": {
    }
}

Time Slots

Contains information about subscription box time slots, including datetime and time slot options. Use these endpoints to list time slots for a subscription box.

List Time Slots

List time slots for a subscription box.

Authorizations:
None
path Parameters
shop_identifier
required
string
box_id
required
string
query Parameters
order_datetime
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "pagination": {
    }
}