NAV
  • v3 API Reference
  • Catalog
  • Customers
  • Orders
  • Object References
  • 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 Products 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.
    keyword query string false Filter items by keywords found in the name, description, sku, keywords, or 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 Include sub-resources on a product, with a comma-separated list. Valid expansions currently include variants, images, custom_fields, and bulk_pricing_rules.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't be excluded.
    availability query string false Filter items by availability. Values are: available, disabled, preorder.
    page query integer false Control the page in a limited list of products.
    limit query integer false Control the items per page.
    direction query string false Sort direction. 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, sku, keywords, or 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 the resource belongs to.
    include query string false Include sub-resources on a product, with a comma-separated list. Valid expansions currently include variants, images, custom_fields, and bulk_pricing_rules.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 the result of duplicate unique values such as name or SKU, a missing category, brand, or tax_class that the product is being associate to, 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 the resource belongs to.

    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 the resource belongs to.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 image on a product.

    Parameters

    Parameter In Type Required Description
    product_id path integer true The ID of the Product the resource belongs to.
    image_id path integer true The ID of the Image that is being operated on.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 the resource belongs to.
    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 the resource belongs to.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 the resource belongs to.
    video_id path string true The ID of the Video being operated on.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 the resource belongs to.
    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 the resource belongs to.
    page query integer false Control the page in a limited list of products.
    limit query integer false Control the items per page.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    Variant body VariantPost true 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 the resource belongs to.
    variant_id path number true The ID of the Variant to which the resource belongs.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 the resource belongs to.
    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 the resource belongs to.
    variant_id path number true The ID of the Variant to which the resource belongs.
    page query integer false Control the page in a limited list of products.
    limit query integer false Control the items per page.
    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 Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 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"
      }
    }
    

    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 the resource belongs to.
    variant_id path number true The ID of the Variant to which the resource belongs.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 the resource belongs to.
    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 the resource belongs to.
    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 the resource belongs to.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 the resource belongs to.
    option_id path integer true The ID of the Option.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 the resource belongs to.
    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 the resource belongs to.
    option_id path integer true The ID of the Option.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    option_id path integer true The ID of the Option.
    OptionValue body OptionValuePost true A OptionValue object.

    Body parameter

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

    Responses

    Status Meaning Description
    200 OK A 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 a 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 the resource belongs to.
    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 Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 OptionValue object.

    Body parameter

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

    Responses

    Status Meaning Description
    200 OK A 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 the resource belongs to.
    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 the resource belongs to.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 the resource belongs to.
    modifier_id path integer true The ID of the Modifier.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 an 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 the resource belongs to.
    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 the resource belongs to.
    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 the resource belongs to.
    modifier_id path integer true The ID of the Modifier.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 the resource belongs to.
    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 Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 the resource belongs to.
    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 the resource belongs to.
    modifier_id path integer true The ID of the Modifier.
    value_id path integer true The ID of the Modifier.
    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, orof 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 applied to show when the modifier value is selected

    Parameters

    Parameter In Type Required Description
    product_id path integer true The ID of the Product the resource belongs to.
    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 cleared for 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 the resource belongs to.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    ComplexRule body ComplexRulePost 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
      },
      "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 the resource belongs to.
    complex_rule_id path integer true The ID of the ComplexRule.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 the resource belongs to.
    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 the resource belongs to.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 the resource belongs to.
    custom_field_id path integer true The ID of the CustomField.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 the resource belongs to.
    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 the resource belongs to.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    BulkPricingRule body BulkPricingRulePost true 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 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 the resource belongs to.
    bulk_pricing_rule_id path integer true The ID of the BulkPricingRule.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    bulk_pricing_rule_id path integer true The ID of the BulkPricingRule.
    BulkPricingRule body BulkPricingRulePut true 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 the resource belongs to.
    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 the resource belongs to.
    page query integer false Control the page in a limited list of products.
    limit query integer false Control the items per page.
    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 Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 the resource belongs to.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 the resource belongs to.
    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 the resource belongs to.

    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 Control the page in a limited list of products.
    limit query integer false Control the items per page.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 a product or products 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 Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 Control the page in a limited list of products.
    limit query integer false Control the items per page.
    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 Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 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"
      }
    }
    

    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 Control the page in a limited list of products.
    limit query integer false Control the items per page.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 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 product. 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 Control the page in a limited list of products.
    limit query integer false Control the items per page.
    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 Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 combination 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 Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 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"
      }
    }
    

    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 Control the page in a limited list of products.
    limit query integer false Control the items per page.
    include_fields query string false Include fields, with a comma-separated list. The ID and provided fields will be returned.
    exclude_fields query string false Exclude fields, with a comma-separated list. Provided fields will be excluded from a response. The ID can't 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 Subscribers collection.

    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 Control the page in a limited list of products.
    limit query integer false Control the items per page.

    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 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 the result of duplicate unique values such as email
    422 Unprocessable Entity The Subscriber was not valid. This is the result of missing required fields or 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 a Subscriber or Subscribers 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 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 the result of missing required fields, or of 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 transactions.
    204 No Content No content found to fulfill 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"
    }
    

    Object References

    ModifierBase

    Name Type Description
    type string The type of modifier, which determines how it will display on the storefront. For reference, former v2 API values: D = date, C = checkbox, F = file, T = text, MT = multi_line_text, N = numbers_only_text, RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
    required boolean Whether this modifer is required or not at checkout
    config
    option_values array

    OptionBase

    Name Type Description
    id integer The unique numerical ID of the option, increments sequentially.
    product_id integer The unique numerical ID of the product that the option belongs to.
    display_name string The name of the option shown on the storefront.
    type string The type of option, which determines how it will display on the storefront. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
    config
    option_values array

    CategoryNode

    Name Type Description
    id integer The unique numeric ID of the category; increments sequentially.
    parent_id integer The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog.
    name string The name displayed for the category. Name is unique with respect to the category's siblings.
    is_visible boolean Flag to determine whether the product should be displayed to customers browsing the store. If true, the category will be displayed. If false, the category will be hidden from view.
    url string The custom URL for the category on the storefront.
    children array The list of children of the category.

    CategoryBase

    Name Type Description
    parent_id integer The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog.
    name string The name displayed for the category. Name is unique with respect to the category's siblings.
    description string The product description, which can include HTML formatting.
    views integer Number of views the category has on the storefront.
    sort_order integer Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be.
    page_title string Custom title for the category page, if not defined the category name will be used as the meta title.
    search_keywords string A comma separated list of keywords that can be used to locate the category when searching the store.
    meta_keywords array Custom meta keywords for the category page. If not defined, the store's default keywords will be used. Must post as an array like: ["awesome","sauce"].
    meta_description string Custom meta description for the category page. If not defined, the store's default meta description will be used.
    layout_file string The layout template file used to render this category.
    is_visible boolean Flag to determine whether the product should be displayed to customers browsing the store. If true, the category will be displayed. If false, the category will be hidden from view.
    default_product_sort string Determines how the products are sorted on category page load.
    image_url string Image URL used for this category on the storefront. Images can be uploaded via form file post to /categories/{categoryId}/image, or by providing a publicly accessible URL in this field.
    custom_url

    BrandBase

    Name Type Description
    name string The name of the brand. Must be unique.
    page_title string The title shown in the browser while viewing the brand.
    meta_keywords array Comma separated list of meta keywords to include in the HTML.
    meta_description string A meta description to include.
    search_keywords string A comma separated list of keywords that can be used to locate this brand.
    image_url string Image URL used for this category on the storefront. Images can be uploaded via form file post to /brands/{brandId}/image, or by providing a publicly accessible URL in this field.

    SubscriberBase

    Name Type Description
    id integer The unique numeric ID of the subscriber; increments sequentially.
    email string The email of the subscriber. Must be unique.
    first_name string The first name of the subscriber.
    last_name string The last name of the subscriber.
    source string The source of the subscriber. Values are: storefront, order, or custom.
    order_id integer The ID of the source order, if source was an order.

    VariantBase

    Name Type Description
    cost_price number The cost price of the variant.
    price number This variant's base price on the storefront. If this value is null, the product's default price (set in the Product resource's price field) will be used as the base price.
    weight number This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
    purchasing_disabled boolean If true, this variant will not be purchasable on the storefront.
    purchasing_disabled_message string If purchasing_disabled is true, this message should show on the storefront when the variant is selected.
    image_url string The image that will be displayed when this variant is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF. Generic product images not specific to the variant should be stored on the product.
    upc string The UPC code used in feeds for shopping comparison sites and external channel integrations.
    inventory_level integer Inventory level for the variant, which is used when the product's inventory_tracking is set to variant
    inventory_warning_level integer When the variant hits this inventory level, it is considered low stock.
    bin_picking_number string Identifies where in a warehouse the variant is located.

    OptionValueProductBase

    Name Type Description
    option_display_name string The name of the option.
    label string The label of the option value.

    OptionValueVariantPost

    Name Type Description
    id integer
    option_id integer

    OptionValueBase

    Name Type Description
    is_default boolean The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
    label string The text display identifying the value on the storefront.
    sort_order integer The order in which the value will be displayed on the product page.
    value_data object Extra data describing the value, based on the type of option or modifier with which the value is associated. swatch requires an array of colors, with up to three hexidecimal color keys; product list requires a product_id; and checkbox requires a boolean flag, called checked_value, to determine which value is considered to be the checked state.

    ProductImageBase

    Name Type Description
    is_thumbnail boolean Flag for identifying whether the image is used as the product's thumbnail.
    sort_order integer The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a sort_order the same as or greater than the image's new sort_order value will have their sort_orders reordered.
    description string The description for the image.

    ProductVideoBase

    Name Type Description
    title string The title for the video. If left blank, this will be filled in according to data on YouTube.
    description string The description for the video. If left blank, this will be filled in according to data on YouTube.
    sort_order integer The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a sort_order the same as or greater than the video's new sort_order value will have their sort_orders reordered.

    ResourceImage

    Name Type Description
    image_url string A public URL for a GIF, JPEG, or PNG image.

    ProductBase

    Name Type Description
    name string The product name.
    type string The product type: physical - a physical stock unit, digital - a digital download
    sku string User defined product code/stock keeping unit (SKU).
    description string The product description, which can include HTML formatting.
    weight number Weight of the product, which can be used when calculating shipping costs.
    width number Width of the product, which can be used when calculating shipping costs.
    depth number Depth of the product, which can be used when calculating shipping costs.
    height number Height of the product, which can be used when calculating shipping costs.
    price number The price of the product. The price should include or exclude tax, based on the store settings.
    cost_price number The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store.
    retail_price number The retail cost of the product. If entered, the retail cost price will be shown on the product page.
    sale_price number If entered, the sale price will be used instead of value in the price field when calculating the product's cost.
    tax_class_id integer The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)
    product_tax_code string Accepts AvaTax System Tax Codes, which identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to Avalara Premium can calculate sales taxes more accurately. Stores without Avalara Premium will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see Avalara's documentation.
    categories array An array of IDs for the categories to which this product belongs. When updating a product, if an array of categories is supplied, all product categories will be overwritten. Does not accept more than 1,000 ID values.
    brand_id integer The ID associated with the product's brand.
    inventory_level integer Current inventory level of the product. Simple inventory tracking must be enabled (See the inventory_tracking field) for this to take any effect.
    inventory_warning_level integer Inventory Warning level for the product. When the product's inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the inventory_tracking field) for this to take any effect.
    inventory_tracking string The type of inventory tracking for the product. Values are: none - inventory levels will not be tracked; product - inventory levels will be tracked using the inventory_level and inventory_warning_level fields; variant - inventory levels will be tracked based on variants, which maintain their own warning levels and inventory levels.
    fixed_cost_shipping_price number A fixed shipping cost for the product. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
    is_free_shipping boolean Flag used to indicate whether the product has free shipping. If true, the shipping cost for the product will be zero.
    is_visible boolean Flag to determine whether the product should be displayed to customers browsing the store. If true, the product will be displayed. If false, the product will be hidden from view.
    is_featured boolean Flag to determine whether the product should be included in the featured products panel when viewing the store.
    related_products array An array of IDs for the related products.
    warranty string Warranty information displayed on the product page. Can include HTML formatting.
    bin_picking_number string The BIN picking number for the product.
    layout_file string The layout template file used to render this product.
    upc string The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations.
    search_keywords string A comma-separated list of keywords that can be used to locate the product when searching the store.
    availability string Availability of the product. Availability options are: available - the product can be purchased in the storefront; disabled - the product is listed in the storefront, but cannot be purchased; preorder - the product is listed for pre-orders.
    availability_description string Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours.'
    gift_wrapping_options_type string Type of gift-wrapping options. Values: any - allow any gift-wrapping options in the store; none - disallow gift-wrapping on the product; list – provide a list of IDs in gift_wrapping_options_list field.
    gift_wrapping_options_list array A list of gift-wrapping option IDs.
    sort_order integer Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results.
    condition string The product condition. Will be shown on the product page if the is_condition_shown field's value is true. Possible values: New, Used, Refurbished.
    is_condition_shown boolean Flag used to determine whether the product condition is shown to the customer on the product page.
    order_quantity_minimum integer The minimum quantity an order must contain, to be eligible to purchase this product.
    order_quantity_maximum integer The maximum quantity an order can contain when purchasing the product.
    page_title string Custom title for the product page. If not defined, the product name will be used as the meta title.
    meta_keywords array Custom meta keywords for the product page. If not defined, the store's default keywords will be used.
    meta_description string Custom meta description for the product page. If not defined, the store's default meta description will be used.
    view_count integer The number of times the product has been viewed.
    preorder_release_date string Pre-order release date. See the availability field for details on setting a product's availability to accept pre-orders.
    preorder_message string Custom expected-date message to display on the product page. If , the message defaults to the storewide setting. Can contain the %%DATE%% placeholder, which will be substituted for the release date.
    is_preorder_only boolean If set to false, the product will not change its availability from preorder to available on the release date. Otherwise, on the release date the product's availability/status will change to available.
    is_price_hidden boolean False by default, indicating that this product's price should be shown on the product page. If set to true, the price is hidden. (NOTE: To successfully set is_price_hidden to true, the availability value must be disabled.)
    price_hidden_label string By default, an empty string. If is_price_hidden is true, the value of price_hidden_label is displayed instead of the price. (NOTE: To successfully set a non-empty string value with is_price_hidden set to true, the availability value must be disabled.)
    custom_url

    CatalogSummary

    Name Type Description
    inventory_count integer A count of all inventory items in the catalog.
    inventory_value number Total value of store's inventory.
    primary_category_id integer ID of the category containing the most products.
    primary_category_name string Name of the category containing the most products.

    MetafieldBase

    Name Type Description
    permission_set string Determines whether the field is completely private to the app that owns the field (app_only), or visible to other API consumers (read), or completely open for reading and writing to other apps (write).
    namespace string Namespace for the metafield, for organizational purposes.
    key string The name of the field, for example: location_id, color.
    value string The value of the field, for example: 1, blue.
    description string Description for the metafields.
    resource_type string The type of resource that the metafield is associated with.
    resource_id integer The unique identifier for the resource with which the metafield is associated.

    ComplexRuleBase

    Name Type Description
    product_id integer The unique numeric ID of the product with which the rule is associated; increments sequentially.
    sort_order integer Priority this rule will be given, when making adjustments to the product properties.
    enabled boolean Flag for determining whether the rule is to be used when adjusting a product's price, weight, image, or availabilty.
    stop boolean Flag for determining whether other rules should not be applied after this rule has been applied.
    purchasing_disabled boolean Flag for determining whether the rule should disable purchasing of a product when the conditions are applied.
    purchasing_disabled_message string Message displayed on the storefront when a rule disables the purchasing of a product.
    purchasing_hidden boolean Flag for determining whether the rule should hide purchasing of a product when the conditions are applied.
    price_adjuster
    weight_adjuster

    CustomFieldBase

    Name Type Description
    name string The name of the field, shown on the storefront, orders, etc.
    value string The name of the field, shown on the storefront, orders, etc.

    ComplexRuleConditionBase

    Name Type Description
    id integer The unique numeric ID of the rule condition; increments sequentially.
    rule_id integer The unique numeric ID of the rule with which the condition is associated.
    modifier_id integer The unique numeric ID of the modifier with which the rule condition is associated.
    modifier_value_id integer The unique numeric ID of the modifier value with which the rule condition is associated.
    variant_id integer The unique numeric ID of the variant the rule condition is associated with.

    CustomUrlProduct

    Name Type Description
    url string Product URL on the storefront.
    is_customized boolean Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).

    CustomUrlCategory

    Name Type Description
    url string Category URL on the storefront.
    is_customized boolean Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).

    BulkPricingRuleBase

    Name Type Description
    quantity_min integer The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero.
    quantity_max integer The maximum inclusive quantity of a product to satisfy this rule. Must be greater than the quantity_min value – unless this field has a value of 0 (zero), in which case there will be no maximum bound for this rule.
    type string The type of adjustment that is made. Values: price - the adjustment amount per product; percent - the adjustment as a percentage of the original price; fixed - the adjusted absolute price of the product.
    amount number The value of the adjustment by the bulk pricing rule.

    OptionConfig

    Name Type Description
    default_value string (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
    checked_by_default boolean (checkbox) Flag for setting the checkbox to be checked by default.
    checkbox_label string (checkbox) Label displayed for the checkbox option.
    date_limited boolean (date) Flag to limit the dates allowed to be entered on a date option.
    date_limit_mode string (date) The type of limit that is allowed to be entered on a date option.
    date_earliest_value string (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    date_latest_value string (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
    file_types_mode string (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: specific - restricts uploads to particular file types; all - allows all file types.
    file_types_supported array (file) The type of files allowed to be uploaded if the file_type_option is set to specific. Values: images - Allows upload of image MIME types (bmp,gif,jpg,jpeg,jpe,jif,jfif,jfi,png,wbmp,xbm,tiff). documents - Allows upload of document MIME types (txt,pdf,rtf,doc,docx,xls,xlsx,accdb,mdb,one,pps,ppsx,ppt,pptx,pub,odt,ods,odp,odg,odf). other - Allows file types defined in the file_types_other array.
    file_types_other array (file) A list of other file types allowed with the file upload option.
    file_max_size integer (file) The maximum size for a file that can be used with the file upload option.
    text_characters_limited boolean (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
    text_min_length integer (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
    text_max_length integer (text, multi_line_text) The maximum length allowed for a text or multi line text option.
    text_lines_limited boolean (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
    text_max_lines integer (multi_line_text) The maximum number of lines allowed on a multi-line text input.
    number_limited boolean (numbers_only_text) Flag to limit the value of a number option.
    number_limit_mode string (numbers_only_text) The type of limit on values entered for a number option.
    number_lowest_value number (numbers_only_text) The lowest allowed value for a number option if number_limited is true.
    number_highest_value number (numbers_only_text) The highest allowed value for a number option if number_limited is true.
    number_integers_only boolean (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
    product_list_adjusts_inventory boolean (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
    product_list_adjusts_pricing boolean (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
    product_list_shipping_calc string (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: none - don't adjust; weight - use shipping weight only; package - use weight and dimensions.

    Adjuster

    Name Type Description
    adjuster string The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.
    adjuster_value number The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.

    BaseError

    Name Type Description
    status integer The HTTP status code.
    title string The error title describing the particular error.
    type string
    instance string

    NotFound

    Name Type Description
    status integer 404 HTTP status code.
    title string The error title describing the particular error.
    type string
    instance string

    CreditCard

    Name Type Description
    card_type string The credit-card type: Visa, MasterCard, etc.
    card_iin string The IIN of a credit-card number.
    card_last4 string The last 4 digits of a credit-card number.

    StoreCredit

    Name Type Description
    remaining_balance string Remaining balance of shopper's store credit.

    Custom

    Name Type Description
    payment_method string Text entered for payment in the control panel.

    Offline

    Name Type Description
    display_name string Display name for the offline payment.

    GiftCertificate

    Name Type Description
    code string The gift-certificate code.
    original_balance string The balance on a gift certificate when it was purchased.
    starting_balance string The balance on a gift certificate at the time of this purchase.
    remaining_balance string The remaining balance on a gift certificate.
    status string The status of a gift certificate: active - gift certificate is active; pending - gift certificate purchase is pending; disabled - gift certificate is disabled; expired - gift certificate is expired.

    AVSResult

    Name Type Description
    code string AVS code.
    message string AVS message.
    street_match string AVS Code for street matching result.
    postal_match string AVS Code for postal matching result.

    CVVResult

    Name Type Description
    code string CVV code.
    message string CVV message.

    NoContent

    Name Type Description
    status integer 204 HTTP status code.
    title string The error title describing the situation.
    type string
    instance string