POST /carts/{cart_id}/metafields

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.

Servers

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

Path parameters

Name	Type	Required	Description
`cart_id`	String	Yes	The ID of the `Cart` to which the transactions belong.

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	Default value: "application/json"

Accept

String

Yes

The MIME type of the response body.

Default value: "application/json"

Content-Type

String

Yes

Default value: "application/json"

Request body fields

Name Type Required Description

namespace

String

Yes

Namespace for the metafield, for organizational purposes.

description

String

Description for the metafields.

key

String

Yes

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

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

Valid values:

"read"
"write_and_sf_access"
"write"
"read_and_sf_access"
"app_only"

value

String

Yes

The value of the field, for example: 1, blue.

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.