Update Multiple Metafields

PUT

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

PUT

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

curl -X PUT https://api.bigcommerce.com/stores/store_hash/v3/inventory/locations/metafields \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '[
  {
    "id": 42,
    "permission_set": "write_and_sf_access",
    "namespace": "logistics",
    "key": "warehouse_location",
    "value": "A12",
    "description": "Warehouse aisle and shelf location"
  }
]'

{
  "data": [
    {
      "id": 42,
      "key": "warehouse_location",
      "value": "A12",
      "namespace": "logistics",
      "permission_set": "write_and_sf_access",
      "description": "Warehouse aisle and shelf location",
      "resource_type": "location",
      "resource_id": 101,
      "date_created": "2023-11-10T15:22:30+00:00",
      "date_modified": "2024-04-20T09:45:00+00:00",
      "owner_client_id": "bc1234567890abcdef1234567890abcd"
    }
  ],
  "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.

idintegerRequired

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 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