Create Product Metafield

POST

https://api.bigcommerce.com/stores/:store_hash/v3/catalog/products/:product_id/metafields

POST

/stores/:store_hash/v3/catalog/products/:product_id/metafields

curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/1/metafields \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "key": "location_id",
  "value": "Shelf 3, Bin 5",
  "namespace": "Inventory Namespace",
  "permission_set": "read",
  "description": "Where products are located"
}'

{
  "data": {
    "key": "location_id",
    "namespace": "Inventory Namespace",
    "permission_set": "read",
    "value": "Shelf 3, Bin 5",
    "date_created": "2018-09-13T16:42:37+00:00",
    "date_modified": "2018-09-13T16:42:37+00:00",
    "description": "Where products are located",
    "id": 8,
    "resource_id": 158,
    "resource_type": "product"
  },
  "meta": {}
}

Creates a Product Metafield.

Required Fields:

permission_set
namespace
key
value

Note: The maxiumum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID. For more information, see Platform Limits in the Help Center.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Products	modify	`store_v2_products`
Products	read-only	`store_v2_products_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

product_idintegerRequired

The ID of the Product to which the resource belongs.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.

keystringRequired1-64 characters

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

valuestringRequired1-65535 characters

The value of the field, for example: 1, blue. You must enter a JSON formatted string for ShipperHQ metafields. Required for POST.

namespacestringRequired1-64 characters

Namespace for the metafield, for organizational purposes. This is set by the developer. Required for POST.

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 storefront
`write_and_sf_access`	Open for reading and writing by other API consumers, including on storefront

Allowed values:

descriptionstringOptional0-255 characters

Description for the metafields.

Response

dataobjectOptional

metaobjectOptional

Response metadata.

Errors

400

Bad Request Error

409

Conflict Error

422

Unprocessable Entity Error