POST /catalog/products/{product_id}/variants/{variant_id}/metafields

Creates a product variant Metafield.

Required Fields:

permission_set
namespace
key
value

Read-Only Fields

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.

Servers

https://api.bigcommerce.com/stores/{store_hash}/v3

Path parameters

Name	Type	Required	Description
`product_id`	Integer	Yes	The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.
`variant_id`	Integer	Yes	ID of the variant on a product, or on an associated Price List Record.

Request headers

Name Type Required Description

Name	Type	Required	Description
`Accept`	String	Yes	The MIME type of the response body. Default value: "application/json"
`Content-Type`	String	Yes	The MIME type of the request body. Default value: "application/json"

Accept

String

Yes

The MIME type of the response body.

Default value: "application/json"

Content-Type

String

Yes

The MIME type of the request body.

Default value: "application/json"

Request body fields

Name	Type	Required	Description
`namespace`	String	Yes	Namespace for the metafield, for organizational purposes. This is set by the developer. Required for POST.
`description`	String	No	Description for the metafields.
`key`	String	Yes	The name of the field, for example: `location_id`, `color`. Required for POST.
`value`	String	Yes	The value of the field, for example: `1`, `blue`. You must enter a JSON formatted string for ShipperHQ metafields. Required for POST.
`permission_set`	String	Yes	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\| Valid values: `"read"` `"write_and_sf_access"` `"write"` `"read_and_sf_access"` `"app_only"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.