Bold Commerce

Bold Commerce builds modular e-commerce apps and headless commerce APIs for subscriptions, checkout, and pricing. Merchants and developers integrate Bold Subscriptions (recurring orders and branded customer portals), Bold Checkout (a headless, fully customizable checkout across Frontend, Backend, and Admin surfaces), and Bold Price Rules (discounts, promotions, and dynamic pricing), alongside supporting Products, Customers, and Shops APIs. Requests are made against api.boldcommerce.com and authenticated with an OAuth 2.0 access token (public integrations) or a scoped API access token (private integrations), passed as a Bearer token.

6 APIs 0 Features
E-CommerceSubscriptionsCheckoutPricingHeadless CommerceShopify

APIs

Bold Subscriptions API

Create, retrieve, update, pause, cancel, and reactivate subscriptions; manage line items, intervals, discount codes, shipping addresses, orders (skip / unskip), and adjustments....

Bold Checkout API

Headless storefront checkout - manage shipping and billing addresses, line items, discounts, shipping lines, taxes, customers, and payments against an order, returning full orde...

Bold Price Rules API

Create and manage discounts, promotions, and dynamic pricing through rulesets and rules, order conditions, bulk activate / deactivate operations, a storefront ruleset lookup, an...

Bold Products API

Read and manage the product catalog for a shop - list, retrieve, create, update, and delete products and variants scoped to a shop_identifier.

Bold Customers API

List, retrieve, create, and update customer records tied to a shop, used across checkout, subscriptions, and pricing to associate orders and recurring plans with shoppers.

Bold Shops API

Retrieve shop configuration and the shop_identifier GUID required in the path of most Bold API requests, including shop name, domain, platform, and default currency.

Collections

Pricing Plans

Rate Limits

Bold Commerce Rate Limits

3 limits

RATE LIMITS

FinOps

Resources

🔗
TrustCenter
TrustCenter
🔗
DomainSecurity
DomainSecurity
🔑
Authentication
Authentication
👥
GitHubOrganization
GitHubOrganization
🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps
📰
Blog
Blog

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Bold Commerce API
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{apiToken}}'
items:
- info:
    name: Subscriptions
    type: folder
  items:
  - info:
      name: List subscriptions.
      type: http
    http:
      method: GET
      url: https://api.boldcommerce.com/subscriptions/v1/shops/{{shop_identifier}}/subscriptions
    docs: Retrieve a list of subscriptions for the shop.
  - info:
      name: Create a subscription.
      type: http
    http:
      method: POST
      url: https://api.boldcommerce.com/subscriptions/v1/shops/{{shop_identifier}}/subscriptions
      body:
        type: json
        data: '{}'
    docs: Create a new subscription.
  - info:
      name: Retrieve a subscription.
      type: http
    http:
      method: GET
      url: https://api.boldcommerce.com/subscriptions/v1/shops/{{shop_identifier}}/subscriptions/:subscription_id
      params:
      - name: subscription_id
        value: ''
        type: path
        description: The subscription ID.
    docs: Fetch an individual subscription.
  - info:
      name: Pause a subscription.
      type: http
    http:
      method: POST
      url: https://api.boldcommerce.com/subscriptions/v1/shops/{{shop_identifier}}/subscriptions/:subscription_id/pause
      params:
      - name: subscription_id
        value: ''
        type: path
        description: The subscription ID.
    docs: Pause subscription processing.
  - info:
      name: Cancel a subscription.
      type: http
    http:
      method: POST
      url: https://api.boldcommerce.com/subscriptions/v1/shops/{{shop_identifier}}/subscriptions/:subscription_id/cancel
      params:
      - name: subscription_id
        value: ''
        type: path
        description: The subscription ID.
    docs: Cancel an active subscription.
  - info:
      name: Reactivate a subscription.
      type: http
    http:
      method: POST
      url: https://api.boldcommerce.com/subscriptions/v1/shops/{{shop_identifier}}/subscriptions/:subscription_id/activate
      params:
      - name: subscription_id
        value: ''
        type: path
        description: The subscription ID.
    docs: Reactivate an inactive or cancelled subscription.
  - info:
      name: List subscription orders.
      type: http
    http:
      method: GET
      url: https://api.boldcommerce.com/subscriptions/v1/shops/{{shop_identifier}}/subscriptions/:subscription_id/orders
      params:
      - name: subscription_id
        value: ''
        type: path
        description: The subscription ID.
    docs: List the orders for a subscription.
- info:
    name: Checkout
    type: folder
  items:
  - info:
      name: Set shipping address.
      type: http
    http:
      method: POST
      url: https://api.boldcommerce.com/checkout/storefront/{{shop_id}}/:order_id/addresses/shipping
      params:
      - name: order_id
        value: ''
        type: path
        description: The public order ID.
      body:
        type: json
        data: '{}'
    docs: Sets the shipping address on the order.
  - info:
      name: Set billing address.
      type: http
    http:
      method: POST
      url: https://api.boldcommerce.com/checkout/storefront/{{shop_id}}/:order_id/addresses/billing
      params:
      - name: order_id
        value: ''
        type: path
        description: The public order ID.
      body:
        type: json
        data: '{}'
    docs: Sets the billing address on the order.
  - info:
      name: Add line items.
      type: http
    http:
      method: POST
      url: https://api.boldcommerce.com/checkout/storefront/{{shop_id}}/:order_id/line_items
      params:
      - name: order_id
        value: ''
        type: path
        description: The public order ID.
      body:
        type: json
        data: '{}'
    docs: Add line items to the order.
  - info:
      name: Add payment.
      type: http
    http:
      method: POST
      url: https://api.boldcommerce.com/checkout/storefront/{{shop_id}}/:order_id/payments
      params:
      - name: order_id
        value: ''
        type: path
        description: The public order ID.
      body:
        type: json
        data: '{}'
    docs: Add a payment to the order.
- info:
    name: Price Rules
    type: folder
  items:
  - info:
      name: List rulesets.
      type: http
    http:
      method: GET
      url: https://api.boldcommerce.com/price_rules/rules/v2/shops/{{shop_identifier}}/rulesets
    docs: List all rulesets available for the specified shop.
  - info:
      name: Create a ruleset.
      type: http
    http:
      method: POST
      url: https://api.boldcommerce.com/price_rules/rules/v2/shops/{{shop_identifier}}/rulesets
      body:
        type: json
        data: '{}'
    docs: Create a new ruleset. Requires the write_price_rulesets scope.
  - info:
      name: Process final price.
      type: http
    http:
      method: POST
      url: https://api.boldcommerce.com/price_rules/rules/v2/shops/{{shop_identifier}}/process
      body:
        type: json
        data: '{}'
    docs: Return the final price for a line item in a cart.
- info:
    name: Products
    type: folder
  items:
  - info:
      name: List products.
      type: http
    http:
      method: GET
      url: https://api.boldcommerce.com/products/v2/shops/{{shop_identifier}}/products
    docs: List the products for a shop.
- info:
    name: Customers
    type: folder
  items:
  - info:
      name: List customers.
      type: http
    http:
      method: GET
      url: https://api.boldcommerce.com/customers/v2/shops/{{shop_identifier}}/customers
    docs: List the customers for a shop.
- info:
    name: Shops
    type: folder
  items:
  - info:
      name: Retrieve shop info.
      type: http
    http:
      method: GET
      url: https://api.boldcommerce.com/shops/v1/info
    docs: Retrieve the shop configuration and shop_identifier GUID.