Update Cart Metafield

PUT

https://api.bigcommerce.com/stores/:store_hash/v3/carts/:cart_id/metafields/:metafield_id

PUT

/stores/:store_hash/v3/carts/:cart_id/metafields/:metafield_id

curl -X PUT https://api.bigcommerce.com/stores/store_hash/v3/carts/cart_id/metafields/1 \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "permission_set": "app_only",
  "namespace": "Sales Department",
  "key": "Staff Name",
  "value": "Sam"
}'

{
  "data": {
    "date_created": "2022-06-16T18:39:00+00:00",
    "date_modified": "2022-06-16T18:39:00+00:00",
    "description": "order",
    "id": "string",
    "key": "Staff Name",
    "namespace": "Sales Department",
    "owner_client_id": "asdfasdfasdfasdfasdfasdfasdf",
    "permission_set": "app_only",
    "resource_id": "0",
    "resource_type": "cart",
    "value": "Ronaldo"
  },
  "meta": {}
}

Update a Metafield, by cart_id.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Carts	modify	`store_cart`
Carts	read-only	`store_cart_read_only`
Information & Settings	modify	`store_v2_information`
Information & Settings	read-only	`store_v2_information`

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

cart_idstringRequiredformat: "UUID"

The ID of the Cart to which the transactions belong.

metafield_idintegerRequired

The unique ID of the subject Metafield.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

A Metafield object.

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.

descriptionstringOptional0-255 characters

Description for the metafields.

Response

A Metafield and metadata.

dataobjectOptional

Allows app partners to write custom data to various resources in the API.

metaobjectOptional

Response metadata.

Errors

400

Bad Request Error

422

Unprocessable Entity Error