Create Multiple Metafields

POST

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

POST

/stores/:store_hash/v3/channels/metafields

curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/channels/metafields \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '[
  {
    "key": "Staff Name",
    "namespace": "Sales Department",
    "permission_set": "app_only",
    "resource_id": 42,
    "value": "Ronaldo"
  }
]'

{
  "data": [
    {
      "permission_set": "app_only",
      "namespace": "Sales Department",
      "key": "Staff Name",
      "value": "Ronaldo",
      "description": "order",
      "resource_type": "cart",
      "resource_id": 424242,
      "id": 1,
      "date_created": "2022-06-16T18:39:00+00:00",
      "date_modified": "2022-06-16T18:39:00+00:00",
      "owner_client_id": "asdfasdfasdfasdfasdfasdfasdf"
    }
  ],
  "errors": [],
  "meta": {
    "pagination": {
      "total": 36,
      "count": 36,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "previous": "string",
        "current": "?page=1&limit=50",
        "next": "string"
      }
    }
  }
}

Create multiple metafields.

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

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects a list of objects.

keystringRequired1-64 characters

The name of the field, for example: location_id, color.

namespacestringRequired1-64 characters

Namespace for the metafield, for organizational purposes.

permission_setenumRequired

Determines the visibility and writeability of the field by other API consumers.

Value	Description
`app_only`	Private to the app that owns the field.
`read`	Visible to other API consumers.
`write`	Open for reading and writing by other API consumers.
`read_and_sf_access`	Visible to other API consumers, including on the storefront.
`write_and_sf_access`	Open for reading and writing by other API consumers, including on the storefront.

Allowed values:

resource_idintegerRequired

The ID for the resource with which the metafield is associated.

valuestringRequired1-65535 characters

The value of the field, for example: 1, blue.

descriptionstringOptional0-255 characters

Description for the metafields.

Response

List of created Metafield objects.

datalist of objectsOptional

errorslist of anyOptional

Empty for 200 responses.

metaobjectOptional

Data about the response, including pagination and collection totals.

Errors

400

Bad Request Error

422

Unprocessable Entity Error