List Brand Metafields

GET

https://api.bigcommerce.com/stores/:store_hash/v3/catalog/brands/metafields

GET

/stores/:store_hash/v3/catalog/brands/metafields

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

{
  "data": [
    {
      "permission_set": "app_only",
      "namespace": "Sales Department",
      "key": "Staff Name",
      "value": "Ronaldo",
      "description": "order",
      "resource_type": "cart",
      "resource_id": 424242,
      "id": 1,
      "date_created": "2022-06-16T18:39:00+00:00",
      "date_modified": "2022-06-16T18:39:00+00:00",
      "owner_client_id": "asdfasdfasdfasdfasdfasdfasdf"
    }
  ],
  "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"
      }
    }
  }
}

Get all brand metafields.

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

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

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.

key:inlist of stringsOptional

Filter based on comma-separated metafieldʼs keys. Could be used with vanilla key query parameter.

namespacestringOptional

Filter based on a metafieldʼs namespaces.

namespace:inlist of stringsOptional

Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla namespace query parameter.

directionenumOptional

Sort direction. Acceptable values are: asc, desc.

Allowed values:

include_fieldslist of enumsOptional

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

Response

List of Metafield objects.

datalist of objectsOptional

metaobjectOptional

Data about the response, including pagination and collection totals.

Errors

400

Bad Request Error