PUT /carts/{cart_id}/metafields/{metafield_id}

Update a Metafield, by cart_id.

Servers

Path parameters

Name Type Required Description
cart_id String Yes

The ID of the Cart to which the transactions belong.

metafield_id Integer Yes

The unique ID of the subject Metafield.

Request headers

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"

Request body fields

Name Type Required Description
namespace String Yes

Namespace for the metafield, for organizational purposes.

description String No

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.

ValueDescription
app_onlyPrivate to the app that owns the field.
readVisible to other API consumers.
writeOpen for reading and writing by other API consumers.
read_and_sf_accessVisible to other API consumers, including on the storefront.
write_and_sf_accessOpen 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

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.