Batch metafields
Get All Store Metafields
GET https://api.bigcommerce.com/stores/{store_hash}/v2/store/metafieldsRequest
metafields
.Authentication
- X-Auth-Token in header
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 - stringFilter based on a metafieldʼs key.
- key:in in query - arrayFilter based on comma-separated metafieldʼs keys. Could be used with vanilla
key
query parameter.Type: array[string] - namespace in query - stringFilter based on a metafieldʼs namespaces.
- namespace:in in query - arrayFilter based on comma-separated metafieldʼs namespaces. Could be used with vanilla
namespace
query parameterType: array[string] - direction in query - string
Sort direction. Acceptable values are:
asc
,desc
.Allowed: asc | desc
example
Response
List of Metafield
objects.
Body
Response payload for the BigCommerce API.
dataarray[object]
response
Create multiple Metafields
POST https://api.bigcommerce.com/stores/{store_hash}/v2/store/metafieldsRequest
metafields
.Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
metafield
object.Body
namespacestring
required>= 1 characters<= 64 charactersNamespace for the metafield, for organizational purposes.
Example: Sales Departmentkeystring
required>= 1 characters<= 64 charactersThe name of the field, for example:
location_id
,color
.Example: Staff Namevaluestring
required>= 1 characters<= 65535 charactersThe value of the field, for example:
1
,blue
.Example: Ronaldodescriptionstring
>= 0 characters<= 255 charactersDescription for the metafields.
Example: Name of Staff Member
example
Response
List of created Metafield
objects.
Body
Response payload for the BigCommerce API.
dataarray[object]
errorsarray[]
Empty for 200 responses.Example: []
example
Update multiple metafields
PUT https://api.bigcommerce.com/stores/{store_hash}/v2/store/metafieldsRequest
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
Body
namespacestring
required>= 1 characters<= 64 charactersNamespace for the metafield, for organizational purposes.
Example: Sales Departmentkeystring
required>= 1 characters<= 64 charactersThe name of the field, for example:
location_id
,color
.Example: Staff Namevaluestring
required>= 1 characters<= 65535 charactersThe value of the field, for example:
1
,blue
.Example: Ronaldodescriptionstring
>= 0 characters<= 255 charactersDescription for the metafields.
Example: Name of Staff Memberidinteger
requiredThe ID of metafield to update.
Example: 42
example
Response
Body
Response payload for the BigCommerce API.
dataarray[object]
errorsarray[]
Empty for 200 responses.Example: []
example
Delete multiple metafields
DELETE https://api.bigcommerce.com/stores/{store_hash}/v2/store/metafieldsRequest
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
Body
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: []