Create Multiple Metafields | BigCommerce Developer Center

Create multiple metafields.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Store Locations	read-only	`store_locations_read_only`
Store Locations	modify	`store_locations`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see API Accounts and OAuth Scopes.

### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Store Locations | read-only | `store_locations_read_only` | | Store Locations | modify | `store_locations` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see [API Accounts and OAuth Scopes](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts). For more about BigCommerce OAuth scopes, see [API Accounts and OAuth Scopes](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Request

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 of the location 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. # TODO

datalist of objects

errorslist of any

Empty for 200 responses.

metaobject

Data about the response, including pagination and collection totals.

Errors

400

Bad Request Error

422

Unprocessable Entity Error

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v3/inventory/locations/metafields"
4
5	payload = [
6	{
7	"key": "Staff Name",
8	"namespace": "Sales Department",
9	"permission_set": "app_only",
10	"resource_id": 42,
11	"value": "Ronaldo"
12	}
13	]
14	headers = {
15	"X-Auth-Token": "<apiKey>",
16	"Content-Type": "application/json"
17	}
18
19	response = requests.post(url, json=payload, headers=headers)
20
21	print(response.json())

1	{
2	"data": [
3	{
4	"date_created": "2022-04-14T23:06:45+00:00",
5	"date_modified": "2022-09-08T04:18:55+00:00",
6	"description": "string",
7	"id": 1,
8	"key": "status",
9	"namespace": "headquarters",
10	"owner_client_id": "asdfasdfasdfasdfasdfasdfasdf",
11	"permission_set": "app_only",
12	"resource_id": 1,
13	"resource_type": "location",
14	"value": "upcoming"
15	}
16	],
17	"errors": [],
18	"meta": {
19	"pagination": {
20	"total": 36,
21	"count": 36,
22	"per_page": 50,
23	"current_page": 1,
24	"total_pages": 1,
25	"links": {
26	"previous": "string",
27	"current": "?page=1&limit=50",
28	"next": "string"
29	}
30	}
31	}
32	}