List Product Variant Metafields

GET

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

GET

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

curl -G https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/1/variants/1/metafields \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     --data-urlencode resource_id:in=15,16

200Retrieved

{
  "data": [
    {
      "key": "Location",
      "namespace": "Warehouse Locations",
      "permission_set": "app_only",
      "value": "4HG",
      "date_created": "2018-05-07T20:14:17+00:00",
      "date_modified": "2018-05-07T20:14:17+00:00",
      "description": "Location in the warehouse",
      "id": 6,
      "resource_id": 111,
      "resource_type": "product"
    }
  ],
  "meta": {
    "data": [
      {
        "id": 26,
        "parent_id": 25,
        "name": "Bath",
        "is_visible": true,
        "url": "/towels/bath-towels/"
      }
    ],
    "meta": {}
  }
}

Returns a list of product variant Metafields. 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.

pageintegerOptional

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

limitintegerOptional

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

keystringOptional

Filter based on a metafieldʼs key.

namespacestringOptional

Filter based on a metafieldʼs namespaces.

resource_id:instringOptional

A comma-separated list of entity ID values that filter results to metafields that belong to one of the matching entities.

Response

datalist of objectsOptional

metaobjectOptional

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.