Skip to main content

Products (2.0.0)

Download OpenAPI specification:Download

This API allows you to find information about your products, variants and categories.

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

Authentication

OAuthToken

Authenticates an API request from a public integration. Generate this token in the Developer Dashboard. Refer to Build Public Integrations for more information.

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://apps.boldapps.net/accounts/dashboard/authorize
Token URL: https://api.boldcommerce.com/auth/oauth2/token

APIAccessToken

Authenticates an API request from a private integration. Generate this token in the Bold Account Center. Refer to the Quick Start for more information.

Security Scheme Type API Key
Header parameter name: API Access Token

Products

Contains information about the products associated with a given store. Use these endpoints to retrieve information about one or all products on a store.

List Products

Authorizations:
path Parameters
shop_identifier
required
string

Path

query Parameters
deep
boolean <boolean>

When set to true, this endpoint fetches and populates related child entities in the response payload, including: product options, product variants and their option_values, product images, product categories, localized_names, and localized_descriptions for the products.

categoryid
integer <int64>
filtercolumn
string
filtervalue
string
ordercolumn
string
orderdirection
string
updated_at_min
string
updated_at_max
string
include_deleted
boolean <boolean>
es_optimize
boolean <boolean>
filter
Array of strings
limit
integer <int32>
page
integer <int32>

Responses

Response samples

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

Get Product by Platform ID

Find a product by platform identifier (i.e. The ID of the product in the ecommerce platform)

Authorizations:
path Parameters
shop_identifier
required
string
pid
required
string
query Parameters
deep
boolean <boolean>

When set to true, this endpoint fetches and populates related child entities in the response payload, including: product options, product variants and their option_values, product images, product categories, localized_names, and localized_descriptions for the product.

Responses

Response samples

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

Get Product by ID

Find a product by ID

Authorizations:
path Parameters
shop_identifier
required
string
id
required
integer <int64>
query Parameters
deep
boolean <boolean>

When set to true, this endpoint fetches and populates related child entities in the response payload, including: product options, product variants and their option_values, product images, product categories, localized_names, and localized_descriptions for the product.

Responses

Response samples

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

List Product Types

List the types for all products

Authorizations:
path Parameters
shop_identifier
required
string

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "data": [
    ]
}

List Product Vendors

List the vendors for all products

Authorizations:
path Parameters
shop_identifier
required
string

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "data": [
    ]
}

Variants

A child of the Product resource. Contains information about the variants of a product, which are derived from different combinations of options. Use these endpoints to retrieve information about a single variant, the variants of a single product, or all variants on a store.

List Product Variants

List the variants for a product

Authorizations:
path Parameters
shop_identifier
required
string
bold_product_id
required
integer <int64>
query Parameters
limit
integer <int32>
page
integer <int32>

Responses

Response samples

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

Get Product Variant by Platform ID

Find a product variant by platform identifier (i.e. The ID of the product variant in the ecommerce platform)

Authorizations:
path Parameters
shop_identifier
required
string
bold_product_id
required
integer <int64>

not used

pid
required
string

Responses

Response samples

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

Get Product Variant by ID

Find a product variant by ID

Authorizations:
path Parameters
shop_identifier
required
string
bold_product_id
required
integer <int64>

not used

id
required
integer <int64>

Responses

Response samples

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

List Variants for Shop

List all variants for your shop (no product ID required)

Authorizations:
path Parameters
shop_identifier
required
string

Path

query Parameters
filter
Array of strings

Query.

limit
integer <int32>
page
integer <int32>

Responses

Response samples

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

Categories

Contains information about the product categories applicable on a given store. Use these endpoints to retrieve information about one or all product categories on a store.

List Categories

List the categories for your shop

Authorizations:
path Parameters
shop_identifier
required
string
query Parameters
ids
string
limit
integer <int32>
page
integer <int32>

Responses

Response samples

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

Get Category by Platform ID

Find a product category by platform identifier (i.e. The ID of the category in the ecommerce platform)

Authorizations:
path Parameters
shop_identifier
required
string
pid
required
string

Responses

Response samples

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

Get Category by ID

Find a product category by ID

Authorizations:
path Parameters
shop_identifier
required
string
id
required
integer <int64>

Responses

Response samples

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

List Product Categories

List the product categories for your shop

Authorizations:
path Parameters
shop_identifier
required
string

Path

query Parameters
filter
Array of strings

Query.

limit
integer <int32>
page
integer <int32>

Responses

Response samples

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

Images

Contains information about the product images associated with a given store. Use these endpoints to retrieve information about one or all product images on a store.

List Product Images

List the images for a product

Authorizations:
path Parameters
shop_identifier
required
string
bold_product_id
required
integer <int64>
query Parameters
limit
integer <int32>
page
integer <int32>

Responses

Response samples

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

Get Product Image by Platform ID

Find a product image by platform identifier (i.e. The ID of the product image in the ecommerce platform)

Authorizations:
path Parameters
shop_identifier
required
string
bold_product_id
required
integer <int64>

not used

pid
required
string

Responses

Response samples

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

Get Product Image by ID

Find a product image by ID

Authorizations:
path Parameters
shop_identifier
required
string
bold_product_id
required
integer <int64>

not used

id
required
integer <int64>

Responses

Response samples

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

Options

A child of the Product resource. Contains information about the options associated with a given product, such as colors, sizes, weights, etc. Use these endpoints to retrieve information about one or all product options for a product.

List Product Options

List the options for a product

Authorizations:
path Parameters
shop_identifier
required
string
bold_product_id
required
integer <int64>
query Parameters
limit
integer <int32>
page
integer <int32>

Responses

Response samples

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

Get Product Option by Platform ID

Find a product option by platform identifier (i.e. The ID of the product option in the ecommerce platform)

Authorizations:
path Parameters
shop_identifier
required
string
bold_product_id
required
integer <int64>

not used

pid
required
string

Responses

Response samples

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

Get Product Option by ID

Find a product option by ID

Authorizations:
path Parameters
shop_identifier
required
string
bold_product_id
required
integer <int64>

not used

id
required
integer <int64>

Responses

Response samples

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