Metafields
Get Category Metafields
GET https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/categories/{category_id}/metafieldsRequest
Returns a list of Metafields on a Category. Optional filter parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
dataarray[object]
example
Create a Category Metafield
POST https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/categories/{category_id}/metafieldsRequest
Creates a Category Metafield.
Required Fields:
- permission_set
- namespace
- key
- value
Read-Only Fields
- id
Note: The maximum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID. For more information, see Platform Limits (Help Center) 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 is 50. For more information, see Platform Limits (Help Center) in the Help Center.
keystring
required>= 1 characters<= 64 charactersThe name of the field, for example:
location_id
,color
. Required for POST.Example: Locationvaluestring
required>= 1 characters<= 65535 charactersThe value of the field, for example:
1
,blue
. Required for POST.Example: 4HGnamespacestring
required>= 1 characters<= 64 charactersNamespace for the metafield, for organizational purposes. This is set by the developer. Required for POST.
Example: Warehouse Locationsdescriptionstring
>= 0 characters<= 255 charactersDescription for the metafields.
Example: Location in the warehouse
example
Response
Body
data
example
Get a Category Metafield
GET https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/categories/{category_id}/metafields/{metafield_id}Request
Returns a single Category Metafield. Optional parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
data
example
Update a Category Metafield
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/categories/{category_id}/metafields/{metafield_id}Request
Updates a Category Metafield.
Required Fields
- none
Read-Only Fields
- id
- These fields can only be modified by the app (API credentials) that created the metafield:
- namespace
- key
- permission_set
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 a 403 error message.
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 is 50. For more information, see Platform Limits (Help Center) in the Help Center.
keystring
required>= 1 characters<= 64 charactersThe name of the field, for example:
location_id
,color
. Required for POST.Example: Locationvaluestring
required>= 1 characters<= 65535 charactersThe value of the field, for example:
1
,blue
. Required for POST.Example: 4HGnamespacestring
required>= 1 characters<= 64 charactersNamespace for the metafield, for organizational purposes. This is set by the developer. Required for POST.
Example: Warehouse Locationsdescriptionstring
>= 0 characters<= 255 charactersDescription for the metafields.
Example: Location in the warehouse
example
Response
Body
data
example
Delete a Category Metafield
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/categories/{category_id}/metafields/{metafield_id}Request
Deletes a Category Metafield.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string