Create Multiple Metafields

POST

https://api.bigcommerce.com/stores/:store_hash/v3/inventory/locations/metafields

POST

/stores/:store_hash/v3/inventory/locations/metafields

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

{
  "data": [
    {
      "id": 1,
      "key": "status",
      "value": "upcoming",
      "namespace": "headquarters",
      "permission_set": "app_only",
      "description": "string",
      "resource_type": "location",
      "resource_id": 1,
      "date_created": "2022-04-14T23:06:45+00:00",
      "date_modified": "2022-09-08T04:18:55+00:00",
      "owner_client_id": "asdfasdfasdfasdfasdfasdfasdf"
    }
  ],
  "errors": [],
  "meta": {
    "total": 1,
    "success": 1,
    "failed": 0
  }
}

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.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects a list of objects.

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:

namespacestringRequired1-64 characters

Namespace for the metafield, for organizational purposes.

keystringRequired1-64 characters

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

valuestringRequired1-65535 characters

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

resource_idintegerRequired

The ID of the location with which the metafield is associated.

descriptionstringOptional0-255 characters

Description for the metafields.

Response

List of created Metafield objects. # TODO

datalist of objectsOptional

errorslist of anyOptional

Empty for 200 responses.

metaobjectOptional

Batch outcome counts for the write request.

Errors

400

Bad Request Error

422

Unprocessable Entity Error