Metafields
Get Channel Metafields
GET https://api.bigcommerce.com/stores/{store_hash}/v3/channels/{channel_id}/metafieldsRequest
Returns a list of metafields on a channel. Optional filter parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
OK
Body
Metafield for products, categories, variants, and brands. The max number of metafields allowed on each product, category, variant, or brand is 250. For more information, see Platform Limits in the Help Center.
idinteger
Unique ID of the Metafield.
Example: 6namespacestring
>= 1 characters<= 64 charactersNamespace for the metafield, for organizational purposes.
Example: Warehouse Locationskeystring
>= 1 characters<= 64 charactersThe name of the field, for example:
location_id
,color
.Example: Locationvaluestring
>= 1 characters<= 65535 charactersThe value of the field.
Example: 4HGdescriptionstring
>= 0 characters<= 255 charactersDescription for the metafields.
Example: Location in the warehouseresource_typestring
The type of resource with which the metafield is associated.
Allowed: category | brand | product | variant
Example: productresource_idinteger
The ID for the resource with which the metafield is associated.
0Max: 10000000000Example: 111date_createdstring
Date and time of the metafieldʼs creation. Read-Only.
Example: 2018-05-07T20:14:17.000Zdate_modifiedstring
Date and time when the metafield was last updated. Read-Only.
Example: 2018-05-07T20:14:17.000Z
example
Create a Channel Metafield
POST https://api.bigcommerce.com/stores/{store_hash}/v3/channels/{channel_id}/metafieldsRequest
Creates a channel metafield.
Note: The maxiumum number of metafields allowed on each order, product, category, variant, channel, or brand is 250 per client ID. For more information, see Platform Limits in the Help Center.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
Metafield for products, categories, variants, and brands. The max number of metafields allowed on each product, category, variant, or brand is 250. For more information, see Platform Limits in the Help Center.
namespacestring
required>= 1 characters<= 64 charactersNamespace for the metafield, for organizational purposes. This is set by the developer.
Example: Warehouse Locationskeystring
required>= 1 characters<= 64 charactersThe name of the field.
Example: Locationvaluestring
required>= 1 characters<= 65535 charactersThe value of the field.
Example: 4HGdescriptionstring
>= 0 characters<= 255 charactersDescription for the metafield.
Example: Location in the warehouse
Response
OK
Body
Metafield for products, categories, variants, and brands. The max number of metafields allowed on each product, category, variant, or brand is 250. For more information, see Platform Limits in the Help Center.
idinteger
Unique ID of the Metafield.
Example: 6namespacestring
>= 1 characters<= 64 charactersNamespace for the metafield, for organizational purposes.
Example: Warehouse Locationskeystring
>= 1 characters<= 64 charactersThe name of the field, for example:
location_id
,color
.Example: Locationvaluestring
>= 1 characters<= 65535 charactersThe value of the field.
Example: 4HGdescriptionstring
>= 0 characters<= 255 charactersDescription for the metafields.
Example: Location in the warehouseresource_typestring
The type of resource with which the metafield is associated.
Allowed: category | brand | product | variant
Example: productresource_idinteger
The ID for the resource with which the metafield is associated.
0Max: 10000000000Example: 111date_createdstring
Date and time of the metafieldʼs creation. Read-Only.
Example: 2018-05-07T20:14:17.000Zdate_modifiedstring
Date and time when the metafield was last updated. Read-Only.
Example: 2018-05-07T20:14:17.000Z
example
Get a Channel Metafield
GET https://api.bigcommerce.com/stores/{store_hash}/v3/channels/{channel_id}/metafields/{metafield_id}Request
Returns a single channel metafield.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- metafield_id in path - stringrequired
example
Response
OK
Body
Metafield for products, categories, variants, and brands. The max number of metafields allowed on each product, category, variant, or brand is 250. For more information, see Platform Limits in the Help Center.
idinteger
Unique ID of the Metafield.
Example: 6namespacestring
>= 1 characters<= 64 charactersNamespace for the metafield, for organizational purposes.
Example: Warehouse Locationskeystring
>= 1 characters<= 64 charactersThe name of the field, for example:
location_id
,color
.Example: Locationvaluestring
>= 1 characters<= 65535 charactersThe value of the field.
Example: 4HGdescriptionstring
>= 0 characters<= 255 charactersDescription for the metafields.
Example: Location in the warehouseresource_typestring
The type of resource with which the metafield is associated.
Allowed: category | brand | product | variant
Example: productresource_idinteger
The ID for the resource with which the metafield is associated.
0Max: 10000000000Example: 111date_createdstring
Date and time of the metafieldʼs creation. Read-Only.
Example: 2018-05-07T20:14:17.000Zdate_modifiedstring
Date and time when the metafield was last updated. Read-Only.
Example: 2018-05-07T20:14:17.000Z
example
Update a Channel Metafield
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/channels/{channel_id}/metafields/{metafield_id}Request
Updates a single channel metafield.
Usage Notes
- Attempting to modify
namespace
,key
, andpermission_set
fields using a client ID different from the one used to create those metafields will result in a403
error message.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- metafield_id in path - stringrequired
Body
Metafield for products, categories, variants, and brands. The max number of metafields allowed on each product, category, variant, or brand 250. For more information, see Platform Limits in the Help Center.
namespacestring
>= 1 characters<= 64 charactersNamespace for the metafield, for organizational purposes.
Example: Warehouse Locationskeystring
>= 1 characters<= 64 charactersThe name of the field.
Example: Locationvaluestring
>= 1 characters<= 65535 charactersThe value of the field.
Example: 4HGdescriptionstring
>= 0 characters<= 255 charactersDescription for the metafield.
Example: Location in the warehouse.
example
Response
OK
Body
Metafield for products, categories, variants, and brands. The max number of metafields allowed on each product, category, variant, or brand is 250. For more information, see Platform Limits in the Help Center.
idinteger
Unique ID of the Metafield.
Example: 6namespacestring
>= 1 characters<= 64 charactersNamespace for the metafield, for organizational purposes.
Example: Warehouse Locationskeystring
>= 1 characters<= 64 charactersThe name of the field, for example:
location_id
,color
.Example: Locationvaluestring
>= 1 characters<= 65535 charactersThe value of the field.
Example: 4HGdescriptionstring
>= 0 characters<= 255 charactersDescription for the metafields.
Example: Location in the warehouseresource_typestring
The type of resource with which the metafield is associated.
Allowed: category | brand | product | variant
Example: productresource_idinteger
The ID for the resource with which the metafield is associated.
0Max: 10000000000Example: 111date_createdstring
Date and time of the metafieldʼs creation. Read-Only.
Example: 2018-05-07T20:14:17.000Zdate_modifiedstring
Date and time when the metafield was last updated. Read-Only.
Example: 2018-05-07T20:14:17.000Z
example
Delete a Channel Metafield
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/channels/{channel_id}/metafields/{metafield_id}Request
Deletes a single channel metafield.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- metafield_id in path - stringrequired
example
Response
No Content