NAV
Subscribe to developer updates

v3 API Reference

Terms of service

v3 Base URL: https://api.bigcommerce.com/stores/{{store_id}}/v3

Catalog

getProducts

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products', headers=headers)

print r.json()

GET /catalog/products

Returns a paginated collection of Product objects from the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
id query integer false Filter items by id.
name query string false Filter items by name.
sku query string false Filter items by sku.
upc query string false Filter items by upc.
price query number false Filter items by price.
weight query number false Filter items by weight.
condition query integer false Filter items by condition.
brand_id query integer false Filter items by brand_id.
date_modified query string false Filter items by date_modified.
date_last_imported query string false Filter items by date_last_imported.
is_visible query integer false Filter items by is_visible.
is_featured query integer false Filter items by is_featured.
is_free_shipping query integer false Filter items by is_free_shipping.
inventory_level query integer false Filter items by inventory_level.
inventory_low query integer false Filter items by inventory_low; values: 1, 0.
out_of_stock query integer false Filter items by out_of_stock. To enable the filter, pass out_of_stock=1.
total_sold query integer false Filter items by total_sold.
type query string false Filter items by type: physical or digital.
categories query integer false Filter items by categories. (NOTE: To ensure that your request will retrieve products that are also cross-listed in additional categories beyond the categories you’ve specified, use the syntax: categories:in=.)
keyword query string false Filter items by keywords found in the name, description, or sku fields, or in the brand name.
keyword_context query string false Set context for a product search.
channel_id query integer false Filter items by channel.
status query integer false Filter items by status.
include query string false Sub-resources to include on a product, in a comma-separated list. Valid expansions currently include variants, images, custom_fields, and bulk_pricing_rules.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
availability query string false Filter items by availability. Acceptable values are: available, disabled, preorder.
page query integer false Specifies the page number in a limited (paginated) list of products.
limit query integer false Controls the number of items per page in a limited (paginated) list of products.
direction query string false Sort direction. Acceptable values are: asc, desc.
sort query string false Field name to sort by.

Enumerated Values

Parameter Value
keyword_context shopper
keyword_context merchant
include variants
include images
include custom_fields
include bulk_pricing_rules
availability available
availability disabled
availability preorder
direction asc
direction desc
sort id
sort name
sort sku
sort price
sort date_modified
sort date_last_imported
sort channel_count
sort inventory_level
sort is_visible
sort total_sold

Responses

Status Meaning Description
200 OK An array of products and metadata.

Example responses

{
  "data": [
    {
      "name": "string",
      "type": "physical",
      "sku": "string",
      "description": "string",
      "weight": 0,
      "width": 0,
      "depth": 0,
      "height": 0,
      "price": 0,
      "cost_price": 0,
      "retail_price": 0,
      "sale_price": 0,
      "tax_class_id": 0,
      "product_tax_code": "string",
      "categories": [
        0
      ],
      "brand_id": 0,
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "inventory_tracking": "none",
      "fixed_cost_shipping_price": 0,
      "is_free_shipping": true,
      "is_visible": true,
      "is_featured": true,
      "related_products": [
        0
      ],
      "warranty": "string",
      "bin_picking_number": "string",
      "layout_file": "string",
      "upc": "string",
      "search_keywords": "string",
      "availability": "available",
      "availability_description": "string",
      "gift_wrapping_options_type": "any",
      "gift_wrapping_options_list": [
        0
      ],
      "sort_order": -2147483648,
      "condition": "New",
      "is_condition_shown": true,
      "order_quantity_minimum": 0,
      "order_quantity_maximum": 0,
      "page_title": "string",
      "meta_keywords": [
        "string"
      ],
      "meta_description": "string",
      "view_count": 0,
      "preorder_release_date": "2017-03-24T23:49:18Z",
      "preorder_message": "string",
      "is_preorder_only": true,
      "is_price_hidden": true,
      "price_hidden_label": "string",
      "custom_url": {
        "url": "string",
        "is_customized": true
      },
      "id": 0,
      "calculated_price": 0,
      "custom_fields": [
        {
          "name": "string",
          "value": "string",
          "id": 1
        }
      ],
      "bulk_pricing_rules": [
        {
          "quantity_min": 0,
          "quantity_max": 0,
          "type": "price",
          "amount": 0,
          "id": 1
        }
      ],
      "date_created": "2017-03-24T23:49:18Z",
      "date_modified": "2017-03-24T23:49:18Z",
      "images": [
        {
          "is_thumbnail": true,
          "sort_order": -2147483648,
          "description": "string",
          "id": 0,
          "product_id": 0,
          "image_file": "string",
          "url_zoom": "string",
          "url_standard": "string",
          "url_thumbnail": "string",
          "url_tiny": "string",
          "date_modified": "2017-03-24T23:49:18Z"
        }
      ],
      "videos": [
        {
          "title": "string",
          "description": "string",
          "sort_order": -2147483648,
          "id": "string",
          "product_id": 0,
          "length": "string"
        }
      ],
      "variants": [
        {
          "cost_price": 0,
          "price": 0,
          "weight": 0,
          "purchasing_disabled": true,
          "purchasing_disabled_message": "string",
          "image_url": "string",
          "upc": "string",
          "inventory_level": 0,
          "inventory_warning_level": 0,
          "bin_picking_number": "string",
          "id": 0,
          "product_id": 0,
          "sku": "string",
          "sku_id": 0,
          "option_values": [
            {
              "option_display_name": "string",
              "label": "string",
              "id": 0,
              "option_id": 0
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

createProduct

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/products

Creates a Product in the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
product body ProductPost true A BigCommerce Product object.

Body parameter

{
  "name": "string",
  "type": "physical",
  "sku": "string",
  "description": "string",
  "weight": 0,
  "width": 0,
  "depth": 0,
  "height": 0,
  "price": 0,
  "cost_price": 0,
  "retail_price": 0,
  "sale_price": 0,
  "tax_class_id": 0,
  "product_tax_code": "string",
  "categories": [
    0
  ],
  "brand_id": 0,
  "inventory_level": 0,
  "inventory_warning_level": 0,
  "inventory_tracking": "none",
  "fixed_cost_shipping_price": 0,
  "is_free_shipping": true,
  "is_visible": true,
  "is_featured": true,
  "related_products": [
    0
  ],
  "warranty": "string",
  "bin_picking_number": "string",
  "layout_file": "string",
  "upc": "string",
  "search_keywords": "string",
  "availability": "available",
  "availability_description": "string",
  "gift_wrapping_options_type": "any",
  "gift_wrapping_options_list": [
    0
  ],
  "sort_order": -2147483648,
  "condition": "New",
  "is_condition_shown": true,
  "order_quantity_minimum": 0,
  "order_quantity_maximum": 0,
  "page_title": "string",
  "meta_keywords": [
    "string"
  ],
  "meta_description": "string",
  "view_count": 0,
  "preorder_release_date": "2017-03-24T23:49:18Z",
  "preorder_message": "string",
  "is_preorder_only": true,
  "is_price_hidden": true,
  "price_hidden_label": "string",
  "custom_url": {
    "url": "string",
    "is_customized": true
  },
  "custom_fields": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "bulk_pricing_rules": [
    {
      "quantity_min": 0,
      "quantity_max": 0,
      "type": "price",
      "amount": 0
    }
  ],
  "variants": [
    {
      "cost_price": 0,
      "price": 0,
      "weight": 0,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "image_url": "string",
      "upc": "string",
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "bin_picking_number": "string",
      "product_id": 0,
      "sku": "string",
      "option_values": [
        {
          "option_display_name": "string",
          "label": "string"
        }
      ]
    }
  ]
}

Responses

Status Meaning Description
200 OK A Product.
409 Conflict Product was in conflict with another product. This is the result of duplicate unique values, such as name or SKU; a missing or invalid category id, brand id, or tax_class id; or a conflicting bulk_pricing_rule.
422 Unprocessable Entity Product was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "name": "string",
    "type": "physical",
    "sku": "string",
    "description": "string",
    "weight": 0,
    "width": 0,
    "depth": 0,
    "height": 0,
    "price": 0,
    "cost_price": 0,
    "retail_price": 0,
    "sale_price": 0,
    "tax_class_id": 0,
    "product_tax_code": "string",
    "categories": [
      0
    ],
    "brand_id": 0,
    "inventory_level": 0,
    "inventory_warning_level": 0,
    "inventory_tracking": "none",
    "fixed_cost_shipping_price": 0,
    "is_free_shipping": true,
    "is_visible": true,
    "is_featured": true,
    "related_products": [
      0
    ],
    "warranty": "string",
    "bin_picking_number": "string",
    "layout_file": "string",
    "upc": "string",
    "search_keywords": "string",
    "availability": "available",
    "availability_description": "string",
    "gift_wrapping_options_type": "any",
    "gift_wrapping_options_list": [
      0
    ],
    "sort_order": -2147483648,
    "condition": "New",
    "is_condition_shown": true,
    "order_quantity_minimum": 0,
    "order_quantity_maximum": 0,
    "page_title": "string",
    "meta_keywords": [
      "string"
    ],
    "meta_description": "string",
    "view_count": 0,
    "preorder_release_date": "2017-03-24T23:49:18Z",
    "preorder_message": "string",
    "is_preorder_only": true,
    "is_price_hidden": true,
    "price_hidden_label": "string",
    "custom_url": {
      "url": "string",
      "is_customized": true
    },
    "id": 0,
    "calculated_price": 0,
    "custom_fields": [
      {
        "name": "string",
        "value": "string",
        "id": 1
      }
    ],
    "bulk_pricing_rules": [
      {
        "quantity_min": 0,
        "quantity_max": 0,
        "type": "price",
        "amount": 0,
        "id": 1
      }
    ],
    "date_created": "2017-03-24T23:49:18Z",
    "date_modified": "2017-03-24T23:49:18Z",
    "images": [
      {
        "is_thumbnail": true,
        "sort_order": -2147483648,
        "description": "string",
        "id": 0,
        "product_id": 0,
        "image_file": "string",
        "url_zoom": "string",
        "url_standard": "string",
        "url_thumbnail": "string",
        "url_tiny": "string",
        "date_modified": "2017-03-24T23:49:18Z"
      }
    ],
    "videos": [
      {
        "title": "string",
        "description": "string",
        "sort_order": -2147483648,
        "id": "string",
        "product_id": 0,
        "length": "string"
      }
    ],
    "variants": [
      {
        "cost_price": 0,
        "price": 0,
        "weight": 0,
        "purchasing_disabled": true,
        "purchasing_disabled_message": "string",
        "image_url": "string",
        "upc": "string",
        "inventory_level": 0,
        "inventory_warning_level": 0,
        "bin_picking_number": "string",
        "id": 0,
        "product_id": 0,
        "sku": "string",
        "sku_id": 0,
        "option_values": [
          {
            "option_display_name": "string",
            "label": "string",
            "id": 0,
            "option_id": 0
          }
        ]
      }
    ]
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteProducts

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products', headers=headers)

print r.json()

DELETE /catalog/products

Deletes one or more Product objects from the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
name query string false Filter items by name.
sku query string false Filter items by sku.
price query number false Filter items by price.
weight query number false Filter items by weight.
condition query integer false Filter items by condition.
brand_id query integer false Filter items by brand_id.
date_modified query string false Filter items by date_modified.
date_last_imported query string false Filter items by date_last_imported.
is_visible query integer false Filter items by is_visible.
is_featured query integer false Filter items by is_featured.
inventory_level query integer false Filter items by inventory_level.
total_sold query integer false Filter items by total_sold.
type query string false Filter items by type: physical or digital.
categories query integer false Filter items by categories.
keyword query string false Filter items by keywords found in the name, description, or sku fields, or in the brand name.

Responses

Status Meaning Description
204 No Content An empty response.

getProductById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}', headers=headers)

print r.json()

GET /catalog/products/{product_id}

Returns a Product from the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
include query string false Sub-resources to include on a product, in a comma-separated list. Valid expansions currently include variants, images, custom_fields, and bulk_pricing_rules.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Enumerated Values

Parameter Value
include variants
include images
include custom_fields
include bulk_pricing_rules

Responses

Status Meaning Description
200 OK A product.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "name": "string",
    "type": "physical",
    "sku": "string",
    "description": "string",
    "weight": 0,
    "width": 0,
    "depth": 0,
    "height": 0,
    "price": 0,
    "cost_price": 0,
    "retail_price": 0,
    "sale_price": 0,
    "tax_class_id": 0,
    "product_tax_code": "string",
    "categories": [
      0
    ],
    "brand_id": 0,
    "inventory_level": 0,
    "inventory_warning_level": 0,
    "inventory_tracking": "none",
    "fixed_cost_shipping_price": 0,
    "is_free_shipping": true,
    "is_visible": true,
    "is_featured": true,
    "related_products": [
      0
    ],
    "warranty": "string",
    "bin_picking_number": "string",
    "layout_file": "string",
    "upc": "string",
    "search_keywords": "string",
    "availability": "available",
    "availability_description": "string",
    "gift_wrapping_options_type": "any",
    "gift_wrapping_options_list": [
      0
    ],
    "sort_order": -2147483648,
    "condition": "New",
    "is_condition_shown": true,
    "order_quantity_minimum": 0,
    "order_quantity_maximum": 0,
    "page_title": "string",
    "meta_keywords": [
      "string"
    ],
    "meta_description": "string",
    "view_count": 0,
    "preorder_release_date": "2017-03-24T23:49:18Z",
    "preorder_message": "string",
    "is_preorder_only": true,
    "is_price_hidden": true,
    "price_hidden_label": "string",
    "custom_url": {
      "url": "string",
      "is_customized": true
    },
    "id": 0,
    "calculated_price": 0,
    "custom_fields": [
      {
        "name": "string",
        "value": "string",
        "id": 1
      }
    ],
    "bulk_pricing_rules": [
      {
        "quantity_min": 0,
        "quantity_max": 0,
        "type": "price",
        "amount": 0,
        "id": 1
      }
    ],
    "date_created": "2017-03-24T23:49:18Z",
    "date_modified": "2017-03-24T23:49:18Z",
    "images": [
      {
        "is_thumbnail": true,
        "sort_order": -2147483648,
        "description": "string",
        "id": 0,
        "product_id": 0,
        "image_file": "string",
        "url_zoom": "string",
        "url_standard": "string",
        "url_thumbnail": "string",
        "url_tiny": "string",
        "date_modified": "2017-03-24T23:49:18Z"
      }
    ],
    "videos": [
      {
        "title": "string",
        "description": "string",
        "sort_order": -2147483648,
        "id": "string",
        "product_id": 0,
        "length": "string"
      }
    ],
    "variants": [
      {
        "cost_price": 0,
        "price": 0,
        "weight": 0,
        "purchasing_disabled": true,
        "purchasing_disabled_message": "string",
        "image_url": "string",
        "upc": "string",
        "inventory_level": 0,
        "inventory_warning_level": 0,
        "bin_picking_number": "string",
        "id": 0,
        "product_id": 0,
        "sku": "string",
        "sku_id": 0,
        "option_values": [
          {
            "option_display_name": "string",
            "label": "string",
            "id": 0,
            "option_id": 0
          }
        ]
      }
    ]
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateProduct

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /catalog/products/{product_id}

Updates a Product in the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
product body ProductPut true A BigCommerce Product object.

Body parameter

{
  "name": "string",
  "type": "physical",
  "sku": "string",
  "description": "string",
  "weight": 0,
  "width": 0,
  "depth": 0,
  "height": 0,
  "price": 0,
  "cost_price": 0,
  "retail_price": 0,
  "sale_price": 0,
  "tax_class_id": 0,
  "product_tax_code": "string",
  "categories": [
    0
  ],
  "brand_id": 0,
  "inventory_level": 0,
  "inventory_warning_level": 0,
  "inventory_tracking": "none",
  "fixed_cost_shipping_price": 0,
  "is_free_shipping": true,
  "is_visible": true,
  "is_featured": true,
  "related_products": [
    0
  ],
  "warranty": "string",
  "bin_picking_number": "string",
  "layout_file": "string",
  "upc": "string",
  "search_keywords": "string",
  "availability": "available",
  "availability_description": "string",
  "gift_wrapping_options_type": "any",
  "gift_wrapping_options_list": [
    0
  ],
  "sort_order": -2147483648,
  "condition": "New",
  "is_condition_shown": true,
  "order_quantity_minimum": 0,
  "order_quantity_maximum": 0,
  "page_title": "string",
  "meta_keywords": [
    "string"
  ],
  "meta_description": "string",
  "view_count": 0,
  "preorder_release_date": "2017-03-24T23:49:18Z",
  "preorder_message": "string",
  "is_preorder_only": true,
  "is_price_hidden": true,
  "price_hidden_label": "string",
  "custom_url": {
    "url": "string",
    "is_customized": true
  },
  "id": 0,
  "custom_fields": [
    {
      "name": "string",
      "value": "string",
      "id": 1
    }
  ],
  "bulk_pricing_rules": [
    {
      "quantity_min": 0,
      "quantity_max": 0,
      "type": "price",
      "amount": 0,
      "id": 1
    }
  ],
  "variants": [
    {
      "cost_price": 0,
      "price": 0,
      "weight": 0,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "image_url": "string",
      "upc": "string",
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "bin_picking_number": "string",
      "product_id": 0,
      "sku": "string"
    }
  ]
}

Responses

Status Meaning Description
200 OK A Product.
404 Not Found The resource was not found.
409 Conflict Product was in conflict with another product. This is caused by: duplicate unique values, such as name or SKU; a missing category, brand, or tax_class with which the product is being associated; or a conflicting bulk pricing rule.
422 Unprocessable Entity Product was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "name": "string",
    "type": "physical",
    "sku": "string",
    "description": "string",
    "weight": 0,
    "width": 0,
    "depth": 0,
    "height": 0,
    "price": 0,
    "cost_price": 0,
    "retail_price": 0,
    "sale_price": 0,
    "tax_class_id": 0,
    "product_tax_code": "string",
    "categories": [
      0
    ],
    "brand_id": 0,
    "inventory_level": 0,
    "inventory_warning_level": 0,
    "inventory_tracking": "none",
    "fixed_cost_shipping_price": 0,
    "is_free_shipping": true,
    "is_visible": true,
    "is_featured": true,
    "related_products": [
      0
    ],
    "warranty": "string",
    "bin_picking_number": "string",
    "layout_file": "string",
    "upc": "string",
    "search_keywords": "string",
    "availability": "available",
    "availability_description": "string",
    "gift_wrapping_options_type": "any",
    "gift_wrapping_options_list": [
      0
    ],
    "sort_order": -2147483648,
    "condition": "New",
    "is_condition_shown": true,
    "order_quantity_minimum": 0,
    "order_quantity_maximum": 0,
    "page_title": "string",
    "meta_keywords": [
      "string"
    ],
    "meta_description": "string",
    "view_count": 0,
    "preorder_release_date": "2017-03-24T23:49:18Z",
    "preorder_message": "string",
    "is_preorder_only": true,
    "is_price_hidden": true,
    "price_hidden_label": "string",
    "custom_url": {
      "url": "string",
      "is_customized": true
    },
    "id": 0,
    "calculated_price": 0,
    "custom_fields": [
      {
        "name": "string",
        "value": "string",
        "id": 1
      }
    ],
    "bulk_pricing_rules": [
      {
        "quantity_min": 0,
        "quantity_max": 0,
        "type": "price",
        "amount": 0,
        "id": 1
      }
    ],
    "date_created": "2017-03-24T23:49:18Z",
    "date_modified": "2017-03-24T23:49:18Z",
    "images": [
      {
        "is_thumbnail": true,
        "sort_order": -2147483648,
        "description": "string",
        "id": 0,
        "product_id": 0,
        "image_file": "string",
        "url_zoom": "string",
        "url_standard": "string",
        "url_thumbnail": "string",
        "url_tiny": "string",
        "date_modified": "2017-03-24T23:49:18Z"
      }
    ],
    "videos": [
      {
        "title": "string",
        "description": "string",
        "sort_order": -2147483648,
        "id": "string",
        "product_id": 0,
        "length": "string"
      }
    ],
    "variants": [
      {
        "cost_price": 0,
        "price": 0,
        "weight": 0,
        "purchasing_disabled": true,
        "purchasing_disabled_message": "string",
        "image_url": "string",
        "upc": "string",
        "inventory_level": 0,
        "inventory_warning_level": 0,
        "bin_picking_number": "string",
        "id": 0,
        "product_id": 0,
        "sku": "string",
        "sku_id": 0,
        "option_values": [
          {
            "option_display_name": "string",
            "label": "string",
            "id": 0,
            "option_id": 0
          }
        ]
      }
    ]
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteProductById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}', headers=headers)

print r.json()

DELETE /catalog/products/{product_id}

Deletes a Product object from the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.

Responses

Status Meaning Description
204 No Content An empty response.

getProductImages

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/images', headers=headers)

print r.json()

GET /catalog/products/{product_id}/images

Gets all images on a product.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK List of product images and metadata.
204 No Content There are not any images on this product.
404 Not Found The product ID does not exist.

Example responses

{
  "data": [
    {
      "is_thumbnail": true,
      "sort_order": -2147483648,
      "description": "string",
      "id": 0,
      "product_id": 0,
      "image_file": "string",
      "url_zoom": "string",
      "url_standard": "string",
      "url_thumbnail": "string",
      "url_tiny": "string",
      "date_modified": "2017-03-24T23:49:18Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

createProductImage

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/images', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/products/{product_id}/images

Creates an image on a product. Publically accessible URLs and files (form post) are valid parameters.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
productImage body ProductImagePost true A BigCommerce ProductImage object.

Body parameter

{
  "is_thumbnail": true,
  "sort_order": -2147483648,
  "description": "string",
  "image_url": "string",
  "image_file": "string"
}

Responses

Status Meaning Description
200 OK A product image.
404 Not Found The product ID does not exist.

Example responses

{
  "data": {
    "is_thumbnail": true,
    "sort_order": -2147483648,
    "description": "string",
    "id": 0,
    "product_id": 0,
    "image_file": "string",
    "url_zoom": "string",
    "url_standard": "string",
    "url_thumbnail": "string",
    "url_tiny": "string",
    "date_modified": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

getProductImageById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/images/{image_id}', headers=headers)

print r.json()

GET /catalog/products/{product_id}/images/{image_id}

Gets an image on a product.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
image_id path integer true The ID of the Image that is being operated on.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An array of product images and metadata.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "is_thumbnail": true,
    "sort_order": -2147483648,
    "description": "string",
    "id": 0,
    "product_id": 0,
    "image_file": "string",
    "url_zoom": "string",
    "url_standard": "string",
    "url_thumbnail": "string",
    "url_tiny": "string",
    "date_modified": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateProductImage

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/images/{image_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /catalog/products/{product_id}/images/{image_id}

Updates an image on a product. Publicly accessible URLs and files (form post) are valid parameters.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
image_id path integer true The ID of the Image that is being operated on.
productImage body ProductImagePut true A BigCommerce ProductImage object.

Body parameter

{
  "is_thumbnail": true,
  "sort_order": -2147483648,
  "description": "string"
}

Responses

Status Meaning Description
200 OK A product image.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "is_thumbnail": true,
    "sort_order": -2147483648,
    "description": "string",
    "id": 0,
    "product_id": 0,
    "image_file": "string",
    "url_zoom": "string",
    "url_standard": "string",
    "url_thumbnail": "string",
    "url_tiny": "string",
    "date_modified": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

deleteProductImage

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/images/{image_id}', headers=headers)

print r.json()

DELETE /catalog/products/{product_id}/images/{image_id}

Deletes a ProductImage in the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
image_id path integer true The ID of the Image that is being operated on.

Responses

Status Meaning Description
204 No Content An empty response.

getProductVideos

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/videos', headers=headers)

print r.json()

GET /catalog/products/{product_id}/videos

Gets all videos on a product.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK List of product videos and metadata.

Example responses

{
  "data": [
    {
      "title": "string",
      "description": "string",
      "sort_order": -2147483648,
      "id": "string",
      "product_id": 0,
      "length": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

createProductVideo

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/videos', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/products/{product_id}/videos

Creates a video on a product, using a video ID from YouTube.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
productVideo body ProductVideoPost true A BigCommerce ProductVideo object.

Body parameter

{
  "title": "string",
  "description": "string",
  "sort_order": -2147483648,
  "id": "string",
  "product_id": 0
}

Responses

Status Meaning Description
200 OK A product video.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "title": "string",
    "description": "string",
    "sort_order": -2147483648,
    "id": "string",
    "product_id": 0,
    "length": "string"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

getProductVideoById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/videos/{video_id}', headers=headers)

print r.json()

GET /catalog/products/{product_id}/videos/{video_id}

Gets video on a product.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
video_id path string true The ID of the Video being operated on.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An array of product videos and metadata.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "title": "string",
    "description": "string",
    "sort_order": -2147483648,
    "id": "string",
    "product_id": 0,
    "length": "string"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateProductVideo

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/videos/{video_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /catalog/products/{product_id}/videos/{video_id}

Updates a video on a product.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
video_id path string true The ID of the Video being operated on.
productVideo body ProductVideoPut true A BigCommerce ProductVideo object.

Body parameter

{
  "title": "string",
  "description": "string",
  "sort_order": -2147483648
}

Responses

Status Meaning Description
200 OK A product video.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "title": "string",
    "description": "string",
    "sort_order": -2147483648,
    "id": "string",
    "product_id": 0,
    "length": "string"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

deleteProductVideo

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/videos/{video_id}', headers=headers)

print r.json()

DELETE /catalog/products/{product_id}/videos/{video_id}

Deletes a ProductVideo in the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
video_id path string true The ID of the Video being operated on.

Responses

Status Meaning Description
204 No Content An empty response.

getVariantsByProductId

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/variants', headers=headers)

print r.json()

GET /catalog/products/{product_id}/variants

Returns a Variant object list from the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
page query integer false Specifies the page number in a limited (paginated) list of products.
limit query integer false Controls the number of items per page in a limited (paginated) list of products.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An array of variants and metadata.
404 Not Found The resource was not found.

Example responses

{
  "data": [
    {
      "cost_price": 0,
      "price": 0,
      "weight": 0,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "image_url": "string",
      "upc": "string",
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "bin_picking_number": "string",
      "id": 0,
      "product_id": 0,
      "sku": "string",
      "sku_id": 0,
      "option_values": [
        {
          "option_display_name": "string",
          "label": "string",
          "id": 0,
          "option_id": 0
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

createVariant

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/variants', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/products/{product_id}/variants

Creates a Variant object.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
Variant body VariantPost true A Variant object.

Body parameter

{
  "cost_price": 0,
  "price": 0,
  "weight": 0,
  "purchasing_disabled": true,
  "purchasing_disabled_message": "string",
  "image_url": "string",
  "upc": "string",
  "inventory_level": 0,
  "inventory_warning_level": 0,
  "bin_picking_number": "string",
  "product_id": 0,
  "sku": "string",
  "option_values": [
    {
      "id": 0,
      "option_id": 0
    }
  ]
}

Responses

Status Meaning Description
200 OK A variant and metadata.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "cost_price": 0,
    "price": 0,
    "weight": 0,
    "purchasing_disabled": true,
    "purchasing_disabled_message": "string",
    "image_url": "string",
    "upc": "string",
    "inventory_level": 0,
    "inventory_warning_level": 0,
    "bin_picking_number": "string",
    "id": 0,
    "product_id": 0,
    "sku": "string",
    "sku_id": 0,
    "option_values": [
      {
        "option_display_name": "string",
        "label": "string",
        "id": 0,
        "option_id": 0
      }
    ]
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

getVariantById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/variants/{variant_id}', headers=headers)

print r.json()

GET /catalog/products/{product_id}/variants/{variant_id}

Gets a Variant object.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
variant_id path number true The ID of the Variant to which the resource belongs.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK A variant and metadata.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "cost_price": 0,
    "price": 0,
    "weight": 0,
    "purchasing_disabled": true,
    "purchasing_disabled_message": "string",
    "image_url": "string",
    "upc": "string",
    "inventory_level": 0,
    "inventory_warning_level": 0,
    "bin_picking_number": "string",
    "id": 0,
    "product_id": 0,
    "sku": "string",
    "sku_id": 0,
    "option_values": [
      {
        "option_display_name": "string",
        "label": "string",
        "id": 0,
        "option_id": 0
      }
    ]
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateVariant

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/variants/{variant_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /catalog/products/{product_id}/variants/{variant_id}

Updates a Variant object.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
variant_id path number true The ID of the Variant to which the resource belongs.
Variant body VariantPut true A Variant object.

Body parameter

{
  "cost_price": 0,
  "price": 0,
  "weight": 0,
  "purchasing_disabled": true,
  "purchasing_disabled_message": "string",
  "image_url": "string",
  "upc": "string",
  "inventory_level": 0,
  "inventory_warning_level": 0,
  "bin_picking_number": "string",
  "id": 0
}

Responses

Status Meaning Description
200 OK A variant and metadata.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "cost_price": 0,
    "price": 0,
    "weight": 0,
    "purchasing_disabled": true,
    "purchasing_disabled_message": "string",
    "image_url": "string",
    "upc": "string",
    "inventory_level": 0,
    "inventory_warning_level": 0,
    "bin_picking_number": "string",
    "id": 0,
    "product_id": 0,
    "sku": "string",
    "sku_id": 0,
    "option_values": [
      {
        "option_display_name": "string",
        "label": "string",
        "id": 0,
        "option_id": 0
      }
    ]
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

deleteVariantById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/variants/{variant_id}', headers=headers)

print r.json()

DELETE /catalog/products/{product_id}/variants/{variant_id}

Deletes a Variant.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
variant_id path number true The ID of the Variant to which the resource belongs.

Responses

Status Meaning Description
204 No Content An empty response.

getVariantMetafieldsByProductIdAndVariantId

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/variants/{variant_id}/metafields', headers=headers)

print r.json()

GET /catalog/products/{product_id}/variants/{variant_id}/metafields

Gets a Metafield object list, by product_id and variant_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
variant_id path number true The ID of the Variant to which the resource belongs.
page query integer false Specifies the page number in a limited (paginated) list of products.
limit query integer false Controls the number of items per page in a limited (paginated) list of products.
key query string false Filter based on a metafield’s key.
namespace query string false Filter based on a metafield’s key.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An array of metafields and metadata.
404 Not Found The resource was not found.

Example responses

{
  "data": [
    {
      "permission_set": "app_only",
      "namespace": "string",
      "key": "string",
      "value": "string",
      "description": "string",
      "resource_type": "category",
      "resource_id": 0,
      "id": 0,
      "created_at": "2017-03-24T23:49:18Z",
      "updated_at": "2017-03-24T23:49:18Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

createVariantMetafield

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/variants/{variant_id}/metafields', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/products/{product_id}/variants/{variant_id}/metafields

Creates a variant Metafield.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
variant_id path number true The ID of the Variant to which the resource belongs.
Metafield body MetafieldPost true A Metafield object.

Body parameter

{
  "permission_set": "app_only",
  "namespace": "string",
  "key": "string",
  "value": "string",
  "description": "string",
  "resource_type": "category",
  "resource_id": 0
}

Responses

Status Meaning Description
200 OK A Metafield object.
409 Conflict The Metafield was in conflict with another Metafield. This can be caused by duplicate unique-key combinations of the app’s client id, namespace, key, resource_type, and resource_id.
422 Unprocessable Entity The Metafield was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "permission_set": "app_only",
    "namespace": "string",
    "key": "string",
    "value": "string",
    "description": "string",
    "resource_type": "category",
    "resource_id": 0,
    "id": 0,
    "created_at": "2017-03-24T23:49:18Z",
    "updated_at": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

getVariantMetafieldByProductIdAndVariantId

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/variants/{variant_id}/metafields/{metafield_id}', headers=headers)

print r.json()

GET /catalog/products/{product_id}/variants/{variant_id}/metafields/{metafield_id}

Gets a Metafield, by product_id and variant_id.

Parameters

Parameter In Type Required Description
metafield_id path number true The ID of the Metafield.
product_id path integer true The ID of the Product to which the resource belongs.
variant_id path number true The ID of the Variant to which the resource belongs.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK A Metafield object.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "permission_set": "app_only",
    "namespace": "string",
    "key": "string",
    "value": "string",
    "description": "string",
    "resource_type": "category",
    "resource_id": 0,
    "id": 0,
    "created_at": "2017-03-24T23:49:18Z",
    "updated_at": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateVariantMetafield

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/variants/{variant_id}/metafields/{metafield_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /catalog/products/{product_id}/variants/{variant_id}/metafields/{metafield_id}

Updates a Metafield object.

Parameters

Parameter In Type Required Description
metafield_id path number true The ID of the Metafield.
product_id path integer true The ID of the Product to which the resource belongs.
variant_id path number true The ID of the Variant to which the resource belongs.
Metafield body MetafieldPut true A Metafield object.

Body parameter

{
  "permission_set": "app_only",
  "namespace": "string",
  "key": "string",
  "value": "string",
  "description": "string",
  "resource_type": "category",
  "resource_id": 0,
  "id": 0
}

Responses

Status Meaning Description
200 OK A metafield and metadata.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "permission_set": "app_only",
    "namespace": "string",
    "key": "string",
    "value": "string",
    "description": "string",
    "resource_type": "category",
    "resource_id": 0,
    "id": 0,
    "created_at": "2017-03-24T23:49:18Z",
    "updated_at": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

deleteVariantMetafieldById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/variants/{variant_id}/metafields/{metafield_id}', headers=headers)

print r.json()

DELETE /catalog/products/{product_id}/variants/{variant_id}/metafields/{metafield_id}

Deletes a Metafield.

Parameters

Parameter In Type Required Description
metafield_id path number true The ID of the Metafield.
product_id path integer true The ID of the Product to which the resource belongs.
variant_id path number true The ID of the Variant to which the resource belongs.

Responses

Status Meaning Description
204 No Content An empty response.

createVariantImage

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'multipart/form-data'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/variants/{variant_id}/image', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/products/{product_id}/variants/{variant_id}/image

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
variant_id path number true The ID of the Variant to which the resource belongs.
image_file formData file true An image file. Supported MIME types include GIF, JPEG, and PNG.

Responses

Status Meaning Description
200 OK A ResourceImage and metadata.
404 Not Found The resource was not found.
422 Unprocessable Entity Image was not valid. This is the result of a missing image_file field or an incorrect file type. See the response for more details.

Example responses

{
  "data": {
    "image_url": "string"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

getOptions

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/options', headers=headers)

print r.json()

GET /catalog/products/{product_id}/options

Gets an array of Option objects.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An array of options and metadata.
404 Not Found The resource was not found.

Example responses

{
  "data": [
    {
      "id": 0,
      "product_id": 0,
      "display_name": "string",
      "type": "radio_buttons",
      "config": {
        "default_value": "string",
        "checked_by_default": true,
        "checkbox_label": "string",
        "date_limited": true,
        "date_limit_mode": "earliest",
        "date_earliest_value": "2017-03-24",
        "date_latest_value": "2017-03-24",
        "file_types_mode": "specific",
        "file_types_supported": [
          "string"
        ],
        "file_types_other": [
          "string"
        ],
        "file_max_size": 0,
        "text_characters_limited": true,
        "text_min_length": 0,
        "text_max_length": 0,
        "text_lines_limited": true,
        "text_max_lines": 0,
        "number_limited": true,
        "number_limit_mode": "lowest",
        "number_lowest_value": 0,
        "number_highest_value": 0,
        "number_integers_only": true,
        "product_list_adjusts_inventory": true,
        "product_list_adjusts_pricing": true,
        "product_list_shipping_calc": "none"
      },
      "option_values": [
        {
          "is_default": true,
          "label": "string",
          "sort_order": -2147483648,
          "value_data": {},
          "id": 0
        }
      ],
      "name": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

createOption

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/options', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/products/{product_id}/options

Creates an Option.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
Option body OptionPost true An Option object.

Body parameter

{
  "id": 0,
  "product_id": 0,
  "display_name": "string",
  "type": "radio_buttons",
  "config": {
    "default_value": "string",
    "checked_by_default": true,
    "checkbox_label": "string",
    "date_limited": true,
    "date_limit_mode": "earliest",
    "date_earliest_value": "2017-03-24",
    "date_latest_value": "2017-03-24",
    "file_types_mode": "specific",
    "file_types_supported": [
      "string"
    ],
    "file_types_other": [
      "string"
    ],
    "file_max_size": 0,
    "text_characters_limited": true,
    "text_min_length": 0,
    "text_max_length": 0,
    "text_lines_limited": true,
    "text_max_lines": 0,
    "number_limited": true,
    "number_limit_mode": "lowest",
    "number_lowest_value": 0,
    "number_highest_value": 0,
    "number_integers_only": true,
    "product_list_adjusts_inventory": true,
    "product_list_adjusts_pricing": true,
    "product_list_shipping_calc": "none"
  },
  "option_values": [
    {
      "is_default": true,
      "label": "string",
      "sort_order": -2147483648,
      "value_data": {},
      "id": 0
    }
  ]
}

Responses

Status Meaning Description
200 OK An Option object.
409 Conflict Option was in conflict with another option. This is the result of duplicate unique fields, such as name.
422 Unprocessable Entity Option was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "id": 0,
    "product_id": 0,
    "display_name": "string",
    "type": "radio_buttons",
    "config": {
      "default_value": "string",
      "checked_by_default": true,
      "checkbox_label": "string",
      "date_limited": true,
      "date_limit_mode": "earliest",
      "date_earliest_value": "2017-03-24",
      "date_latest_value": "2017-03-24",
      "file_types_mode": "specific",
      "file_types_supported": [
        "string"
      ],
      "file_types_other": [
        "string"
      ],
      "file_max_size": 0,
      "text_characters_limited": true,
      "text_min_length": 0,
      "text_max_length": 0,
      "text_lines_limited": true,
      "text_max_lines": 0,
      "number_limited": true,
      "number_limit_mode": "lowest",
      "number_lowest_value": 0,
      "number_highest_value": 0,
      "number_integers_only": true,
      "product_list_adjusts_inventory": true,
      "product_list_adjusts_pricing": true,
      "product_list_shipping_calc": "none"
    },
    "option_values": [
      {
        "is_default": true,
        "label": "string",
        "sort_order": -2147483648,
        "value_data": {},
        "id": 0
      }
    ],
    "name": "string"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

getOptionById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/options/{option_id}', headers=headers)

print r.json()

GET /catalog/products/{product_id}/options/{option_id}

Gets Option object by product ID and option id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
option_id path integer true The ID of the Option.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An Option object.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "id": 0,
    "product_id": 0,
    "display_name": "string",
    "type": "radio_buttons",
    "config": {
      "default_value": "string",
      "checked_by_default": true,
      "checkbox_label": "string",
      "date_limited": true,
      "date_limit_mode": "earliest",
      "date_earliest_value": "2017-03-24",
      "date_latest_value": "2017-03-24",
      "file_types_mode": "specific",
      "file_types_supported": [
        "string"
      ],
      "file_types_other": [
        "string"
      ],
      "file_max_size": 0,
      "text_characters_limited": true,
      "text_min_length": 0,
      "text_max_length": 0,
      "text_lines_limited": true,
      "text_max_lines": 0,
      "number_limited": true,
      "number_limit_mode": "lowest",
      "number_lowest_value": 0,
      "number_highest_value": 0,
      "number_integers_only": true,
      "product_list_adjusts_inventory": true,
      "product_list_adjusts_pricing": true,
      "product_list_shipping_calc": "none"
    },
    "option_values": [
      {
        "is_default": true,
        "label": "string",
        "sort_order": -2147483648,
        "value_data": {},
        "id": 0
      }
    ],
    "name": "string"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateOption

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/options/{option_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /catalog/products/{product_id}/options/{option_id}

Updates a Product’s Option, based on the product_id and option_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
option_id path integer true The ID of the Option.
option body OptionPut true A BigCommerce Option object.

Body parameter

{
  "id": 0,
  "product_id": 0,
  "display_name": "string",
  "type": "radio_buttons",
  "config": {
    "default_value": "string",
    "checked_by_default": true,
    "checkbox_label": "string",
    "date_limited": true,
    "date_limit_mode": "earliest",
    "date_earliest_value": "2017-03-24",
    "date_latest_value": "2017-03-24",
    "file_types_mode": "specific",
    "file_types_supported": [
      "string"
    ],
    "file_types_other": [
      "string"
    ],
    "file_max_size": 0,
    "text_characters_limited": true,
    "text_min_length": 0,
    "text_max_length": 0,
    "text_lines_limited": true,
    "text_max_lines": 0,
    "number_limited": true,
    "number_limit_mode": "lowest",
    "number_lowest_value": 0,
    "number_highest_value": 0,
    "number_integers_only": true,
    "product_list_adjusts_inventory": true,
    "product_list_adjusts_pricing": true,
    "product_list_shipping_calc": "none"
  },
  "option_values": [
    {
      "is_default": true,
      "label": "string",
      "sort_order": -2147483648,
      "value_data": {},
      "id": 0
    }
  ]
}

Responses

Status Meaning Description
200 OK An Option object.
409 Conflict The Option was in conflict with another Option. This is the result of duplicate unique fields, such as name.
422 Unprocessable Entity The Option was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "id": 0,
    "product_id": 0,
    "display_name": "string",
    "type": "radio_buttons",
    "config": {
      "default_value": "string",
      "checked_by_default": true,
      "checkbox_label": "string",
      "date_limited": true,
      "date_limit_mode": "earliest",
      "date_earliest_value": "2017-03-24",
      "date_latest_value": "2017-03-24",
      "file_types_mode": "specific",
      "file_types_supported": [
        "string"
      ],
      "file_types_other": [
        "string"
      ],
      "file_max_size": 0,
      "text_characters_limited": true,
      "text_min_length": 0,
      "text_max_length": 0,
      "text_lines_limited": true,
      "text_max_lines": 0,
      "number_limited": true,
      "number_limit_mode": "lowest",
      "number_lowest_value": 0,
      "number_highest_value": 0,
      "number_integers_only": true,
      "product_list_adjusts_inventory": true,
      "product_list_adjusts_pricing": true,
      "product_list_shipping_calc": "none"
    },
    "option_values": [
      {
        "is_default": true,
        "label": "string",
        "sort_order": -2147483648,
        "value_data": {},
        "id": 0
      }
    ],
    "name": "string"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteOptionById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/options/{option_id}', headers=headers)

print r.json()

DELETE /catalog/products/{product_id}/options/{option_id}

Deletes a Product’s Option, based on the product_id and option_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
option_id path integer true The ID of the Option.

Responses

Status Meaning Description
204 No Content An empty response.

getOptionValues

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/options/{option_id}/values', headers=headers)

print r.json()

GET /catalog/products/{product_id}/options/{option_id}/values

Gets an array of OptionValue objects.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
option_id path integer true The ID of the Option.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An array of option values and metadata.

Example responses

{
  "data": [
    {
      "is_default": true,
      "label": "string",
      "sort_order": -2147483648,
      "value_data": {},
      "id": 0
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

createOptionValue

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/options/{option_id}/values', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/products/{product_id}/options/{option_id}/values

Creates a OptionValue.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
option_id path integer true The ID of the Option.
OptionValue body OptionValuePost true An OptionValue object.

Body parameter

{
  "is_default": true,
  "label": "string",
  "sort_order": -2147483648,
  "value_data": {}
}

Responses

Status Meaning Description
200 OK An OptionValue object.
422 Unprocessable Entity The OptionValue was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "is_default": true,
    "label": "string",
    "sort_order": -2147483648,
    "value_data": {},
    "id": 0
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

getOptionValueById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/options/{option_id}/values/{value_id}', headers=headers)

print r.json()

GET /catalog/products/{product_id}/options/{option_id}/values/{value_id}

Gets an OptionValue by product_id, option_id, and value_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
option_id path integer true The ID of the Option.
value_id path integer true The ID of the Modifier/Option Value.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK A OptionValue object.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "is_default": true,
    "label": "string",
    "sort_order": -2147483648,
    "value_data": {},
    "id": 0
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateOptionValue

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/options/{option_id}/values/{value_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /catalog/products/{product_id}/options/{option_id}/values/{value_id}

Updates an Product’s OptionValue, based on the product_id, option_id and value_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
option_id path integer true The ID of the Option.
value_id path integer true The ID of the Modifier/Option Value.
OptionValue body OptionValuePut true A BigCommerce Product object.

Body parameter

{
  "is_default": true,
  "label": "string",
  "sort_order": -2147483648,
  "value_data": {},
  "id": 0
}

Responses

Status Meaning Description
200 OK An OptionValue object.
422 Unprocessable Entity The OptionValue was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "is_default": true,
    "label": "string",
    "sort_order": -2147483648,
    "value_data": {},
    "id": 0
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteOptionValueById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/options/{option_id}/values/{value_id}', headers=headers)

print r.json()

DELETE /catalog/products/{product_id}/options/{option_id}/values/{value_id}

Deletes a Product’s OptionValue, based on the product_id, option_id and value_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
option_id path integer true The ID of the Option.
value_id path integer true The ID of the Modifier/Option Value.

Responses

Status Meaning Description
204 No Content An empty response.

getModifiers

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/modifiers', headers=headers)

print r.json()

GET /catalog/products/{product_id}/modifiers

Gets an array of Modifier objects.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An array of modifiers and metadata.

Example responses

{
  "data": [
    {
      "type": "date",
      "required": true,
      "config": {
        "default_value": "string",
        "checked_by_default": true,
        "checkbox_label": "string",
        "date_limited": true,
        "date_limit_mode": "earliest",
        "date_earliest_value": "2017-03-24",
        "date_latest_value": "2017-03-24",
        "file_types_mode": "specific",
        "file_types_supported": [
          "string"
        ],
        "file_types_other": [
          "string"
        ],
        "file_max_size": 0,
        "text_characters_limited": true,
        "text_min_length": 0,
        "text_max_length": 0,
        "text_lines_limited": true,
        "text_max_lines": 0,
        "number_limited": true,
        "number_limit_mode": "lowest",
        "number_lowest_value": 0,
        "number_highest_value": 0,
        "number_integers_only": true,
        "product_list_adjusts_inventory": true,
        "product_list_adjusts_pricing": true,
        "product_list_shipping_calc": "none"
      },
      "option_values": [
        {
          "id": 0
        }
      ],
      "id": 0,
      "product_id": 0,
      "name": "string",
      "display_name": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

createModifier

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/modifiers', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/products/{product_id}/modifiers

Creates a Modifier.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
Modifier body ModifierPost true A Modifier object.

Body parameter

{
  "type": "date",
  "required": true,
  "config": {
    "default_value": "string",
    "checked_by_default": true,
    "checkbox_label": "string",
    "date_limited": true,
    "date_limit_mode": "earliest",
    "date_earliest_value": "2017-03-24",
    "date_latest_value": "2017-03-24",
    "file_types_mode": "specific",
    "file_types_supported": [
      "string"
    ],
    "file_types_other": [
      "string"
    ],
    "file_max_size": 0,
    "text_characters_limited": true,
    "text_min_length": 0,
    "text_max_length": 0,
    "text_lines_limited": true,
    "text_max_lines": 0,
    "number_limited": true,
    "number_limit_mode": "lowest",
    "number_lowest_value": 0,
    "number_highest_value": 0,
    "number_integers_only": true,
    "product_list_adjusts_inventory": true,
    "product_list_adjusts_pricing": true,
    "product_list_shipping_calc": "none"
  },
  "option_values": [
    {
      "id": 0
    }
  ],
  "display_name": "string"
}

Responses

Status Meaning Description
200 OK A Modifier object.
409 Conflict The Modifier was in conflict with another option. This is the result of duplicate unique fields, such as name.
422 Unprocessable Entity The Modifier was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "type": "date",
    "required": true,
    "config": {
      "default_value": "string",
      "checked_by_default": true,
      "checkbox_label": "string",
      "date_limited": true,
      "date_limit_mode": "earliest",
      "date_earliest_value": "2017-03-24",
      "date_latest_value": "2017-03-24",
      "file_types_mode": "specific",
      "file_types_supported": [
        "string"
      ],
      "file_types_other": [
        "string"
      ],
      "file_max_size": 0,
      "text_characters_limited": true,
      "text_min_length": 0,
      "text_max_length": 0,
      "text_lines_limited": true,
      "text_max_lines": 0,
      "number_limited": true,
      "number_limit_mode": "lowest",
      "number_lowest_value": 0,
      "number_highest_value": 0,
      "number_integers_only": true,
      "product_list_adjusts_inventory": true,
      "product_list_adjusts_pricing": true,
      "product_list_shipping_calc": "none"
    },
    "option_values": [
      {
        "id": 0
      }
    ],
    "id": 0,
    "product_id": 0,
    "name": "string",
    "display_name": "string"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

getModifierById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/modifiers/{modifier_id}', headers=headers)

print r.json()

GET /catalog/products/{product_id}/modifiers/{modifier_id}

Gets a Modifier by product_id and modifier_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
modifier_id path integer true The ID of the Modifier.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK A Modifier object.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "type": "date",
    "required": true,
    "config": {
      "default_value": "string",
      "checked_by_default": true,
      "checkbox_label": "string",
      "date_limited": true,
      "date_limit_mode": "earliest",
      "date_earliest_value": "2017-03-24",
      "date_latest_value": "2017-03-24",
      "file_types_mode": "specific",
      "file_types_supported": [
        "string"
      ],
      "file_types_other": [
        "string"
      ],
      "file_max_size": 0,
      "text_characters_limited": true,
      "text_min_length": 0,
      "text_max_length": 0,
      "text_lines_limited": true,
      "text_max_lines": 0,
      "number_limited": true,
      "number_limit_mode": "lowest",
      "number_lowest_value": 0,
      "number_highest_value": 0,
      "number_integers_only": true,
      "product_list_adjusts_inventory": true,
      "product_list_adjusts_pricing": true,
      "product_list_shipping_calc": "none"
    },
    "option_values": [
      {
        "id": 0
      }
    ],
    "id": 0,
    "product_id": 0,
    "name": "string",
    "display_name": "string"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateModifier

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/modifiers/{modifier_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /catalog/products/{product_id}/modifiers/{modifier_id}

Updates a Product’s Modifier, based on the product_id and modifier_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
modifier_id path integer true The ID of the Modifier.
modifier body ModifierPut true A BigCommerce Modifier object.

Body parameter

{
  "type": "date",
  "required": true,
  "config": {
    "default_value": "string",
    "checked_by_default": true,
    "checkbox_label": "string",
    "date_limited": true,
    "date_limit_mode": "earliest",
    "date_earliest_value": "2017-03-24",
    "date_latest_value": "2017-03-24",
    "file_types_mode": "specific",
    "file_types_supported": [
      "string"
    ],
    "file_types_other": [
      "string"
    ],
    "file_max_size": 0,
    "text_characters_limited": true,
    "text_min_length": 0,
    "text_max_length": 0,
    "text_lines_limited": true,
    "text_max_lines": 0,
    "number_limited": true,
    "number_limit_mode": "lowest",
    "number_lowest_value": 0,
    "number_highest_value": 0,
    "number_integers_only": true,
    "product_list_adjusts_inventory": true,
    "product_list_adjusts_pricing": true,
    "product_list_shipping_calc": "none"
  },
  "option_values": [
    {
      "id": 0
    }
  ]
}

Responses

Status Meaning Description
200 OK A Modifier object.
409 Conflict The Modifier was in conflict with another modifier or option. This is the result of duplicate unique fields, such as name.
422 Unprocessable Entity The Modifier was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "type": "date",
    "required": true,
    "config": {
      "default_value": "string",
      "checked_by_default": true,
      "checkbox_label": "string",
      "date_limited": true,
      "date_limit_mode": "earliest",
      "date_earliest_value": "2017-03-24",
      "date_latest_value": "2017-03-24",
      "file_types_mode": "specific",
      "file_types_supported": [
        "string"
      ],
      "file_types_other": [
        "string"
      ],
      "file_max_size": 0,
      "text_characters_limited": true,
      "text_min_length": 0,
      "text_max_length": 0,
      "text_lines_limited": true,
      "text_max_lines": 0,
      "number_limited": true,
      "number_limit_mode": "lowest",
      "number_lowest_value": 0,
      "number_highest_value": 0,
      "number_integers_only": true,
      "product_list_adjusts_inventory": true,
      "product_list_adjusts_pricing": true,
      "product_list_shipping_calc": "none"
    },
    "option_values": [
      {
        "id": 0
      }
    ],
    "id": 0,
    "product_id": 0,
    "name": "string",
    "display_name": "string"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteModifierById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/modifiers/{modifier_id}', headers=headers)

print r.json()

DELETE /catalog/products/{product_id}/modifiers/{modifier_id}

Deletes a Product’s Modifier, based on the product_id and modifier_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
modifier_id path integer true The ID of the Modifier.

Responses

Status Meaning Description
204 No Content An empty response.

getModifierValues

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/modifiers/{modifier_id}/values', headers=headers)

print r.json()

GET /catalog/products/{product_id}/modifiers/{modifier_id}/values

Gets an array of ModifierValue objects.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
modifier_id path integer true The ID of the Modifier.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An array of modifier values and metadata.

Example responses

{
  "data": [
    {
      "id": 0
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

createModifierValue

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/modifiers/{modifier_id}/values', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/products/{product_id}/modifiers/{modifier_id}/values

Creates a ModifierValue.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
modifier_id path integer true The ID of the Modifier.
ModifierValue body ModifierValuePost true A ModifierValue object.

Body parameter

{}

Responses

Status Meaning Description
200 OK A ModifierValue object.
422 Unprocessable Entity The ModifierValue was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "id": 0
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

getModifierValueById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}', headers=headers)

print r.json()

GET /catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}

Gets a ModifierValue, by product_id, modifier_id, and value_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
modifier_id path integer true The ID of the Modifier.
value_id path integer true The ID of the Modifier/Option Value.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK A ModifierValue object.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "id": 0
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateModifierValue

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}

Updates an Product’s ModifierValue, based on the product_id, modifier_id, and value_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
modifier_id path integer true The ID of the Modifier.
value_id path integer true The ID of the Modifier/Option Value.
ModifierValue body ModifierValuePut true A BigCommerce ModifierValue object.

Body parameter

{
  "id": 0
}

Responses

Status Meaning Description
200 OK A ModifierValue object.
422 Unprocessable Entity The ModifierValue was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "id": 0
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteModifierValueById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}', headers=headers)

print r.json()

DELETE /catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}

Deletes a Product’s ModifierValue, based on the product_id, modifier_id, and value_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
modifier_id path integer true The ID of the Modifier.
value_id path integer true The ID of the Modifier/Option Value.

Responses

Status Meaning Description
204 No Content An empty response.

createModifierImage

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'multipart/form-data'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}/image', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}/image

Adds an image to a modifier value; the image will show on the storefront when the value is selected.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
modifier_id path integer true The ID of the Modifier.
value_id path integer true The ID of the Modifier/Option Value.
image_file formData file true An image file. Supported MIME types include GIF, JPEG, and PNG.

Responses

Status Meaning Description
200 OK A ResourceImage and metadata.
404 Not Found The resource was not found.
422 Unprocessable Entity Modifier image was not valid. This is the result of missing image_file fields, or of a non-URL value for the image_file field. See the response for more details.

Example responses

{
  "data": {
    "image_url": "string"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteModifierImage

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}/image', headers=headers)

print r.json()

DELETE /catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}/image

Deletes the image that was set to show when the modifier value is selected.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
modifier_id path integer true The ID of the Modifier.
value_id path integer true The ID of the Modifier.

Responses

Status Meaning Description
204 No Content Image removed from the modifier value.

getComplexRules

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/complex-rules', headers=headers)

print r.json()

GET /catalog/products/{product_id}/complex-rules

Gets an array of ComplexRule objects.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An array of ComplexRule objects and metadata.

Example responses

{
  "data": [
    {
      "product_id": 0,
      "sort_order": -2147483648,
      "enabled": true,
      "stop": true,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "purchasing_hidden": true,
      "price_adjuster": {
        "adjuster": "relative",
        "adjuster_value": 0
      },
      "weight_adjuster": {
        "adjuster": "relative",
        "adjuster_value": 0
      },
      "id": 0,
      "image_url": "string",
      "conditions": [
        {
          "id": 0,
          "rule_id": 0,
          "modifier_id": 0,
          "modifier_value_id": 0,
          "variant_id": 0,
          "combination_id": 0
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

createComplexRule

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/complex-rules', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/products/{product_id}/complex-rules

Creates a ComplexRule.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
ComplexRule body ComplexRulePost true A ComplexRule object.

Body parameter

{
  "product_id": 0,
  "sort_order": -2147483648,
  "enabled": true,
  "stop": true,
  "purchasing_disabled": true,
  "purchasing_disabled_message": "string",
  "purchasing_hidden": true,
  "price_adjuster": {
    "adjuster": "relative",
    "adjuster_value": 0
  },
  "weight_adjuster": {
    "adjuster": "relative",
    "adjuster_value": 0
  },
  "conditions": [
    {
      "id": 0,
      "rule_id": 0,
      "modifier_id": 0,
      "modifier_value_id": 0,
      "variant_id": 0
    }
  ]
}

Responses

Status Meaning Description
200 OK A ComplexRule object.
409 Conflict The ComplexRule was in conflict with another ComplexRule. This is the result of duplicate conditions.
422 Unprocessable Entity The ComplexRule was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "product_id": 0,
    "sort_order": -2147483648,
    "enabled": true,
    "stop": true,
    "purchasing_disabled": true,
    "purchasing_disabled_message": "string",
    "purchasing_hidden": true,
    "price_adjuster": {
      "adjuster": "relative",
      "adjuster_value": 0
    },
    "weight_adjuster": {
      "adjuster": "relative",
      "adjuster_value": 0
    },
    "id": 0,
    "image_url": "string",
    "conditions": [
      {
        "id": 0,
        "rule_id": 0,
        "modifier_id": 0,
        "modifier_value_id": 0,
        "variant_id": 0,
        "combination_id": 0
      }
    ]
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

getComplexRuleById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/complex-rules/{complex_rule_id}', headers=headers)

print r.json()

GET /catalog/products/{product_id}/complex-rules/{complex_rule_id}

Gets a ComplexRule by product_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
complex_rule_id path integer true The ID of the ComplexRule.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK A Modifier object.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "product_id": 0,
    "sort_order": -2147483648,
    "enabled": true,
    "stop": true,
    "purchasing_disabled": true,
    "purchasing_disabled_message": "string",
    "purchasing_hidden": true,
    "price_adjuster": {
      "adjuster": "relative",
      "adjuster_value": 0
    },
    "weight_adjuster": {
      "adjuster": "relative",
      "adjuster_value": 0
    },
    "id": 0,
    "image_url": "string",
    "conditions": [
      {
        "id": 0,
        "rule_id": 0,
        "modifier_id": 0,
        "modifier_value_id": 0,
        "variant_id": 0,
        "combination_id": 0
      }
    ]
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateComplexRule

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/complex-rules/{complex_rule_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /catalog/products/{product_id}/complex-rules/{complex_rule_id}

Updates an Product’s ComplexRule, based on the product_id and complex_rule_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
complex_rule_id path integer true The ID of the ComplexRule.
ComplexRule body ComplexRulePut true ComplexRule object.

Body parameter

{
  "product_id": 0,
  "sort_order": -2147483648,
  "enabled": true,
  "stop": true,
  "purchasing_disabled": true,
  "purchasing_disabled_message": "string",
  "purchasing_hidden": true,
  "price_adjuster": {
    "adjuster": "relative",
    "adjuster_value": 0
  },
  "weight_adjuster": {
    "adjuster": "relative",
    "adjuster_value": 0
  },
  "id": 0,
  "conditions": [
    {
      "id": 0,
      "rule_id": 0,
      "modifier_id": 0,
      "modifier_value_id": 0,
      "variant_id": 0
    }
  ]
}

Responses

Status Meaning Description
200 OK A ComplexRule object.
409 Conflict The ComplexRule was in conflict with another ComplexRule. This is the result of duplicate conditions.
422 Unprocessable Entity The ComplexRule was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "product_id": 0,
    "sort_order": -2147483648,
    "enabled": true,
    "stop": true,
    "purchasing_disabled": true,
    "purchasing_disabled_message": "string",
    "purchasing_hidden": true,
    "price_adjuster": {
      "adjuster": "relative",
      "adjuster_value": 0
    },
    "weight_adjuster": {
      "adjuster": "relative",
      "adjuster_value": 0
    },
    "id": 0,
    "image_url": "string",
    "conditions": [
      {
        "id": 0,
        "rule_id": 0,
        "modifier_id": 0,
        "modifier_value_id": 0,
        "variant_id": 0,
        "combination_id": 0
      }
    ]
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteComplexRuleById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/complex-rules/{complex_rule_id}', headers=headers)

print r.json()

DELETE /catalog/products/{product_id}/complex-rules/{complex_rule_id}

Deletes a Product’s ComplexRule, based on the product_id and complex_rule_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
complex_rule_id path integer true The ID of the ComplexRule.

Responses

Status Meaning Description
204 No Content An empty response.

getCustomFields

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/custom-fields', headers=headers)

print r.json()

GET /catalog/products/{product_id}/custom-fields

Gets an array of CustomField objects.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An array of CustomField objects and metadata.

Example responses

{
  "data": [
    {
      "name": "string",
      "value": "string",
      "id": 1
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

createCustomField

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/custom-fields', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/products/{product_id}/custom-fields

Creates a CustomField.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
CustomField body CustomFieldPost true CustomField object.

Body parameter

{
  "name": "string",
  "value": "string"
}

Responses

Status Meaning Description
200 OK A CustomField object.
404 Not Found The parent resource was not found.
422 Unprocessable Entity The CustomField was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "name": "string",
    "value": "string",
    "id": 1
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

getCustomFieldById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/custom-fields/{custom_field_id}', headers=headers)

print r.json()

GET /catalog/products/{product_id}/custom-fields/{custom_field_id}

Gets a CustomField by product_id and custom_field_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
custom_field_id path integer true The ID of the CustomField.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK A CustomField object.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "name": "string",
    "value": "string",
    "id": 1
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateCustomField

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/custom-fields/{custom_field_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /catalog/products/{product_id}/custom-fields/{custom_field_id}

Updates an Product’s CustomField, based on the product_id and custom_field_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
custom_field_id path integer true The ID of the CustomField.
CustomField body CustomFieldPut true CustomField object.

Body parameter

{
  "name": "string",
  "value": "string",
  "id": 1
}

Responses

Status Meaning Description
200 OK A CustomField object.
404 Not Found The resource was not found.
422 Unprocessable Entity The CustomField was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "name": "string",
    "value": "string",
    "id": 1
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteCustomFieldById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/custom-fields/{custom_field_id}', headers=headers)

print r.json()

DELETE /catalog/products/{product_id}/custom-fields/{custom_field_id}

Deletes a Product’s CustomField, based on the product_id and custom_field_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
custom_field_id path integer true The ID of the CustomField.

Responses

Status Meaning Description
204 No Content An empty response.
404 Not Found The resource was not found.

Example responses

{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

getBulkPricingRules

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/bulk-pricing-rules', headers=headers)

print r.json()

GET /catalog/products/{product_id}/bulk-pricing-rules

Gets an array of BulkPricingRule objects.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An array of BulkPricingRule objects and metadata.
404 Not Found The parent resource was not found.

Example responses

{
  "data": [
    {
      "quantity_min": 0,
      "quantity_max": 0,
      "type": "price",
      "amount": 0,
      "id": 1
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

createBulkPricingRule

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/bulk-pricing-rules', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/products/{product_id}/bulk-pricing-rules

Creates a BulkPricingRule.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
BulkPricingRule body BulkPricingRulePost true A BulkPricingRule object.

Body parameter

{
  "quantity_min": 0,
  "quantity_max": 0,
  "type": "price",
  "amount": 0
}

Responses

Status Meaning Description
200 OK A BulkPricingRule object.
404 Not Found The parent resource was not found.
409 Conflict The BulkPricingRule was in conflict with another bulk pricing rule. This is the result of the quantity range overlapping with existing bulk pricing rules.
422 Unprocessable Entity The BulkPricingRule was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "quantity_min": 0,
    "quantity_max": 0,
    "type": "price",
    "amount": 0,
    "id": 1
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

getBulkPricingRuleById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}', headers=headers)

print r.json()

GET /catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}

Gets a BulkPricingRule by product_id and bulk_pricing_rule_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
bulk_pricing_rule_id path integer true The ID of the BulkPricingRule object.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK A BulkPricingRule object.
404 Not Found The resource or parent resource was not found.

Example responses

{
  "data": {
    "quantity_min": 0,
    "quantity_max": 0,
    "type": "price",
    "amount": 0,
    "id": 1
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateBulkPricingRule

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}

Updates an Product’s BulkPricingRule, based on the product_id and bulk_pricing_rule_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
bulk_pricing_rule_id path integer true The ID of the BulkPricingRule.
BulkPricingRule body BulkPricingRulePut true The BulkPricingRule object.

Body parameter

{
  "quantity_min": 0,
  "quantity_max": 0,
  "type": "price",
  "amount": 0,
  "id": 1
}

Responses

Status Meaning Description
200 OK A BulkPricingRule object.
404 Not Found The resource or parent resource was not found.
409 Conflict The BulkPricingRule was in conflict with another bulk pricing rule. This is the result of quantity range overlapping with existing bulk pricing rules.
422 Unprocessable Entity The BulkPricingRule was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "quantity_min": 0,
    "quantity_max": 0,
    "type": "price",
    "amount": 0,
    "id": 1
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteBulkPricingRuleById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}', headers=headers)

print r.json()

DELETE /catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}

Deletes a Product’s BulkPricingRule, based on the product_id and bulk_pricing_rule_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
bulk_pricing_rule_id path integer true The ID of the BulkPricingRule.

Responses

Status Meaning Description
204 No Content An empty response.
404 Not Found The resource or parent resource was not found.

Example responses

{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

getProductMetafieldsByProductId

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/metafields', headers=headers)

print r.json()

GET /catalog/products/{product_id}/metafields

Gets a Metafield object list, by product_id.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
page query integer false Specifies the page number in a limited (paginated) list of products.
limit query integer false Controls the number of items per page in a limited (paginated) list of products.
key query string false Filter based on a metafield’s key.
namespace query string false Filter based on a metafield’s key.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An array of metafields and metadata.
404 Not Found The resource was not found.

Example responses

{
  "data": [
    {
      "permission_set": "app_only",
      "namespace": "string",
      "key": "string",
      "value": "string",
      "description": "string",
      "resource_type": "category",
      "resource_id": 0,
      "id": 0,
      "created_at": "2017-03-24T23:49:18Z",
      "updated_at": "2017-03-24T23:49:18Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

createProductMetafield

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/metafields', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/products/{product_id}/metafields

Creates a product Metafield.

Parameters

Parameter In Type Required Description
product_id path integer true The ID of the Product to which the resource belongs.
Metafield body MetafieldPost true A Metafield object.

Body parameter

{
  "permission_set": "app_only",
  "namespace": "string",
  "key": "string",
  "value": "string",
  "description": "string",
  "resource_type": "category",
  "resource_id": 0
}

Responses

Status Meaning Description
200 OK A Metafield object.
409 Conflict The Metafield was in conflict with another Metafield. This can be the result of duplicate unique-key combinations of the app’s client id, namespace, key, resource_type, and resource_id.
422 Unprocessable Entity The Metafield was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "permission_set": "app_only",
    "namespace": "string",
    "key": "string",
    "value": "string",
    "description": "string",
    "resource_type": "category",
    "resource_id": 0,
    "id": 0,
    "created_at": "2017-03-24T23:49:18Z",
    "updated_at": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

getProductMetafieldByProductId

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/metafields/{metafield_id}', headers=headers)

print r.json()

GET /catalog/products/{product_id}/metafields/{metafield_id}

Gets a Metafield, by product_id.

Parameters

Parameter In Type Required Description
metafield_id path number true The ID of the Metafield.
product_id path integer true The ID of the Product to which the resource belongs.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK A Metafield object.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "permission_set": "app_only",
    "namespace": "string",
    "key": "string",
    "value": "string",
    "description": "string",
    "resource_type": "category",
    "resource_id": 0,
    "id": 0,
    "created_at": "2017-03-24T23:49:18Z",
    "updated_at": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateProductMetafield

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/metafields/{metafield_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /catalog/products/{product_id}/metafields/{metafield_id}

Updates a Metafield object.

Parameters

Parameter In Type Required Description
metafield_id path number true The ID of the Metafield.
product_id path integer true The ID of the Product to which the resource belongs.
Metafield body MetafieldPut true A Metafield object.

Body parameter

{
  "permission_set": "app_only",
  "namespace": "string",
  "key": "string",
  "value": "string",
  "description": "string",
  "resource_type": "category",
  "resource_id": 0,
  "id": 0
}

Responses

Status Meaning Description
200 OK A metafield and metadata.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "permission_set": "app_only",
    "namespace": "string",
    "key": "string",
    "value": "string",
    "description": "string",
    "resource_type": "category",
    "resource_id": 0,
    "id": 0,
    "created_at": "2017-03-24T23:49:18Z",
    "updated_at": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

deleteProductMetafieldById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/products/{product_id}/metafields/{metafield_id}', headers=headers)

print r.json()

DELETE /catalog/products/{product_id}/metafields/{metafield_id}

Deletes a Metafield.

Parameters

Parameter In Type Required Description
metafield_id path number true The ID of the Metafield.
product_id path integer true The ID of the Product to which the resource belongs.

Responses

Status Meaning Description
204 No Content An empty response.

getCategories

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/categories', headers=headers)

print r.json()

GET /catalog/categories

Returns a paginated categories collection from the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
name query string false Filter items by name.
parent_id query integer false Filter items by parent_id.
page_title query string false Filter items by page_title.
keyword query string false Filter items by keywords.
is_visible query integer false Filter items by is_visible.
page query integer false Specifies the page number in a limited (paginated) list of products.
limit query integer false Controls the number of items per page in a limited (paginated) list of products.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An array of Category objects and metadata.

Example responses

{
  "data": [
    {
      "parent_id": 0,
      "name": "string",
      "description": "string",
      "views": 0,
      "sort_order": -2147483648,
      "page_title": "string",
      "search_keywords": "string",
      "meta_keywords": [
        "string"
      ],
      "meta_description": "string",
      "layout_file": "string",
      "is_visible": true,
      "default_product_sort": "use_store_settings",
      "image_url": "string",
      "custom_url": {
        "url": "string",
        "is_customized": true
      },
      "id": 0
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

createCategory

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/categories', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/categories

Creates a Category in the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
category body CategoryPost true A BigCommerce Category object.

Body parameter

{
  "parent_id": 0,
  "name": "string",
  "description": "string",
  "views": 0,
  "sort_order": -2147483648,
  "page_title": "string",
  "search_keywords": "string",
  "meta_keywords": [
    "string"
  ],
  "meta_description": "string",
  "layout_file": "string",
  "is_visible": true,
  "default_product_sort": "use_store_settings",
  "image_url": "string",
  "custom_url": {
    "url": "string",
    "is_customized": true
  }
}

Responses

Status Meaning Description
200 OK A Category object.
409 Conflict The Category was in conflict with another Category. This is the result of duplicate unique values, such as name or custom_url.
422 Unprocessable Entity The Category was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "parent_id": 0,
    "name": "string",
    "description": "string",
    "views": 0,
    "sort_order": -2147483648,
    "page_title": "string",
    "search_keywords": "string",
    "meta_keywords": [
      "string"
    ],
    "meta_description": "string",
    "layout_file": "string",
    "is_visible": true,
    "default_product_sort": "use_store_settings",
    "image_url": "string",
    "custom_url": {
      "url": "string",
      "is_customized": true
    },
    "id": 0
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteCategories

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/categories', headers=headers)

print r.json()

DELETE /catalog/categories

Deletes one or more Category objects from the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
name query string false Filter items by name.
parent_id query integer false Filter items by parent_id.
page_title query string false Filter items by page_title.
keyword query string false Filter items by keywords.
is_visible query integer false Filter items by is_visible.

Responses

Status Meaning Description
204 No Content An empty response.

getCategoryById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/categories/{category_id}', headers=headers)

print r.json()

GET /catalog/categories/{category_id}

Returns a Category from the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
category_id path number true The ID of the Category to which the resource belongs.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK A Category object.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "parent_id": 0,
    "name": "string",
    "description": "string",
    "views": 0,
    "sort_order": -2147483648,
    "page_title": "string",
    "search_keywords": "string",
    "meta_keywords": [
      "string"
    ],
    "meta_description": "string",
    "layout_file": "string",
    "is_visible": true,
    "default_product_sort": "use_store_settings",
    "image_url": "string",
    "custom_url": {
      "url": "string",
      "is_customized": true
    },
    "id": 0
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateCategory

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/categories/{category_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /catalog/categories/{category_id}

Updates a Category in the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
category_id path number true The ID of the Category to which the resource belongs.
category body CategoryPut true A BigCommerce Category object.

Body parameter

{
  "parent_id": 0,
  "name": "string",
  "description": "string",
  "views": 0,
  "sort_order": -2147483648,
  "page_title": "string",
  "search_keywords": "string",
  "meta_keywords": [
    "string"
  ],
  "meta_description": "string",
  "layout_file": "string",
  "is_visible": true,
  "default_product_sort": "use_store_settings",
  "image_url": "string",
  "custom_url": {
    "url": "string",
    "is_customized": true
  }
}

Responses

Status Meaning Description
200 OK A Category object.
404 Not Found The resource was not found.
409 Conflict The Category was in conflict with another Category. This is the result of duplicate unique values, such as name or custom_url.
422 Unprocessable Entity The Category was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "parent_id": 0,
    "name": "string",
    "description": "string",
    "views": 0,
    "sort_order": -2147483648,
    "page_title": "string",
    "search_keywords": "string",
    "meta_keywords": [
      "string"
    ],
    "meta_description": "string",
    "layout_file": "string",
    "is_visible": true,
    "default_product_sort": "use_store_settings",
    "image_url": "string",
    "custom_url": {
      "url": "string",
      "is_customized": true
    },
    "id": 0
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteCategoryById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/categories/{category_id}', headers=headers)

print r.json()

DELETE /catalog/categories/{category_id}

Deletes one or more Category objects from the BigCommerce catalog.

Parameters

Parameter In Type Required Description
category_id path number true The ID of the Category to which the resource belongs.

Responses

Status Meaning Description
204 No Content An empty response.

getCategoryMetafieldsByCategoryId

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/categories/{category_id}/metafields', headers=headers)

print r.json()

GET /catalog/categories/{category_id}/metafields

Gets a Metafield object list, by category_id.

Parameters

Parameter In Type Required Description
category_id path number true The ID of the Category to which the resource belongs.
page query integer false Specifies the page number in a limited (paginated) list of products.
limit query integer false Controls the number of items per page in a limited (paginated) list of products.
key query string false Filter based on a metafield’s key.
namespace query string false Filter based on a metafield’s key.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An array of metafields and metadata.
404 Not Found The resource was not found.

Example responses

{
  "data": [
    {
      "permission_set": "app_only",
      "namespace": "string",
      "key": "string",
      "value": "string",
      "description": "string",
      "resource_type": "category",
      "resource_id": 0,
      "id": 0,
      "created_at": "2017-03-24T23:49:18Z",
      "updated_at": "2017-03-24T23:49:18Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

createCategoryMetafield

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/categories/{category_id}/metafields', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/categories/{category_id}/metafields

Creates a product Metafield.

Parameters

Parameter In Type Required Description
category_id path number true The ID of the Category to which the resource belongs.
Metafield body MetafieldPost true A Metafield object.

Body parameter

{
  "permission_set": "app_only",
  "namespace": "string",
  "key": "string",
  "value": "string",
  "description": "string",
  "resource_type": "category",
  "resource_id": 0
}

Responses

Status Meaning Description
200 OK A Metafield object.
409 Conflict The Metafield was in conflict with another Metafield. This can be the result of duplicate unique-key combinations of the app’s client id, namespace, key, resource_type, and resource_id.
422 Unprocessable Entity The Metafield was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "permission_set": "app_only",
    "namespace": "string",
    "key": "string",
    "value": "string",
    "description": "string",
    "resource_type": "category",
    "resource_id": 0,
    "id": 0,
    "created_at": "2017-03-24T23:49:18Z",
    "updated_at": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

getCategoryMetafieldByCategoryId

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/categories/{category_id}/metafields/{metafield_id}', headers=headers)

print r.json()

GET /catalog/categories/{category_id}/metafields/{metafield_id}

Gets a Metafield by category_id.

Parameters

Parameter In Type Required Description
metafield_id path number true The ID of the Metafield.
category_id path number true The ID of the Category to which the resource belongs.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK A Metafield object.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "permission_set": "app_only",
    "namespace": "string",
    "key": "string",
    "value": "string",
    "description": "string",
    "resource_type": "category",
    "resource_id": 0,
    "id": 0,
    "created_at": "2017-03-24T23:49:18Z",
    "updated_at": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateCategoryMetafield

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/categories/{category_id}/metafields/{metafield_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /catalog/categories/{category_id}/metafields/{metafield_id}

Updates a Metafield object.

Parameters

Parameter In Type Required Description
metafield_id path number true The ID of the Metafield.
category_id path number true The ID of the Category to which the resource belongs.
Metafield body MetafieldPut true A Metafield object.

Body parameter

{
  "permission_set": "app_only",
  "namespace": "string",
  "key": "string",
  "value": "string",
  "description": "string",
  "resource_type": "category",
  "resource_id": 0,
  "id": 0
}

Responses

Status Meaning Description
200 OK A metafield and metadata.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "permission_set": "app_only",
    "namespace": "string",
    "key": "string",
    "value": "string",
    "description": "string",
    "resource_type": "category",
    "resource_id": 0,
    "id": 0,
    "created_at": "2017-03-24T23:49:18Z",
    "updated_at": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

deleteCategoryMetafieldById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/categories/{category_id}/metafields/{metafield_id}', headers=headers)

print r.json()

DELETE /catalog/categories/{category_id}/metafields/{metafield_id}

Deletes a Metafield.

Parameters

Parameter In Type Required Description
metafield_id path number true The ID of the Metafield.
category_id path number true The ID of the Category to which the resource belongs.

Responses

Status Meaning Description
204 No Content An empty response.

createCategoryImage

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'multipart/form-data'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/categories/{category_id}/image', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/categories/{category_id}/image

Creates an image on a category. Publicly accessible URLs and files (form post) are valid parameters.

Parameters

Parameter In Type Required Description
category_id path number true The ID of the Category to which the resource belongs.
image_file formData file true An image file. Supported MIME types include GIF, JPEG, and PNG.

Responses

Status Meaning Description
200 OK A ResourceImage and metadata.
404 Not Found The resource was not found.
422 Unprocessable Entity Image was not valid. This is caused either by a missing image_file field or by an incorrect file type. See the response for more details.

Example responses

{
  "data": {
    "image_url": "string"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteCategoryImage

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/categories/{category_id}/image', headers=headers)

print r.json()

DELETE /catalog/categories/{category_id}/image

Deletes a Category image from the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
category_id path number true The ID of the Category to which the resource belongs.

Responses

Status Meaning Description
204 No Content An empty response.

getCategoryTree

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/categories/tree', headers=headers)

print r.json()

GET /catalog/categories/tree

Returns the categories tree, a nested lineage of the categories with parent->child relationship. The Category objects returned are simplified versions of the Category objects returned in the rest of this API.

Responses

Status Meaning Description
200 OK A array of nested category tree objects and metadata.

Example responses

{
  "data": [
    {}
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

getBrands

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/brands', headers=headers)

print r.json()

GET /catalog/brands

Gets Brand objects.

Parameters

Parameter In Type Required Description
name query string false Filter items by name.
page_title query string false Filter items by page_title.
page query integer false Specifies the page number in a limited (paginated) list of products.
limit query integer false Controls the number of items per page in a limited (paginated) list of products.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An array of Brand objects and metadata.

Example responses

{
  "data": [
    {
      "name": "string",
      "page_title": "string",
      "meta_keywords": [
        "string"
      ],
      "meta_description": "string",
      "search_keywords": "string",
      "image_url": "string",
      "id": 0
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

createBrand

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/brands', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/brands

Creates a Brand object.

Parameters

Parameter In Type Required Description
Brand body BrandPost true A Brand object.

Body parameter

{
  "name": "string",
  "page_title": "string",
  "meta_keywords": [
    "string"
  ],
  "meta_description": "string",
  "search_keywords": "string",
  "image_url": "string"
}

Responses

Status Meaning Description
200 OK A Brand object.
409 Conflict Brand was in conflict with another Brand. This is the result of duplicate unique fields, such as name.
422 Unprocessable Entity Brand was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "name": "string",
    "page_title": "string",
    "meta_keywords": [
      "string"
    ],
    "meta_description": "string",
    "search_keywords": "string",
    "image_url": "string",
    "id": 0
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteBrands

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/brands', headers=headers)

print r.json()

DELETE /catalog/brands

Deletes one or more Brand objects from the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
name query string false Filter items by name.
page_title query string false Filter items by page_title.

Responses

Status Meaning Description
204 No Content An empty response.

getBrandById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/brands/{brand_id}', headers=headers)

print r.json()

GET /catalog/brands/{brand_id}

Gets a Brand object.

Parameters

Parameter In Type Required Description
brand_id path number true The ID of the Brand to which the resource belongs.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK A Brand object.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "name": "string",
    "page_title": "string",
    "meta_keywords": [
      "string"
    ],
    "meta_description": "string",
    "search_keywords": "string",
    "image_url": "string",
    "id": 0
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateBrand

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/brands/{brand_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /catalog/brands/{brand_id}

Updates a Brand in the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
brand_id path number true The ID of the Brand to which the resource belongs.
brand body BrandPut true Returns a Brand object from the BigCommerce Catalog.

Body parameter

{
  "name": "string",
  "page_title": "string",
  "meta_keywords": [
    "string"
  ],
  "meta_description": "string",
  "search_keywords": "string",
  "image_url": "string",
  "id": 0
}

Responses

Status Meaning Description
200 OK A Brand object.
404 Not Found The resource was not found.
409 Conflict The Brand was in conflict with another Brand. This is the result of duplicate unique values, such as name.
422 Unprocessable Entity The Brand was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "name": "string",
    "page_title": "string",
    "meta_keywords": [
      "string"
    ],
    "meta_description": "string",
    "search_keywords": "string",
    "image_url": "string",
    "id": 0
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteBrandById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/brands/{brand_id}', headers=headers)

print r.json()

DELETE /catalog/brands/{brand_id}

Deletes a Brand from the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
brand_id path number true The ID of the Brand to which the resource belongs.

Responses

Status Meaning Description
204 No Content An empty response.

getBrandMetafieldsByBrandId

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/brands/{brand_id}/metafields', headers=headers)

print r.json()

GET /catalog/brands/{brand_id}/metafields

Gets a Metafield object list, by category_id.

Parameters

Parameter In Type Required Description
brand_id path number true The ID of the Brand to which the resource belongs.
page query integer false Specifies the page number in a limited (paginated) list of products.
limit query integer false Controls the number of items per page in a limited (paginated) list of products.
key query string false Filter based on a metafield’s key.
namespace query string false Filter based on a metafield’s key.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An array of metafields and metadata.
404 Not Found The resource was not found.

Example responses

{
  "data": [
    {
      "permission_set": "app_only",
      "namespace": "string",
      "key": "string",
      "value": "string",
      "description": "string",
      "resource_type": "category",
      "resource_id": 0,
      "id": 0,
      "created_at": "2017-03-24T23:49:18Z",
      "updated_at": "2017-03-24T23:49:18Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

createBrandMetafield

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/brands/{brand_id}/metafields', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/brands/{brand_id}/metafields

Creates a product Metafield.

Parameters

Parameter In Type Required Description
brand_id path number true The ID of the Brand to which the resource belongs.
Metafield body MetafieldPost true A Metafield object.

Body parameter

{
  "permission_set": "app_only",
  "namespace": "string",
  "key": "string",
  "value": "string",
  "description": "string",
  "resource_type": "category",
  "resource_id": 0
}

Responses

Status Meaning Description
200 OK A Metafield object.
409 Conflict The Metafield was in conflict with another Metafield. This can be the result of duplicate unique-key combinations of the app’s client id, namespace, key, resource_type, and resource_id.
422 Unprocessable Entity The Metafield was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Example responses

{
  "data": {
    "permission_set": "app_only",
    "namespace": "string",
    "key": "string",
    "value": "string",
    "description": "string",
    "resource_type": "category",
    "resource_id": 0,
    "id": 0,
    "created_at": "2017-03-24T23:49:18Z",
    "updated_at": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

getBrandMetafieldByBrandId

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/brands/{brand_id}/metafields/{metafield_id}', headers=headers)

print r.json()

GET /catalog/brands/{brand_id}/metafields/{metafield_id}

Gets a Metafield, by category_id.

Parameters

Parameter In Type Required Description
metafield_id path number true The ID of the Metafield.
brand_id path number true The ID of the Brand to which the resource belongs.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK A Metafield object.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "permission_set": "app_only",
    "namespace": "string",
    "key": "string",
    "value": "string",
    "description": "string",
    "resource_type": "category",
    "resource_id": 0,
    "id": 0,
    "created_at": "2017-03-24T23:49:18Z",
    "updated_at": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateBrandMetafield

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/brands/{brand_id}/metafields/{metafield_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /catalog/brands/{brand_id}/metafields/{metafield_id}

Updates a Metafield object.

Parameters

Parameter In Type Required Description
metafield_id path number true The ID of the Metafield.
brand_id path number true The ID of the Brand to which the resource belongs.
Metafield body MetafieldPut true A Metafield object.

Body parameter

{
  "permission_set": "app_only",
  "namespace": "string",
  "key": "string",
  "value": "string",
  "description": "string",
  "resource_type": "category",
  "resource_id": 0,
  "id": 0
}

Responses

Status Meaning Description
200 OK A metafield and metadata.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "permission_set": "app_only",
    "namespace": "string",
    "key": "string",
    "value": "string",
    "description": "string",
    "resource_type": "category",
    "resource_id": 0,
    "id": 0,
    "created_at": "2017-03-24T23:49:18Z",
    "updated_at": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

deleteBrandMetafieldById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/brands/{brand_id}/metafields/{metafield_id}', headers=headers)

print r.json()

DELETE /catalog/brands/{brand_id}/metafields/{metafield_id}

Deletes a Metafield.

Parameters

Parameter In Type Required Description
metafield_id path number true The ID of the Metafield.
brand_id path number true The ID of the Brand to which the resource belongs.

Responses

Status Meaning Description
204 No Content An empty response.

createBrandImage

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'multipart/form-data'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/brands/{brand_id}/image', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /catalog/brands/{brand_id}/image

Creates an image on a Brand. Publicly accessible URLs and files (form post) are valid parameters.

Parameters

Parameter In Type Required Description
brand_id path number true The ID of the Brand to which the resource belongs.
image_file formData file true An image file. Supported MIME types include GIF, JPEG, and PNG.

Responses

Status Meaning Description
200 OK A ResourceImage.
404 Not Found The resource was not found.
422 Unprocessable Entity Image was not valid. This is caused by a missing image_file field, or by an incorrect file type. See the response for more details.

Example responses

{
  "data": {
    "image_url": "string"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteBrandImage

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/brands/{brand_id}/image', headers=headers)

print r.json()

DELETE /catalog/brands/{brand_id}/image

Deletes a Brand image from the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
brand_id path number true The ID of the Brand to which the resource belongs.

Responses

Status Meaning Description
204 No Content Image cleared from the brand.

getVariants

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/variants', headers=headers)

print r.json()

GET /catalog/variants

Returns a Variant object list from the BigCommerce Catalog.

Parameters

Parameter In Type Required Description
id query integer false Filter items by id.
sku query string false Filter items by sku.
page query integer false Specifies the page number in a limited (paginated) list of products.
limit query integer false Controls the number of items per page in a limited (paginated) list of products.
include_fields query string false Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields query string false Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Responses

Status Meaning Description
200 OK An array of variants and metadata.
404 Not Found The resource was not found.

Example responses

{
  "data": [
    {
      "cost_price": 0,
      "price": 0,
      "weight": 0,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "image_url": "string",
      "upc": "string",
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "bin_picking_number": "string",
      "id": 0,
      "product_id": 0,
      "sku": "string",
      "sku_id": 0,
      "option_values": [
        {
          "option_display_name": "string",
          "label": "string",
          "id": 0,
          "option_id": 0
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

GET /catalog/summary

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/catalog/summary', headers=headers)

print r.json()

Returns a lightweight inventory summary from the BigCommerce Catalog.

Responses

Status Meaning Description
200 OK An array of catalog summary and metadata.

Example responses

{
  "data": {
    "inventory_count": 0,
    "inventory_value": 0,
    "primary_category_id": 0,
    "primary_category_name": "string"
  },
  "meta": {}
}

Customers

getSubscribers

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/customers/subscribers', headers=headers)

print r.json()

GET /customers/subscribers

Returns a paginated collection of Subscriber objects.

Parameters

Parameter In Type Required Description
email query string false Filter items by email.
first_name query string false Filter items by first_name.
last_name query string false Filter items by last_name.
source query string false Filter items by source.
order_id query integer false Filter items by order_id.
date_created query string false Filter items by date_created.
date_modified query string false Filter items by date_modified.
page query integer false Specifies the page number in a limited (paginated) list of products.
limit query integer false Controls the number of items per page in a limited (paginated) list of products.

Responses

Status Meaning Description
200 OK An array of Subscriber objects and metadata.

Example responses

{
  "data": [
    {
      "id": 0,
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "source": "string",
      "order_id": 1,
      "date_modified": "2017-03-24T23:49:18Z",
      "date_created": "2017-03-24T23:49:18Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

createSubscriber

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/customers/subscribers', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /customers/subscribers

Creates a Subscriber object.

Parameters

Parameter In Type Required Description
subscriber body SubscriberPost true A Subscriber object.

Body parameter

{
  "id": 0,
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "source": "string",
  "order_id": 1
}

Responses

Status Meaning Description
200 OK A Subscriber object.
409 Conflict The Subscriber was in conflict with another Subscriber. This is caused by duplicate unique values, such as email.
422 Unprocessable Entity The Subscriber was not valid. This is caused either by missing required fields, or by invalid data. See the response for more details.

Example responses

{
  "data": {
    "id": 0,
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "source": "string",
    "order_id": 1,
    "date_modified": "2017-03-24T23:49:18Z",
    "date_created": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteSubscribers

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/customers/subscribers', headers=headers)

print r.json()

DELETE /customers/subscribers

Deletes one or more Subscriber objects from BigCommerce Customers.

Parameters

Parameter In Type Required Description
email query string false Filter items by email.
first_name query string false Filter items by first_name.
last_name query string false Filter items by last_name.
source query string false Filter items by source.
order_id query integer false Filter items by order_id.
date_created query string false Filter items by date_created.
date_modified query string false Filter items by date_modified.

Responses

Status Meaning Description
204 No Content An empty response.

getSubscriberById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/customers/subscribers/{subscriber_id}', headers=headers)

print r.json()

GET /customers/subscribers/{subscriber_id}

Gets a Subscriber object.

Parameters

Parameter In Type Required Description
subscriber_id path number true The ID of the Subscriber requested.

Responses

Status Meaning Description
200 OK A Subscriber object.
404 Not Found The resource was not found.

Example responses

{
  "data": {
    "id": 0,
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "source": "string",
    "order_id": 1,
    "date_modified": "2017-03-24T23:49:18Z",
    "date_created": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

updateSubscriber

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/customers/subscribers/{subscriber_id}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

PUT /customers/subscribers/{subscriber_id}

Updates a Subscriber object.

Parameters

Parameter In Type Required Description
subscriber_id path number true The ID of the Subscriber requested.
subscriber body SubscriberPut true Returns a Subscriber object.

Body parameter

{
  "id": 0,
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "source": "string",
  "order_id": 1
}

Responses

Status Meaning Description
200 OK A Subscriber object.
404 Not Found The resource was not found.
409 Conflict The Subscriber was in conflict with another subscriber. This is the result of duplicate unique values, such as email.
422 Unprocessable Entity The Subscriber was not valid. This is caused either by missing required fields, or by invalid data. See the response for more details.

Example responses

{
  "data": {
    "id": 0,
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "source": "string",
    "order_id": 1,
    "date_modified": "2017-03-24T23:49:18Z",
    "date_created": "2017-03-24T23:49:18Z"
  },
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteSubscriberById

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{{store_id}}/v3/customers/subscribers/{subscriber_id}', headers=headers)

print r.json()

DELETE /customers/subscribers/{subscriber_id}

Deletes a Subscriber object.

Parameters

Parameter In Type Required Description
subscriber_id path number true The ID of the Subscriber requested.

Responses

Status Meaning Description
204 No Content An empty response.

Orders

getTransactions

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json',
    'Content-Type':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/orders/{order_id}/transactions', headers=headers)

print r.json()

GET /orders/{order_id}/transactions

Returns a collection of Transaction objects related to a BigCommerce Order.

Parameters

Parameter In Type Required Description
order_id path number true The ID of the Order to which the transactions belong.

Responses

Status Meaning Description
200 OK An array of Transaction objects.
204 No Content No content found to fulfill the request.
404 Not Found The resource was not found.

Example responses

{
  "data": [
    {
      "id": 0,
      "order_id": "string",
      "date_created": "2017-03-24T23:49:18Z",
      "avs_result": {
        "code": "string",
        "message": "string",
        "street_match": "string",
        "postal_match": "string"
      },
      "cvv_result": {
        "code": "string",
        "message": "string"
      },
      "credit_card": {
        "card_type": "string",
        "card_iin": "string",
        "card_last4": "string"
      },
      "gift_certificate": {
        "code": "string",
        "original_balance": "string",
        "starting_balance": "string",
        "remaining_balance": "string",
        "status": "active"
      },
      "store_credit": {
        "remaining_balance": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string"
}

Themes

API for uploading and managing BigCommerce storefront themes.

getStoreThemes

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/themes', headers=headers)

print r.json()

GET /themes

Gets all store themes.

Responses

Status Meaning Description
200 OK Returns all themes associated with the BigCommerce store.
default Default Error message.

Example response – success

{
  "data": [
    {
      "variations": [
        {
          "description": "string",
          "external_id": "string",
          "name": "string",
          "uuid": "string"
        }
      ],
      "uuid": "string",
      "name": "string",
      "is_private": true
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

Example response – error

{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

getStoreTheme

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/themes/{theme_id}', headers=headers)

print r.json()

GET /themes/{theme_id}

Gets a specified store theme.

Parameters

Parameter In Type Required Description
theme_id path string true The theme identifier.

Responses

Status Meaning Description
200 OK The theme.
default Default Error message.

Example response – success

{
  "data": {
    "variations": [
      {
        "description": "string",
        "external_id": "string",
        "name": "string",
        "uuid": "string"
      }
    ],
    "uuid": "string",
    "name": "string",
    "is_private": true
  },
  "meta": {}
}

Example response – error

{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

uploadTheme

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/octet-stream',
    'Accept':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{store_id}/v3/themes', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /themes

Uploads a new theme to a BigCommerce store.

Parameters

Parameter In Type Required Description
file formData file true The file.

Responses

Status Meaning Description
201 Created Job ID for the background job processing the theme upload.
default Default Error message.

Example response – success

{
  "job_id": "string"
}

Example response – error

{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

deleteStoreTheme

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{store_id}/v3/themes/{theme_id}', headers=headers)

print r.json()

DELETE /themes/{theme_id}

Deletes a specified store theme.

Parameters

Parameter In Type Required Description
theme_id path string true The theme identifier.

Responses

Status Meaning Description
204 No Content No content found to fulfill the request.
default Default Error message.

Example response – error

{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

downloadTheme

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{store_id}/v3/themes/{theme_id}/actions/download', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /themes/{theme_id}/actions/download

Downloads a specified store theme.

Parameters

Parameter In Type Required Description
theme_id path string true The theme identifier.
which body string false A BigCommerce object specifying which theme to download. One of:
original: the original Marketplace or uploaded custom theme;
last_activated: the theme version most recently applied to the store;
last_created: the theme version most recently created.

If which is missing or invalid in the request, its value will default to last_activated.

Body parameter

{
  "which": "original"
}

Responses

Status Meaning Description
200 OK Job ID for the background job processing the download.
default Default Error message.

Example response – success

{
  "job_id": "string"
}

Example response – error

{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

activateStoreTheme

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{store_id}/v3/themes/actions/activate', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /themes/actions/activate

Activates a store theme.

Parameters

Parameter In Type Required Description
variation_id body string true The identifier for the variation to activate.
which body string false A BigCommerce object specifying which theme to activate. One of:
original: the original Marketplace or uploaded custom theme;
last_activated: the theme version most recently applied to the store;
last_created: the theme version most recently created.

If which is missing or invalid in the request, its value will default to last_activated.

Body parameter

{
  "variation_id": "string",
  "which": "original"
}

Responses

Status Meaning Description
204 No Content No content found to fulfill the request.
default Default Error message.

Example response – error

{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

getJob

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/themes/jobs/{job_id}', headers=headers)

print r.json()

GET /themes/jobs/{job_id}

Gets a specified job.

Parameters

Parameter In Type Required Description
job_id path string true The job identifier.

Responses

Status Meaning Description
200 OK The job.
default Default Error message.

Example response – success

{
  "data": {
    "errors": [
      {
        "error": "string",
        "message": "string"
      }
    ],
    "id": "string",
    "percent_complete": 0,
    "result": {
      "property1": "string",
      "property2": "string"
    },
    "status": "string",
    "time": "string",
    "warnings": [
      {
        "message": "string",
        "warning": "string"
      }
    ]
  },
  "meta": {}
}

Example response – error

{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Cart (Early Access)

This server-to-server API provides endpoints for creating a shopping cart on a BigCommerce store, and for modifying its contents.

POST /carts

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/carts', params={

}, headers = headers)

print r.json()

Creates a cart and generates a cart ID.

Parameters

Parameter In Type Required Description
cartData body CartRequestData true No description

Body parameter

{
  "line_items": [
    {
      "quantity": 0,
      "product_id": 0,
      "variant_id": 0
    }
  ],
  "gift_certificates": [
    {
      "name": "string",
      "theme": "string",
      "amount": 1,
      "quantity": 1,
      "sender": {},
      "recipient": {},
      "message": "string"
    }
  ]
}

Responses

Status Meaning Description
201 Created Returns Cart Entity object.

Example responses

{
  "id": "string",
  "currency": {
    "code": "string"
  },
  "is_tax_included": true,
  "base_amount": 0,
  "discount_amount": 0,
  "cart_amount": 0,
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "coupon_type": "string",
      "discounted_amount": 0
    }
  ],
  "discounts": [
    {
      "id": 0,
      "discounted_amount": 0
    }
  ],
  "line_items": [
    {
      "physical_items": [
        {
          "id": "string",
          "variant_id": 0,
          "product_id": 0,
          "name": "string",
          "url": "http://example.com",
          "quantity": 0,
          "is_taxable": true,
          "image_url": "http://example.com",
          "discounts": [
            {
              "id": 0,
              "discounted_amount": 0
            }
          ],
          "coupons": [
            {
              "id": "string",
              "code": "string",
              "name": "string",
              "slug": "string",
              "coupon_type": "string",
              "discounted_amount": 0
            }
          ],
          "discount_amount": 0,
          "coupon_amount": 0,
          "list_price": 0,
          "sale_price": 0,
          "extended_list_price": 0,
          "extended_sale_price": 0,
          "is_require_shipping": true,
          "gift_wrapping": {}
        }
      ],
      "digital_items": [
        {
          "id": "string",
          "variant_id": 0,
          "product_id": 0,
          "name": "string",
          "url": "http://example.com",
          "quantity": 0,
          "is_taxable": true,
          "image_url": "http://example.com",
          "discounts": [
            {
              "id": 0,
              "discounted_amount": 0
            }
          ],
          "coupons": [
            {
              "id": "string",
              "code": "string",
              "name": "string",
              "slug": "string",
              "coupon_type": "string",
              "discounted_amount": 0
            }
          ],
          "discount_amount": 0,
          "coupon_amount": 0,
          "list_price": 0,
          "sale_price": 0,
          "extended_list_price": 0,
          "extended_sale_price": 0,
          "download_file_urls": [
            "string"
          ],
          "download_page_url": "string",
          "download_size": "string"
        }
      ],
      "gift_certificates": [
        {
          "id": "string",
          "name": "string",
          "theme": "string",
          "amount": 0,
          "is_taxable": true,
          "sender": {},
          "recipient": {},
          "message": "string"
        }
      ]
    }
  ],
  "created_time": "string",
  "updated_time": "string"
}

POST /carts/{cartId}/items

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/carts/{cartId}/items', params={

}, headers = headers)

print r.json()

Adds line item(s) to the cart.

Parameters

Parameter In Type Required Description
cartId path string true No description
ItemData body CartRequestData true No description

Body parameter

{
  "line_items": [
    {
      "quantity": 0,
      "product_id": 0,
      "variant_id": 0
    }
  ],
  "gift_certificates": [
    {
      "name": "string",
      "theme": "string",
      "amount": 1,
      "quantity": 1,
      "sender": {},
      "recipient": {},
      "message": "string"
    }
  ]
}

Responses

Status Meaning Description
201 Created Returns Cart Entity object.

Example responses

{
  "id": "string",
  "currency": {
    "code": "string"
  },
  "is_tax_included": true,
  "base_amount": 0,
  "discount_amount": 0,
  "cart_amount": 0,
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "coupon_type": "string",
      "discounted_amount": 0
    }
  ],
  "discounts": [
    {
      "id": 0,
      "discounted_amount": 0
    }
  ],
  "line_items": [
    {
      "physical_items": [
        {
          "id": "string",
          "variant_id": 0,
          "product_id": 0,
          "name": "string",
          "url": "http://example.com",
          "quantity": 0,
          "is_taxable": true,
          "image_url": "http://example.com",
          "discounts": [
            {
              "id": 0,
              "discounted_amount": 0
            }
          ],
          "coupons": [
            {
              "id": "string",
              "code": "string",
              "name": "string",
              "slug": "string",
              "coupon_type": "string",
              "discounted_amount": 0
            }
          ],
          "discount_amount": 0,
          "coupon_amount": 0,
          "list_price": 0,
          "sale_price": 0,
          "extended_list_price": 0,
          "extended_sale_price": 0,
          "is_require_shipping": true,
          "gift_wrapping": {}
        }
      ],
      "digital_items": [
        {
          "id": "string",
          "variant_id": 0,
          "product_id": 0,
          "name": "string",
          "url": "http://example.com",
          "quantity": 0,
          "is_taxable": true,
          "image_url": "http://example.com",
          "discounts": [
            {
              "id": 0,
              "discounted_amount": 0
            }
          ],
          "coupons": [
            {
              "id": "string",
              "code": "string",
              "name": "string",
              "slug": "string",
              "coupon_type": "string",
              "discounted_amount": 0
            }
          ],
          "discount_amount": 0,
          "coupon_amount": 0,
          "list_price": 0,
          "sale_price": 0,
          "extended_list_price": 0,
          "extended_sale_price": 0,
          "download_file_urls": [
            "string"
          ],
          "download_page_url": "string",
          "download_size": "string"
        }
      ],
      "gift_certificates": [
        {
          "id": "string",
          "name": "string",
          "theme": "string",
          "amount": 0,
          "is_taxable": true,
          "sender": {},
          "recipient": {},
          "message": "string"
        }
      ]
    }
  ],
  "created_time": "string",
  "updated_time": "string"
}

POST /carts/{cartId}/redirect_urls

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.bigcommerce.com/stores/{{store_id}}/v3/{cartId}/redirect_urls', params={

}, headers = headers)

print r.json()

Creates a set of URLs to redirect the shopper to the BigCommerce store.

Parameters

Parameter In Type Required Description
cartId path string true No description

Responses

Status Meaning Description
201 Created Returns the object that contains the redirect_urls.

Example responses

{
  "cart_url": "string",
  "checkout_url": "string"
}

PUT /carts/{cartId}/items/{itemId}

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/carts/{cartId}/items/{itemId}', params={

}, headers = headers)

print r.json()

Updates an existing, single line item in the cart.

Parameters

Parameter In Type Required Description
cartId path string true No description
itemId path string true No description
lineItem body CartUpdateRequest true No description

Body parameter

{
  "line_item": {
    "quantity": 0,
    "product_id": 0,
    "variant_id": 0
  },
  "gift_certificate": {
    "name": "string",
    "theme": "string",
    "amount": 1,
    "quantity": 1,
    "sender": {},
    "recipient": {},
    "message": "string"
  }
}

Responses

Status Meaning Description
200 OK Returns Cart Entity object.

Example responses

{
  "id": "string",
  "currency": {
    "code": "string"
  },
  "is_tax_included": true,
  "base_amount": 0,
  "discount_amount": 0,
  "cart_amount": 0,
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "coupon_type": "string",
      "discounted_amount": 0
    }
  ],
  "discounts": [
    {
      "id": 0,
      "discounted_amount": 0
    }
  ],
  "line_items": [
    {
      "physical_items": [
        {
          "id": "string",
          "variant_id": 0,
          "product_id": 0,
          "name": "string",
          "url": "http://example.com",
          "quantity": 0,
          "is_taxable": true,
          "image_url": "http://example.com",
          "discounts": [
            {
              "id": 0,
              "discounted_amount": 0
            }
          ],
          "coupons": [
            {
              "id": "string",
              "code": "string",
              "name": "string",
              "slug": "string",
              "coupon_type": "string",
              "discounted_amount": 0
            }
          ],
          "discount_amount": 0,
          "coupon_amount": 0,
          "list_price": 0,
          "sale_price": 0,
          "extended_list_price": 0,
          "extended_sale_price": 0,
          "is_require_shipping": true,
          "gift_wrapping": {}
        }
      ],
      "digital_items": [
        {
          "id": "string",
          "variant_id": 0,
          "product_id": 0,
          "name": "string",
          "url": "http://example.com",
          "quantity": 0,
          "is_taxable": true,
          "image_url": "http://example.com",
          "discounts": [
            {
              "id": 0,
              "discounted_amount": 0
            }
          ],
          "coupons": [
            {
              "id": "string",
              "code": "string",
              "name": "string",
              "slug": "string",
              "coupon_type": "string",
              "discounted_amount": 0
            }
          ],
          "discount_amount": 0,
          "coupon_amount": 0,
          "list_price": 0,
          "sale_price": 0,
          "extended_list_price": 0,
          "extended_sale_price": 0,
          "download_file_urls": [
            "string"
          ],
          "download_page_url": "string",
          "download_size": "string"
        }
      ],
      "gift_certificates": [
        {
          "id": "string",
          "name": "string",
          "theme": "string",
          "amount": 0,
          "is_taxable": true,
          "sender": {},
          "recipient": {},
          "message": "string"
        }
      ]
    }
  ],
  "created_time": "string",
  "updated_time": "string"
}

DELETE /carts/{cartId}/items/{itemId}

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('https://api.bigcommerce.com/stores/{{store_id}}/v3/carts/{cartId}/items/{itemId}', params={

}, headers = headers)

print r.json()

Removes a line item from the cart.

Parameters

Parameter In Type Required Description
cartId path string true No description
itemId path string true No description

Responses

Status Meaning Description
200 OK Returns Cart Entity object.
204 No Content If the action’s result is an empty cart, the cart gets automatically deleted.

Example responses

{
  "id": "string",
  "currency": {
    "code": "string"
  },
  "is_tax_included": true,
  "base_amount": 0,
  "discount_amount": 0,
  "cart_amount": 0,
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "coupon_type": "string",
      "discounted_amount": 0
    }
  ],
  "discounts": [
    {
      "id": 0,
      "discounted_amount": 0
    }
  ],
  "line_items": [
    {
      "physical_items": [
        {
          "id": "string",
          "variant_id": 0,
          "product_id": 0,
          "name": "string",
          "url": "http://example.com",
          "quantity": 0,
          "is_taxable": true,
          "image_url": "http://example.com",
          "discounts": [
            {
              "id": 0,
              "discounted_amount": 0
            }
          ],
          "coupons": [
            {
              "id": "string",
              "code": "string",
              "name": "string",
              "slug": "string",
              "coupon_type": "string",
              "discounted_amount": 0
            }
          ],
          "discount_amount": 0,
          "coupon_amount": 0,
          "list_price": 0,
          "sale_price": 0,
          "extended_list_price": 0,
          "extended_sale_price": 0,
          "is_require_shipping": true,
          "gift_wrapping": {}
        }
      ],
      "digital_items": [
        {
          "id": "string",
          "variant_id": 0,
          "product_id": 0,
          "name": "string",
          "url": "http://example.com",
          "quantity": 0,
          "is_taxable": true,
          "image_url": "http://example.com",
          "discounts": [
            {
              "id": 0,
              "discounted_amount": 0
            }
          ],
          "coupons": [
            {
              "id": "string",
              "code": "string",
              "name": "string",
              "slug": "string",
              "coupon_type": "string",
              "discounted_amount": 0
            }
          ],
          "discount_amount": 0,
          "coupon_amount": 0,
          "list_price": 0,
          "sale_price": 0,
          "extended_list_price": 0,
          "extended_sale_price": 0,
          "download_file_urls": [
            "string"
          ],
          "download_page_url": "string",
          "download_size": "string"
        }
      ],
      "gift_certificates": [
        {
          "id": "string",
          "name": "string",
          "theme": "string",
          "amount": 0,
          "is_taxable": true,
          "sender": {},
          "recipient": {},
          "message": "string"
        }
      ]
    }
  ],
  "created_time": "string",
  "updated_time": "string"
}

GET /carts/{cartId}

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.get('https://api.bigcommerce.com/stores/{{store_id}}/v3/carts/{cartId}', params={

}, headers = headers)

print r.json()

Returns information about a given Cart, specified by its ID.

Parameters

Parameter In Type Required Description
cartId path string true The identifier of a specific cart.

Responses

Status Meaning Description
200 OK Returns Cart Entity object.
404 Not Found Cart not found.

Example responses

{
  "id": "string",
  "currency": {
    "code": "string"
  },
  "is_tax_included": true,
  "base_amount": 0,
  "discount_amount": 0,
  "cart_amount": 0,
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "coupon_type": "string",
      "discounted_amount": 0
    }
  ],
  "discounts": [
    {
      "id": 0,
      "discounted_amount": 0
    }
  ],
  "line_items": [
    {
      "physical_items": [
        {
          "id": "string",
          "variant_id": 0,
          "product_id": 0,
          "name": "string",
          "url": "http://example.com",
          "quantity": 0,
          "is_taxable": true,
          "image_url": "http://example.com",
          "discounts": [
            {
              "id": 0,
              "discounted_amount": 0
            }
          ],
          "coupons": [
            {
              "id": "string",
              "code": "string",
              "name": "string",
              "slug": "string",
              "coupon_type": "string",
              "discounted_amount": 0
            }
          ],
          "discount_amount": 0,
          "coupon_amount": 0,
          "list_price": 0,
          "sale_price": 0,
          "extended_list_price": 0,
          "extended_sale_price": 0,
          "is_require_shipping": true,
          "gift_wrapping": {}
        }
      ],
      "digital_items": [
        {
          "id": "string",
          "variant_id": 0,
          "product_id": 0,
          "name": "string",
          "url": "http://example.com",
          "quantity": 0,
          "is_taxable": true,
          "image_url": "http://example.com",
          "discounts": [
            {
              "id": 0,
              "discounted_amount": 0
            }
          ],
          "coupons": [
            {
              "id": "string",
              "code": "string",
              "name": "string",
              "slug": "string",
              "coupon_type": "string",
              "discounted_amount": 0
            }
          ],
          "discount_amount": 0,
          "coupon_amount": 0,
          "list_price": 0,
          "sale_price": 0,
          "extended_list_price": 0,
          "extended_sale_price": 0,
          "download_file_urls": [
            "string"
          ],
          "download_page_url": "string",
          "download_size": "string"
        }
      ],
      "gift_certificates": [
        {
          "id": "string",
          "name": "string",
          "theme": "string",
          "amount": 0,
          "is_taxable": true,
          "sender": {},
          "recipient": {},
          "message": "string"
        }
      ]
    }
  ],
  "created_time": "string",
  "updated_time": "string"
}

Storefront Widgets (Early Access)

Widget Template Endpoints

The following operations handle Widget Templates.

createWidgetTemplate

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{store_id}/v3/content/widget-templates', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /content/widget-templates

Creates a widget template.

Body parameter

{
  "name": "string",
  "schema": {},
  "template": "string"
}

Parameters

Parameter Type Required Description
body WidgetTemplatePost true No description
name string true User friendly name.
schema object(json) true The JSON schema of data for this template. Used to validate a configuration.
template string(html) true Handlebars HTML content. Also has access to Stencil Paper helpers.

Example responses

{
  "data": {
    "uuid": "string",
    "name": "string",
    "kind": "string",
    "schema": {},
    "template": "string",
    "date_created": "string",
    "date_modified": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
201 Created A widget template. WidgetTemplateResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

getWidgetTemplates

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/widget-templates', headers=headers)

print r.json()

GET /content/widget-templates

Gets all widget templates.

Parameters

Parameter Type Required Description
page integer false Specifies the page number in a limited (paginated) list of products.
limit integer false Controls the number of items per page in a limited (paginated) list of products.
widget_template_kind string false The kind of widget template.

Example responses

{
  "data": [
    {
      "uuid": "string",
      "name": "string",
      "kind": "string",
      "schema": {},
      "template": "string",
      "date_created": "string",
      "date_modified": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success WidgetTemplatesResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

getWidgetTemplate

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/widget-templates/{uuid}', headers=headers)

print r.json()

GET /content/widget-templates/{uuid}

Gets a widget template.

Parameters

Parameter Type Required Description
uuid string(uuid) true The identifier for a specific template.

Example responses

{
  "data": {
    "uuid": "string",
    "name": "string",
    "kind": "string",
    "schema": {},
    "template": "string",
    "date_created": "string",
    "date_modified": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success WidgetTemplateResponse
404 Not Found The resource was not found. ErrorResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

updateWidgetTemplate

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{store_id}/v3/content/widget-templates/{uuid}', params={
 # Coming Soon 
 },
    headers=headers

)

print r.json()

PUT /content/widget-templates/{uuid}

Updates a widget template.

Body parameter

{
  "name": "string",
  "schema": {},
  "template": "string"
}

Parameters

Parameter Type Required Description
uuid string(uuid)(uuid) true The identifier for a specific template.
body WidgetTemplatePut true No description
name string false User-friendly name.
schema object(json) false The schema for this template. Describes how to build dynamic forms for widget configurations.
template string(html) false Handlebars HTML content. Also has access to Stencil Paper helpers.

Example responses

{
  "data": {
    "uuid": "string",
    "name": "string",
    "kind": "string",
    "schema": {},
    "template": "string",
    "date_created": "string",
    "date_modified": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success WidgetTemplateResponse
404 Not Found The resource was not found. ErrorResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

deleteWidgetTemplate

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{store_id}/v3/content/widget-templates/{uuid}', headers=headers)

print r.json()

DELETE /content/widget-templates/{uuid}

Deletes a widget template.

Parameters

Parameter Type Required Description
uuid string(uuid)(uuid)(uuid) true The identifier for a specific template.

Example responses

{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
204 No Content An empty response. None
404 Not Found The resource was not found. ErrorResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

Widget Endpoints

The following operations handle Widgets.

createWidget

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{store_id}/v3/content/widgets', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /content/widgets

Creates a widget.

Body parameter

{
  "name": "string",
  "widget_configuration": {},
  "widget_template_uuid": "string"
}

Parameters

Parameter Type Required Description
body WidgetPost true No description
name string true User friendly name.
widget_configuration object(json) true The JSON data that populates the template.
widget_template_uuid string true The widget template UUID.

Example responses

{
  "data": {
    "uuid": "string",
    "name": "string",
    "widget_configuration": {},
    "widget_template": {
      "uuid": "string",
      "name": "string",
      "kind": "string",
      "schema": {},
      "template": "string",
      "date_created": "string",
      "date_modified": "string"
    },
    "date_created": "string",
    "date_modified": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success WidgetResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

getWidgets

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/widgets', headers=headers)

print r.json()

GET /content/widgets

Gets all widgets.

Parameters

Parameter Type Required Description
page integer false Specifies the page number in a limited (paginated) list of products.
limit integer false Controls the number of items per page in a limited (paginated) list of products.
widget_template_kind string false The kind of widget template.

Example responses

{
  "data": [
    {
      "uuid": "string",
      "name": "string",
      "widget_configuration": {},
      "widget_template": {
        "uuid": "string",
        "name": "string",
        "kind": "string",
        "schema": {},
        "template": "string",
        "date_created": "string",
        "date_modified": "string"
      },
      "date_created": "string",
      "date_modified": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success WidgetsResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

getWidget

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/widgets/{uuid}', headers=headers)

print r.json()

GET /content/widgets/{uuid}

Gets a widget.

Parameters

Parameter Type Required Description
uuid string(uuid) true The identifier for a specific widget.

Example responses

{
  "data": {
    "uuid": "string",
    "name": "string",
    "widget_configuration": {},
    "widget_template": {
      "uuid": "string",
      "name": "string",
      "kind": "string",
      "schema": {},
      "template": "string",
      "date_created": "string",
      "date_modified": "string"
    },
    "date_created": "string",
    "date_modified": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success WidgetResponse
404 Not Found The resource was not found. ErrorResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

updateWidget

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{store_id}/v3/content/widgets/{uuid}', params={
 # Coming Soon 
 },
    headers=headers

)

print r.json()

PUT /content/widgets/{uuid}

Updates a widget.

Body parameter

{
  "name": "string",
  "widget_configuration": {},
  "widget_template_uuid": "string"
}

Parameters

Parameter Type Required Description
uuid string(uuid)(uuid) true The identifier for a specific widget.
body WidgetPut true No description
name string false User-friendly name.
widget_configuration object(json) false The JSON data that populates the template.
widget_template_uuid string false The widget template UUID.

Example responses

{
  "data": {
    "uuid": "string",
    "name": "string",
    "widget_configuration": {},
    "widget_template": {
      "uuid": "string",
      "name": "string",
      "kind": "string",
      "schema": {},
      "template": "string",
      "date_created": "string",
      "date_modified": "string"
    },
    "date_created": "string",
    "date_modified": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success WidgetResponse
404 Not Found The resource was not found. ErrorResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

deleteWidget

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{store_id}/v3/content/widgets/{uuid}', headers=headers)

print r.json()

DELETE /content/widgets/{uuid}

Deletes a widget.

Parameters

Parameter Type Required Description
uuid string(uuid)(uuid)(uuid) true The identifier for a specific widget.

Example responses

{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
204 No Content An empty response. None
404 Not Found The resource was not found. ErrorResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

searchWidgets

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/widgets/search', headers=headers)

print r.json()

GET /content/widgets/search

Gets all widgets by search.

Parameters

Parameter Type Required Description
page integer false Specifies the page number in a limited (paginated) list of products.
limit integer false Controls the number of items per page in a limited (paginated) list of products.
query string false The query string associated with a widget’s name and description.
{
  "data": [
    {
      "uuid": "string",
      "name": "string",
      "description": "string",
      "widget_configuration": {},
      "widget_template": {
        "uuid": "string",
        "name": "string",
        "kind": "string",
        "schema": {},
        "template": "string",
        "date_created": "string",
        "date_modified": "string"
      },
      "date_created": "string",
      "date_modified": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success WidgetsResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

Placement Endpoints

The following operations handle Placements on storefront pages.

createPlacement

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{store_id}/v3/content/placements', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /content/placements

Creates a placement.

Body parameter

{
  "widget_uuid": "string",
  "entity_id": "string",
  "sort_order": "string",
  "region": "string",
  "template_file": "string",
  "status": "inactive"
}

Parameters

Parameter Type Required Description
body PlacementPost true No description
widget_uuid string true A widget identifier.
entity_id string false The specific instance of a page that you would like to target.
sort_order string false The sorting order to control the position of a content widget in a region.
region string true The name of the region in which to insert content widgets.
template_file string true The template file that you would like to target.
status string false Sets the placement as inactive (the default) or active.

Enumerated Values

Parameter Value
status inactive
status active

Example responses

{
  "data": [
    {
      "uuid": "string",
      "entity_id": "string",
      "status": "inactive",
      "template_file": "string",
      "region": "string",
      "widget": {
        "uuid": "string",
        "name": "string",
        "widget_configuration": {},
        "widget_template": {
          "uuid": "string",
          "name": "string",
          "kind": "string",
          "schema": {},
          "template": "string",
          "date_created": "string",
          "date_modified": "string"
        },
        "date_created": "string",
        "date_modified": "string"
      },
      "date_created": "string",
      "date_modified": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
201 Created A placement. PlacementResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

getPlacements

Code samples

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/placements', headers=headers)

print r.json()

GET /content/placements

Gets all placements.

Parameters

Parameter Type Required Description
page integer false Specifies the page number in a limited (paginated) list of products.
limit integer false Controls the number of items per page in a limited (paginated) list of products.
widget_template_kind string false The kind of widget template.
template_file string false The template file, for example, pages/home.

Example responses

{
  "data": [
    {
      "uuid": "string",
      "entity_id": "string",
      "status": "inactive",
      "template_file": "string",
      "region": "string",