> This page is for Developer. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.bigcommerce.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server. # Update Product Variant Metafields PUT https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/variants/{variant_id}/metafields/{metafield_id} Content-Type: application/json Updates a product variant *Metafield*. **Required Fields:** * none **Read-Only Fields** * id * These fields can only be modified by the app (API credentials) that created the metafield: * namespace * key * permission_set **Usage Notes** * Attempting to modify `namespace`, `key`, and `permission_set` fields using a client ID different from the one used to create those metafields will result in a 403 error message. Reference: https://docs.bigcommerce.com/developer/api-reference/rest/admin/catalog/product-variants/metafields/update-product-variant-metafield ## Authentication - `X-Auth-Token` header (required) — ### 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](/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#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/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 ### Path parameters - `product_id` (integer, required) — 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, required) — ID of the variant on a product, or on an associated Price List Record. - `metafield_id` (integer, required) — The ID of the `Metafield`. - `store_hash` (string, required) — Permanent ID of the BigCommerce store. ### Headers - `Accept` (string, required, default: application/json) — The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. ### Body (application/json) This endpoint expects a metafield_Base. - `key` (string, required) — The name of the field, for example: `location_id`, `color`. Required for POST. - `value` (string, required) — The value of the field, for example: `1`, `blue`. You must enter a JSON formatted string for [ShipperHQ](/developer/docs/admin/store-configuration/shipping/shipper-hq#shipperhq-object-properties) metafields. Required for POST. - `namespace` (string, required) — Namespace for the metafield, for organizational purposes. This is set by the developer. Required for POST. - `permission_set` (enum, required) — 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: `app_only`, `read`, `write`, `read_and_sf_access`, `write_and_sf_access` - `description` (string, optional) — Description for the metafields. ## Response ### 200 OK - `data` (metafield_Full, optional) - `meta` (metaEmpty_Full, optional) — Response metadata. ## Errors ### 400 Bad Request Error Bad Request. Input is invalid. - `status` (double, optional) - `title` (string, optional) - `type` (string, optional) - `detail` (string, optional) ### 404 Not Found Error The resource was not found. - `status` (integer, optional) — 404 HTTP status code. - `title` (string, optional) — The error title describing the particular error. - `type` (string, optional) - `instance` (string, optional) ## Types ### metafield_Full - `key` (string, required) — The name of the field, for example: `location_id`, `color`. Required for POST. - `namespace` (string, required) — Namespace for the metafield, for organizational purposes. This is set by the developer. Required for POST. - `permission_set` (enum, required) — 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: `app_only`, `read`, `write`, `read_and_sf_access`, `write_and_sf_access` - `value` (string, required) — The value of the field, for example: `1`, `blue`. You must enter a JSON formatted string for [ShipperHQ](/developer/docs/admin/store-configuration/shipping/shipper-hq#shipperhq-object-properties) metafields. Required for POST. - `date_created` (datetime, optional) — Date and time of the metafieldʼs creation. Read-Only. - `date_modified` (datetime, optional) — Date and time when the metafield was last updated. Read-Only. - `description` (string, optional) — Description for the metafields. - `id` (integer, optional) — Unique ID of the *Metafield*. Read-Only. - `resource_id` (integer, optional) — The ID of the resource with which the metafield is associated. - `resource_type` (enum, optional) — The type of resource with which the metafield is associated. - Allowed values: `category`, `brand`, `product`, `variant` ### metaEmpty_Full Response metadata. ## Examples **Request** ```json { "key": "Location", "value": "4HG", "namespace": "Warehouse Locations", "permission_set": "app_only" } ``` **Response** ```json { "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": "variant" }, "meta": {} } ``` **SDK Code** ```python Response import requests url = "https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/1/variants/1/metafields/1" payload = { "key": "Location", "value": "4HG", "namespace": "Warehouse Locations", "permission_set": "app_only" } headers = { "Accept": "application/json", "X-Auth-Token": "", "Content-Type": "application/json" } response = requests.put(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Response const url = 'https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/1/variants/1/metafields/1'; const options = { method: 'PUT', headers: { Accept: 'application/json', 'X-Auth-Token': '', 'Content-Type': 'application/json' }, body: '{"key":"Location","value":"4HG","namespace":"Warehouse Locations","permission_set":"app_only"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Response package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/1/variants/1/metafields/1" payload := strings.NewReader("{\n \"key\": \"Location\",\n \"value\": \"4HG\",\n \"namespace\": \"Warehouse Locations\",\n \"permission_set\": \"app_only\"\n}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("Accept", "application/json") req.Header.Add("X-Auth-Token", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Response require 'uri' require 'net/http' url = URI("https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/1/variants/1/metafields/1") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["Accept"] = 'application/json' request["X-Auth-Token"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"key\": \"Location\",\n \"value\": \"4HG\",\n \"namespace\": \"Warehouse Locations\",\n \"permission_set\": \"app_only\"\n}" response = http.request(request) puts response.read_body ``` ```java Response import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.put("https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/1/variants/1/metafields/1") .header("Accept", "application/json") .header("X-Auth-Token", "") .header("Content-Type", "application/json") .body("{\n \"key\": \"Location\",\n \"value\": \"4HG\",\n \"namespace\": \"Warehouse Locations\",\n \"permission_set\": \"app_only\"\n}") .asString(); ``` ```php Response request('PUT', 'https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/1/variants/1/metafields/1', [ 'body' => '{ "key": "Location", "value": "4HG", "namespace": "Warehouse Locations", "permission_set": "app_only" }', 'headers' => [ 'Accept' => 'application/json', 'Content-Type' => 'application/json', 'X-Auth-Token' => '', ], ]); echo $response->getBody(); ``` ```csharp Response using RestSharp; var client = new RestClient("https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/1/variants/1/metafields/1"); var request = new RestRequest(Method.PUT); request.AddHeader("Accept", "application/json"); request.AddHeader("X-Auth-Token", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"key\": \"Location\",\n \"value\": \"4HG\",\n \"namespace\": \"Warehouse Locations\",\n \"permission_set\": \"app_only\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Response import Foundation let headers = [ "Accept": "application/json", "X-Auth-Token": "", "Content-Type": "application/json" ] let parameters = [ "key": "Location", "value": "4HG", "namespace": "Warehouse Locations", "permission_set": "app_only" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/1/variants/1/metafields/1")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PUT" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```