BigCommerce Docs

Create multiple metafields.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Store Inventory	read-only	`store_inventory_read_only`
Store Inventory	modify	`store_inventory`

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 Inventory | read-only | `store_inventory_read_only` | | Store Inventory | modify | `store_inventory` | ### 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-fundamentals/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-fundamentals/api-accounts). For more about BigCommerce OAuth scopes, see [API Accounts and OAuth Scopes](/developer/docs/overview/api-fundamentals/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

idstringRequired

The ID of metafield to update.

permission_setenumOptional

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:

namespacestringOptional1-64 characters

Namespace for the metafield, for organizational purposes.

keystringOptional1-64 characters

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

valuestringOptional1-65535 characters

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

descriptionstringOptional0-255 characters

Description for the metafields.

Response

List of updated Metafield objects.

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	curl -X PUT https://api.bigcommerce.com/stores/store_hash/v3/inventory/locations/metafields \
2	-H "X-Auth-Token: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '[
5	{
6	"id": "42"
7	}
8	]'

1	{
2	"data": [
3	{
4	"id": 101,
5	"key": "status",
6	"value": "active",
7	"namespace": "headquarters",
8	"permission_set": "app_only",
9	"description": "Indicates the current operational status of the location",
10	"resource_type": "location",
11	"resource_id": 42,
12	"date_created": "2023-11-10T15:22:30+00:00",
13	"date_modified": "2024-04-20T09:45:00+00:00",
14	"owner_client_id": "a1b2c3d4e5f67890123456789abcdef0"
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": null,
27	"current": "?page=1&limit=50",
28	"next": null
29	}
30	}
31	}
32	}