Metafields

Get Cart Metafields

GET https://api.bigcommerce.com/stores/{store_hash}/v3/carts/{cart_id}/metafields

Request

Get a cart's metafields.

Authentication

X-Auth-Token in header

Parameters

store_hash in path - string
cart_id in path - string
required
The ID of the Cart to which the transactions belong.
Accept in header with default of application/json - string
required
The MIME type of the response body.
page in query - integer
Specifies the page number in a limited (paginated) list of products.
limit in query - integer
Controls the number of items per page in a limited (paginated) list of products.
key in query - string
Filter based on a metafieldʼs key.
namespace in query - string
Filter based on a metafieldʼs namespaces.
direction in query - string
Sort direction. Acceptable values are: asc, desc.
Allowed: asc | desc
before in query - string
A cursor indicating where to start retrieving the previous page of results. Use this parameter to paginate backward. Not required for the initial request. For subsequent requests, use the end_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the after parameter.
after in query - string
A cursor indicating where to start retrieving the next page of results. Use this parameter to paginate forward. Not required for the initial request. For subsequent requests, use the start_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the before parameter.

example

Response

An array of metafields and metadata.

Body

object | application/json

Response payload for the BigCommerce API.

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

example

Create a Cart Metafield

POST https://api.bigcommerce.com/stores/{store_hash}/v3/carts/{cart_id}/metafields

Request

Create a cart Metafield.

If you create an order from a Cart, you can continue referencing the Cart Metafields even if you delete the original Cart. Use the cart_id field on the Order to construct the Cart Metafield endpoint.

Authentication

X-Auth-Token in header

Parameters

store_hash in path - string
cart_id in path - string
required
The ID of the Cart to which the transactions belong.
Accept in header with default of application/json - string
required
The MIME type of the response body.
Content-Type in header with default of application/json - string
required

Body

object | application/json

Common Metafield properties.

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

Allowed: app_only | read | write | read_and_sf_access | write_and_sf_access

namespacestring
required
Namespace for the metafield, for organizational purposes.
>= 1 characters<= 64 characters
Example: Sales Department
keystring
required
The name of the field, for example: location_id, color.
>= 1 characters<= 64 characters
Example: Staff Name
valuestring
required
The value of the field, for example: 1, blue.
>= 1 characters<= 65535 characters
Example: Ronaldo
descriptionstring
Description for the metafields.
>= 0 characters<= 255 characters
Example: Name of Staff Member

example

Response

A Metafield object.

Body

object | application/json

Response payload for the BigCommerce API.

dataobject
Allows app partners to write custom data to various resources in the API.
metaobject
Response metadata.

example

The Metafield conflicts with another Metafield. This can result from duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id.

Body

object | application/json

statusinteger
titlestring
typestring
instancestring
errorsobject

example

The Metafield was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

Body

object | application/json

statusinteger
titlestring
typestring
instancestring
errorsobject

example

Get a Cart Metafield

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

Request

Gets a cart metafield.

Authentication

X-Auth-Token in header

Parameters

store_hash in path - string
Accept in header with default of application/json - string
required
The MIME type of the response body.
cart_id in path - string
required
The ID of the Cart to which the transactions belong.
metafield_id in path - integer
required
The unique ID of the subject Metafield.
page in query - integer
Specifies the page number in a limited (paginated) list of products.
limit in query - integer
Controls the number of items per page in a limited (paginated) list of products.
key in query - string
Filter based on a metafieldʼs key.
namespace in query - string
Filter based on a metafieldʼs namespaces.
direction in query - string
Sort direction. Acceptable values are: asc, desc.
Allowed: asc | desc

example

Response

A Metafield object.

Body

object | application/json

Response payload for the BigCommerce API.

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

example

Update a Cart Metafield

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

Request

Update a Metafield, by cart_id.

Authentication

X-Auth-Token in header

Parameters

store_hash in path - string
Accept in header with default of application/json - string
required
The MIME type of the response body.
cart_id in path - string
required
The ID of the Cart to which the transactions belong.
metafield_id in path - integer
required
The unique ID of the subject Metafield.
Content-Type in header with default of application/json - string
required

A Metafield object.

Body

object | application/json

Common Metafield properties.

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

Allowed: app_only | read | write | read_and_sf_access | write_and_sf_access

namespacestring
required
Namespace for the metafield, for organizational purposes.
>= 1 characters<= 64 characters
Example: Sales Department
keystring
required
The name of the field, for example: location_id, color.
>= 1 characters<= 64 characters
Example: Staff Name
valuestring
required
The value of the field, for example: 1, blue.
>= 1 characters<= 65535 characters
Example: Ronaldo
descriptionstring
Description for the metafields.
>= 0 characters<= 255 characters
Example: Name of Staff Member

Response

A Metafield and metadata.

Body

object | application/json

Response payload for the BigCommerce API.

dataobject
Allows app partners to write custom data to various resources in the API.
metaobject
Response metadata.

Delete a Metafield

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

Request

Deletes a Metafield.

Authentication

X-Auth-Token in header

Parameters

store_hash in path - string
Accept in header with default of application/json - string
required
The MIME type of the response body.
cart_id in path - string
required
The ID of the Cart to which the transactions belong.
metafield_id in path - integer
required
The unique ID of the subject Metafield.

example

Response

An empty response.

Did you find what you were looking for?

Metafields

Get Cart Metafields

Request

Authentication

Parameters

example

Response

Body

dataobject

example

Create a Cart Metafield

Request

Authentication

Parameters

Body

permission_setstringrequired

namespacestringrequired

keystringrequired

valuestringrequired

descriptionstring

example

Response

Body

dataobject

metaobject

example

Body

statusnumber

titlestring

typestring

detailstring

example

Body

statusinteger

titlestring

typestring

instancestring

errorsobject

example

Body

statusinteger

titlestring

typestring

instancestring

errorsobject

example

Get a Cart Metafield

Request

Authentication

Parameters

example

Response

Body

dataobject

example

Body

statusinteger

titlestring

typestring

instancestring

example-1

Update a Cart Metafield

Request

Authentication

Parameters

Body

permission_setstringrequired

namespacestringrequired

keystringrequired

valuestringrequired

descriptionstring

Response

Body

dataobject

metaobject

Body

statusnumber

titlestring

typestring

detailstring

permission_setstring
required

namespacestring
required

keystring
required

valuestring
required

permission_setstring
required

namespacestring
required

keystring
required

valuestring
required