List Channel Metafields

GET

https://api.bigcommerce.com/stores/:store_hash/v3/channels/:channel_id/metafields

GET

/stores/:store_hash/v3/channels/:channel_id/metafields

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

200Retrieved

{
  "data": [
    {
      "id": 6,
      "permission_set": "app_only",
      "namespace": "Warehouse Locations",
      "key": "Location",
      "value": "4HG",
      "description": "Location in the warehouse",
      "resource_type": "product",
      "resource_id": 111,
      "date_created": "2018-05-07T20:14:17.000Z",
      "date_modified": "2018-05-07T20:14:17.000Z"
    }
  ],
  "meta": {
    "pagination": {
      "per_page": 1,
      "total": 1,
      "count": 1,
      "total_pages": 1,
      "current_page": 1,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

Returns a list of metafields on a channel. Optional filter parameters can be passed in.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Channel Listings	modify	`store_channel_listings`
Channel Listings	read-only	`store_channel_listings_read_only`
Channel Settings	modify	`store_channel_settings`
Channel Settings	read-only	`store_channel_settings_read_only`
Sites & Routes	modify	`store_sites`
Sites & Routes	read-only	`store_sites_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

channel_idlongRequired

The ID of a channel.

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.

namespacestringOptional

Filter based on a metafieldʼs namespace.

directionenumOptional

Sort direction. Acceptable values are: asc, desc.

Allowed values:

Response

Example response

datalist of objectsOptional

metaobjectOptional

Data about the response, including pagination.