Get Product Variant

GET

https://api.bigcommerce.com/stores/:store_hash/v3/catalog/products/:product_id/variants/:variant_id

GET

/stores/:store_hash/v3/catalog/products/:product_id/variants/:variant_id

curl https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/1/variants/1 \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

{
  "data": {
    "bin_picking_number": "",
    "calculated_price": 25,
    "calculated_weight": 1,
    "cost_price": 25,
    "depth": 5,
    "fixed_cost_shipping_price": 10,
    "gtin": "",
    "height": 5,
    "id": 384,
    "image_url": "",
    "inventory_level": 0,
    "inventory_warning_level": 0,
    "is_free_shipping": false,
    "mpn": "",
    "option_values": [
      {
        "id": 176,
        "label": "Black",
        "option_display_name": "Color",
        "option_id": 220
      }
    ],
    "price": 25,
    "product_id": 192,
    "purchasing_disabled": false,
    "purchasing_disabled_message": "",
    "retail_price": 25,
    "sale_price": 20,
    "sku": "SMIT-2",
    "sku_id": 350,
    "upc": "",
    "weight": 2,
    "width": 5,
    "map_price": {}
  },
  "meta": {}
}

Returns a single product variant. Optional parameters can be passed in.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Products	modify	`store_v2_products`
Products	read-only	`store_v2_products_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

product_idintegerRequired

The ID of the Product to which the resource belongs. Product variant metafield endpoints that have the product_id in the request path are successful as long as the parameter is not empty. The product_id segment is there only for path consistency.

variant_idintegerRequired

ID of the variant on a product, or on an associated Price List Record.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

include_fieldslist of stringsOptional

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

exclude_fieldslist of stringsOptional

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

Response

dataobjectOptional

metaobjectOptional

Response metadata.

Errors

404

Not Found Error