Thanks for being patient while we implement your feedback to improve the developer experience.

Get All Variants

GET /catalog/variants

Request

Returns a list of all variants in your catalog. Optional parameters can be passed in.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string - required

    The MIME type of the response body.

  • id in query - integer

    Filter items by ID.

  • sku in query - string

    Filter items by SKU.

  • upc in query - string

    Filter items by UPC.

  • page in query - integer

    Specifies the page number in a limited (paginated) list of products.

  • limit in query - integer

    Controls the number of items per page in a limited (paginated) list of products.

  • include_fields in query - string

    Fields to include, in a comma-separated list. The ID and the specified fields will be returned.

  • exclude_fields in query - string

    Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

  • product_id in query - string

    A comma-separated list of IDs of products whose variants were requested. For example:?product_id=:id``?product_id:in=77,80,81

example

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/variants' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

Body

object | application/json

  • data    array[object]

  • meta    object

    Data about the response, including pagination and collection totals.

example

{
  "data": [
    {
      "cost_price": 0,
      "price": 0,
      "sale_price": 0,
      "retail_price": 0,
      "weight": 0,
      "width": 0,
      "height": 0,
      "depth": 0,
      "is_free_shipping": true,
      "fixed_cost_shipping_price": 0,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "upc": "string",
      "inventory_level": 2147483647,
      "inventory_warning_level": 2147483647,
      "bin_picking_number": "string",
      "id": 0,
      "product_id": 0,
      "sku": "string",
      "sku_id": 0,
      "option_values": [
        {
          "option_display_name": "Color",
          "label": "Beige",
          "id": 0,
          "option_id": 0
        }
      ],
      "calculated_price": 0
    }
  ],
  "meta": {
    "pagination": {
      "total": 36,
      "count": 36,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "previous": "string",
        "current": "?page=1&limit=50",
        "next": "string"
      }
    }
  }
}

Update Variants (Batch)

PUT /catalog/variants

Request

Updates a batch of variant objects. At the time of writing, the limit is 50 variants. This limit is subject to change.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string - required

    The MIME type of the request body.

Body

array | application/json

  • cost_price    number

    The cost price of the variant. Not affected by Price List prices.

  • price    number

    This variant’s base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product’s default price (set in the Product resource’s price field) will be used as the base price.

  • sale_price    number

    This variant’s sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product’s sale price (set in the Product resource’s price field) will be used as the sale price.

  • retail_price    number

    This variant’s retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product’s retail price (set in the Product resource’s price field) will be used as the retail 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.

  • width    number

    Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width.

  • height    number

    Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height.

  • depth    number

    Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth.

  • is_free_shipping    boolean

    Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.

  • fixed_cost_shipping_price    number

    A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.

  • 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.

    >= 0 characters<= 255 characters

  • 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. The Catalog API returns the inventory for only the default location.

    The inventory for a variant cannot exceed 2,147,483,647 in the catalog. The sum of the variant inventories, or the total inventory for a product, cannot exceed 2,147,483,647.

    If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit.

    The Catalog API handles limits in a different way than the Inventory API. For more information, see Limit handling.

  • 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.

    >= 0 characters<= 255 characters

  • id    integer

    example

    {}

    Response

    Body

    object | application/json

    • data      array[object]

    • meta      object

      Data about the response, including pagination and collection totals.

    example

    {
  "data": [
    {
      "cost_price": 0,
      "price": 0,
      "sale_price": 0,
      "retail_price": 0,
      "weight": 0,
      "width": 0,
      "height": 0,
      "depth": 0,
      "is_free_shipping": true,
      "fixed_cost_shipping_price": 0,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "upc": "string",
      "inventory_level": 2147483647,
      "inventory_warning_level": 2147483647,
      "bin_picking_number": "string",
      "id": 0,
      "product_id": 0,
      "sku": "string",
      "sku_id": 0,
      "option_values": [
        {
          "option_display_name": "Color",
          "label": "Beige",
          "id": 0,
          "option_id": 0
        }
      ],
      "calculated_price": 0
    }
  ],
  "meta": {
    "pagination": {
      "total": 36,
      "count": 36,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "previous": "string",
        "current": "?page=1&limit=50",
        "next": "string"
      }
    }
  }
}