Channels
Get All Channel Metafields
GET /stores/{store_hash}/v3/channels/metafields
Request
Get all channel metafields.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- 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.
- key in query - string
Filter based on a metafieldʼs key.
- key:in in query - array
Filter based on comma-separated metafieldʼs keys. Could be used with vanilla
key
query parameter.Type: array[string] - namespace in query - string
Filter based on a metafieldʼs namespace.
- namespace:in in query - array
Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla
namespace
query parameter.Type: array[string] - direction in query - string
Sort direction. Acceptable values are:
asc
,desc
.Allowed: asc | desc
- include_fields in query - array
Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
Type: array[string]Allowed: resource_id | key | value | namespace | permission_set | resource_type | description | owner_client_id | date_created | date_modified
example
Response
List of Metafield
objects.
Body
Response payload for the BigCommerce API.
dataarray[object]
metaobject
Data about the response, including pagination and collection totals.
example
Create multiple Metafields
POST /stores/{store_hash}/v3/channels/metafields
Request
Create multiple metafields.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
example
Response
List of created Metafield
objects.
Body
Response payload for the BigCommerce API.
dataarray[object]
errorsarray[]
Empty for 200 responses.
Example: []
metaobject
Data about the response, including pagination and collection totals.
example
Update multiple Metafields
PUT /stores/{store_hash}/v3/channels/metafields
Request
Update multiple metafields.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
example
Response
List of updated Metafield
objects.
Body
Response payload for the BigCommerce API.
dataarray[object]
errorsarray[]
Empty for 200 responses.
Example: []
metaobject
Data about the response, including pagination and collection totals.
example
Delete All Metafields
DELETE /stores/{store_hash}/v3/channels/metafields
Request
Delete all channel metafields.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
List of metafield IDs.
Body
example
example
Response
Response object for metafields deletion with success.
Body
Response payload for the BigCommerce API.
dataarray[integer]
Type: array[integer]Example: [123,124,125]errorsarray[]
Empty for 200 responses.
Example: []
metaobject
Additional data about the response.