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
Lists all products in the shop.
For more information on result pagination, refer to the Query & Pagination page.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
query Parameters
deep | boolean <boolean> Example: deep=true Indicates whether to perform a deep search. When set to
|
limit | integer <int32> Example: limit=50 The maximum number of results to return per page. |
page | integer <int32> Example: page=1 The desired page number for the paginated results. |
filter | Array of strings Example: filter=eq(target:order) A filter for returned results. Accepts filtering options as described in the Query & Pagination page. |
categoryid | integer <int64> Example: categoryid=100 The category identifier to search within. Assigned by Bold. |
filtercolumn | string Example: filtercolumn=type The column name by which to perform a fuzzy search with the |
filtervalue | string Example: filtervalue=%27hat%27 A search term used to perform a fuzzy search on the |
ordercolumn | string Example: ordercolumn=type The method of ordering the returned results. Must be paired with the |
orderdirection | string Example: orderdirection=asc The direction of ordering returned results. Must be paired with the |
updated_at_min | string <date-time> Example: updated_at_min=2020-01-01T00:00:00Z The earliest date (in RFC3339 format) the customer was updated. |
updated_at_max | string <date-time> Example: updated_at_max=2020-01-02T00:00:00Z The latest date (in RFC3339 format) the product was updated. |
include_deleted | boolean <boolean> Example: include_deleted=true Indicates whether to include deleted products in search results. |
es_optimize | boolean <boolean> Example: es_optimize=true Indicates whether to optimize the results for Elasticsearch. |
Responses
Response samples
- 200
- default
{- "pagination": {
- "total": 143,
- "count": 143,
- "per_page": 50,
- "current_page": 2,
- "total_pages": 3,
}, - "data": [
- {
- "product": {
- "id": 123,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Beach hat",
- "handle": "beach-hat",
- "description": "A hat for the beach",
- "type": "Hat",
- "vendor": "OFS",
- "inventory_quantity": 5,
- "inventory_tracking_service": "platform",
- "inventory_tracking_entity": "product",
- "tags": "hat, summer, beach",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "published": true,
- "url": "example.store.com/files/products/hats/beach-hat.jpg",
- "tax_code": "non-taxable",
- "localized_names": {
- "en": "Purple",
- "fr": "Violette"
}, - "localized_descriptions": {
- "en": "A hat for the beach",
- "fr": "Un chapeau pour la plage"
}
}, - "images": [
- {
- "id": 456,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z"
}
], - "variants": [
- {
- "id": 789,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Default Title",
- "sku": "BEACH-HAT-PURPLE",
- "weight_unit": "kg",
- "grams": 1000,
- "image_id": 321,
- "image_url": "example.store.com/files/products/hats/purple-beach-hat.jpg",
- "inventory_quantity": 5,
- "allow_backorder": true,
- "inventory_tracking_service": "platform",
- "inventory_tracking_entity": "product",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "require_shipping": true,
- "price": 30,
- "cost": 25,
- "compare_at_price": 30,
- "tax_code": "non-taxable",
- "weight": 1,
- "tax_exempt": true,
- "option_values": [
- {
- "id": 5,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_variant_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "label": "Small",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z"
}
], - "localized_names": {
- "en": "Purple",
- "fr": "Violette"
}
}
], - "options": [
- {
- "id": 900,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Small",
- "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "values": [
- {
- "shop_identifier": "zp3oafdor9",
- "label": "Small",
- "is_default": true,
- "id": 143,
- "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}
}
]
}
], - "categories": [
- {
- "id": 100,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Hats",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "image_url": "example.store.com/files/categories/hats.jpg"
}
]
}
]
}
Get Product by Platform ID
Retrieves a product by its platform-specific identifier.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
pid required | string Example: 110 The unique identifier for this category. Assigned by the shop platform. |
query Parameters
deep | boolean <boolean> Example: deep=true Indicates whether to perform a deep search. When set to
|
Responses
Response samples
- 200
- default
{- "data": {
- "product": {
- "id": 123,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Beach hat",
- "handle": "beach-hat",
- "description": "A hat for the beach",
- "type": "Hat",
- "vendor": "OFS",
- "inventory_quantity": 5,
- "inventory_tracking_service": "platform",
- "inventory_tracking_entity": "product",
- "tags": "hat, summer, beach",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "published": true,
- "url": "example.store.com/files/products/hats/beach-hat.jpg",
- "tax_code": "non-taxable",
- "localized_names": {
- "en": "Purple",
- "fr": "Violette"
}, - "localized_descriptions": {
- "en": "A hat for the beach",
- "fr": "Un chapeau pour la plage"
}
}, - "images": [
- {
- "id": 456,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z"
}
], - "variants": [
- {
- "id": 789,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Default Title",
- "sku": "BEACH-HAT-PURPLE",
- "weight_unit": "kg",
- "grams": 1000,
- "image_id": 321,
- "image_url": "example.store.com/files/products/hats/purple-beach-hat.jpg",
- "inventory_quantity": 5,
- "allow_backorder": true,
- "inventory_tracking_service": "platform",
- "inventory_tracking_entity": "product",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "require_shipping": true,
- "price": 30,
- "cost": 25,
- "compare_at_price": 30,
- "tax_code": "non-taxable",
- "weight": 1,
- "tax_exempt": true,
- "option_values": [
- {
- "id": 5,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_variant_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "label": "Small",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z"
}
], - "localized_names": {
- "en": "Purple",
- "fr": "Violette"
}
}
], - "options": [
- {
- "id": 900,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Small",
- "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "values": [
- {
- "shop_identifier": "zp3oafdor9",
- "label": "Small",
- "is_default": true,
- "id": 143,
- "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}
}
]
}
], - "categories": [
- {
- "id": 100,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Hats",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "image_url": "example.store.com/files/categories/hats.jpg"
}
]
}
}
Get Product by ID
Retrieves a product by its Bold-specific identifier.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
id required | integer <int64> Example: 100 The unique identifier for this product. Assigned by Bold. |
query Parameters
deep | boolean <boolean> Example: deep=true Indicates whether to perform a deep search. When set to
|
Responses
Response samples
- 200
- default
{- "data": {
- "product": {
- "id": 123,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Beach hat",
- "handle": "beach-hat",
- "description": "A hat for the beach",
- "type": "Hat",
- "vendor": "OFS",
- "inventory_quantity": 5,
- "inventory_tracking_service": "platform",
- "inventory_tracking_entity": "product",
- "tags": "hat, summer, beach",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "published": true,
- "url": "example.store.com/files/products/hats/beach-hat.jpg",
- "tax_code": "non-taxable",
- "localized_names": {
- "en": "Purple",
- "fr": "Violette"
}, - "localized_descriptions": {
- "en": "A hat for the beach",
- "fr": "Un chapeau pour la plage"
}
}, - "images": [
- {
- "id": 456,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z"
}
], - "variants": [
- {
- "id": 789,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Default Title",
- "sku": "BEACH-HAT-PURPLE",
- "weight_unit": "kg",
- "grams": 1000,
- "image_id": 321,
- "image_url": "example.store.com/files/products/hats/purple-beach-hat.jpg",
- "inventory_quantity": 5,
- "allow_backorder": true,
- "inventory_tracking_service": "platform",
- "inventory_tracking_entity": "product",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "require_shipping": true,
- "price": 30,
- "cost": 25,
- "compare_at_price": 30,
- "tax_code": "non-taxable",
- "weight": 1,
- "tax_exempt": true,
- "option_values": [
- {
- "id": 5,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_variant_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "label": "Small",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z"
}
], - "localized_names": {
- "en": "Purple",
- "fr": "Violette"
}
}
], - "options": [
- {
- "id": 900,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Small",
- "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "values": [
- {
- "shop_identifier": "zp3oafdor9",
- "label": "Small",
- "is_default": true,
- "id": 143,
- "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}
}
]
}
], - "categories": [
- {
- "id": 100,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Hats",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "image_url": "example.store.com/files/categories/hats.jpg"
}
]
}
}
List Product Types
Lists the product types for all products in the shop.
For more information on result pagination, refer to the Query & Pagination page.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
Responses
Response samples
- 200
- default
{- "type": "Hat",
- "data": [
- "string"
]
}
List Product Vendors
Lists the vendors for all products in the shop.
For more information on result pagination, refer to the Query & Pagination page.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
Responses
Response samples
- 200
- default
{- "type": "string",
- "data": [
- "string"
]
}
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
Lists the variants for a product by its Bold-specific product identifier.
For more information on result pagination, refer to the Query & Pagination page.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
bold_product_id required | integer <int64> Example: 123 A unique identifier for the product. Assigned by Bold. |
query Parameters
limit | integer <int32> Example: limit=50 The maximum number of results to return per page. |
page | integer <int32> Example: page=1 The desired page number for the paginated results. |
Responses
Response samples
- 200
- default
{- "pagination": {
- "total": 143,
- "count": 143,
- "per_page": 50,
- "current_page": 2,
- "total_pages": 3,
}, - "data": [
- {
- "id": 789,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Default Title",
- "sku": "BEACH-HAT-PURPLE",
- "weight_unit": "kg",
- "grams": 1000,
- "image_id": 321,
- "image_url": "example.store.com/files/products/hats/purple-beach-hat.jpg",
- "inventory_quantity": 5,
- "allow_backorder": true,
- "inventory_tracking_service": "platform",
- "inventory_tracking_entity": "product",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "require_shipping": true,
- "price": 30,
- "cost": 25,
- "compare_at_price": 30,
- "tax_code": "non-taxable",
- "weight": 1,
- "tax_exempt": true,
- "option_values": [
- {
- "id": 5,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_variant_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "label": "Small",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z"
}
], - "localized_names": {
- "en": "Purple",
- "fr": "Violette"
}
}
]
}
Get Product Variant by Platform ID
Retrieves a product variant by its platform-specific identifier.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
bold_product_id required | integer <int64> Example: 123 A unique identifier for the product. Assigned by Bold. |
pid required | string Example: 110 The unique identifier for this product variant. Assigned by the shop platform. |
Responses
Response samples
- 200
- default
{- "data": {
- "id": 789,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Default Title",
- "sku": "BEACH-HAT-PURPLE",
- "weight_unit": "kg",
- "grams": 1000,
- "image_id": 321,
- "image_url": "example.store.com/files/products/hats/purple-beach-hat.jpg",
- "inventory_quantity": 5,
- "allow_backorder": true,
- "inventory_tracking_service": "platform",
- "inventory_tracking_entity": "product",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "require_shipping": true,
- "price": 30,
- "cost": 25,
- "compare_at_price": 30,
- "tax_code": "non-taxable",
- "weight": 1,
- "tax_exempt": true,
- "option_values": [
- {
- "id": 5,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_variant_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "label": "Small",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z"
}
], - "localized_names": {
- "en": "Purple",
- "fr": "Violette"
}
}
}
Get Product Variant by ID
Retrieves a product variant by its Bold-specific identifier.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
bold_product_id required | integer <int64> Example: 123 A unique identifier for the product. Assigned by Bold. |
id required | integer <int64> Example: 100 The unique identifier for this product variant. Assigned by Bold. |
Responses
Response samples
- 200
- default
{- "data": {
- "id": 789,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Default Title",
- "sku": "BEACH-HAT-PURPLE",
- "weight_unit": "kg",
- "grams": 1000,
- "image_id": 321,
- "image_url": "example.store.com/files/products/hats/purple-beach-hat.jpg",
- "inventory_quantity": 5,
- "allow_backorder": true,
- "inventory_tracking_service": "platform",
- "inventory_tracking_entity": "product",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "require_shipping": true,
- "price": 30,
- "cost": 25,
- "compare_at_price": 30,
- "tax_code": "non-taxable",
- "weight": 1,
- "tax_exempt": true,
- "option_values": [
- {
- "id": 5,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_variant_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "label": "Small",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z"
}
], - "localized_names": {
- "en": "Purple",
- "fr": "Violette"
}
}
}
List Variants for Shop
Lists all product variants in the shop.
For more information on result pagination, refer to the Query & Pagination page.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
query Parameters
filter | Array of strings Example: filter=eq(target:order) A filter for returned results. Accepts filtering options as described in the Query & Pagination page. |
limit | integer <int32> Example: limit=50 The maximum number of results to return per page. |
page | integer <int32> Example: page=1 The desired page number for the paginated results. |
Responses
Response samples
- 200
- default
{- "data": [
- {
- "id": 789,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Default Title",
- "sku": "BEACH-HAT-PURPLE",
- "weight_unit": "kg",
- "grams": 1000,
- "image_id": 321,
- "image_url": "example.store.com/files/products/hats/purple-beach-hat.jpg",
- "inventory_quantity": 5,
- "allow_backorder": true,
- "inventory_tracking_service": "platform",
- "inventory_tracking_entity": "product",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "require_shipping": true,
- "price": 30,
- "cost": 25,
- "compare_at_price": 30,
- "tax_code": "non-taxable",
- "weight": 1,
- "tax_exempt": true,
- "option_values": [
- {
- "id": 5,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_variant_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "label": "Small",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z"
}
], - "localized_names": {
- "en": "Purple",
- "fr": "Violette"
}
}
], - "pagination": {
- "total": 143,
- "count": 143,
- "per_page": 50,
- "current_page": 2,
- "total_pages": 3,
}
}
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
Lists product categories for the shop.
For more information on result pagination, refer to the Query & Pagination page.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
query Parameters
limit | integer <int32> Example: limit=50 The maximum number of results to return per page. |
page | integer <int32> Example: page=1 The desired page number for the paginated results. |
ids | string Example: ids=123,456,789 A comma-separated list of category identifiers, defining which categories to return. |
Responses
Response samples
- 200
- default
{- "pagination": {
- "total": 143,
- "count": 143,
- "per_page": 50,
- "current_page": 2,
- "total_pages": 3,
}, - "data": [
- {
- "id": 100,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Hats",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "image_url": "example.store.com/files/categories/hats.jpg"
}
]
}
Get Category by Platform ID
Retrieves a product category by its platform-assigned identifier.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
pid required | string Example: 110 The unique identifier for the category. Assigned by the shop platform. |
Responses
Response samples
- 200
- default
{- "data": {
- "id": 100,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Hats",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "image_url": "example.store.com/files/categories/hats.jpg"
}
}
Get Category by ID
Retrieves a product category by its Bold-assigned identifier.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
id required | integer <int64> Example: 100 The unique identifier for this category. Assigned by Bold. |
Responses
Response samples
- 200
- default
{- "data": {
- "id": 100,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Hats",
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "image_url": "example.store.com/files/categories/hats.jpg"
}
}
List Product Categories
Lists product categories for the shop.
For more information on result pagination, refer to the Query & Pagination page.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
query Parameters
limit | integer <int32> Example: limit=50 The maximum number of results to return per page. |
page | integer <int32> Example: page=1 The desired page number for the paginated results. |
filter | Array of strings Example: filter=eq(target:order) A filter for returned results. Accepts filtering options as described in the Query & Pagination page. |
Responses
Response samples
- 200
- default
{- "data": [
- {
- "id": 10,
- "shop_identifier": "zp3oafdor9",
- "platform_category_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z"
}
], - "pagination": {
- "total": 143,
- "count": 143,
- "per_page": 50,
- "current_page": 2,
- "total_pages": 3,
}
}
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
Lists images for a product by its Bold-specific identifier.
For more information on result pagination, refer to the Query & Pagination page.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
bold_product_id required | integer <int64> Example: 123 A unique identifier for the product. Assigned by Bold. |
query Parameters
limit | integer <int32> Example: limit=50 The maximum number of results to return per page. |
page | integer <int32> Example: page=1 The desired page number for the paginated results. |
Responses
Response samples
- 200
- default
{- "pagination": {
- "total": 143,
- "count": 143,
- "per_page": 50,
- "current_page": 2,
- "total_pages": 3,
}, - "data": [
- {
- "id": 456,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z"
}
]
}
Get Product Image by Platform ID
Retrieves a product image by its platform-assigned identifier.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
bold_product_id required | integer <int64> Example: 123 A unique identifier for the product. Assigned by Bold. |
pid required | string Example: 456 A unique identifier for the product. Assigned by the shop platform. |
Responses
Response samples
- 200
- default
{- "data": {
- "id": 456,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z"
}
}
Get Product Image by ID
Retrieves a product image by its Bold-assigned identifier.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
bold_product_id required | integer <int64> Example: 123 A unique identifier for the product. Assigned by Bold. |
id required | integer <int64> Example: 456 A unique identifier for the product image. Assigned by Bold. |
Responses
Response samples
- 200
- default
{- "data": {
- "id": 456,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z"
}
}
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
Lists the options for a product by its Bold-specific identifier.
For more information on result pagination, refer to the Query & Pagination page.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
bold_product_id required | integer <int64> Example: 123 A unique identifier for the product. Assigned by Bold. |
query Parameters
limit | integer <int32> Example: limit=50 The maximum number of results to return per page. |
page | integer <int32> Example: page=1 The desired page number for the paginated results. |
Responses
Response samples
- 200
- default
{- "pagination": {
- "total": 143,
- "count": 143,
- "per_page": 50,
- "current_page": 2,
- "total_pages": 3,
}, - "data": [
- {
- "id": 900,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Small",
- "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "values": [
- {
- "shop_identifier": "zp3oafdor9",
- "label": "Small",
- "is_default": true,
- "id": 143,
- "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}
}
]
}
]
}
Get Product Option by Platform ID
Retrieves a product option by the platform-specific option identifier.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
bold_product_id required | integer <int64> Example: 123 A unique identifier for the product. Assigned by Bold. |
pid required | string Example: 110 A unique identifier for this product option. Assigned by the shop platform. |
Responses
Response samples
- 200
- default
{- "data": {
- "id": 900,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Small",
- "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "values": [
- {
- "shop_identifier": "zp3oafdor9",
- "label": "Small",
- "is_default": true,
- "id": 143,
- "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}
}
]
}
}
Get Product Option by ID
Retrieves a product option by the Bold-specific option identifier.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
bold_product_id required | integer <int64> Example: 123 A unique identifier for the product. Assigned by Bold. |
id required | integer <int64> Example: 100 The unique identifier for the product option. Assigned by Bold. |
Responses
Response samples
- 200
- default
{- "data": {
- "id": 900,
- "shop_identifier": "zp3oafdor9",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "name": "Small",
- "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "values": [
- {
- "shop_identifier": "zp3oafdor9",
- "label": "Small",
- "is_default": true,
- "id": 143,
- "position": 1,
- "created_at": "2021-11-04T19:09:52Z",
- "updated_at": "2021-11-04T19:09:52Z",
- "platform_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}, - "platform_product_option_id": {
- "string_value": "platform-123",
- "int64_value": 123456
}
}
]
}
}