For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Docs API Reference Learn Community Changelog

Docs API Reference Learn Community Changelog

- About Our APIs
REST
GraphQL
MCP
- Overview

GraphQL Storefront Mutations

deleteCartMetafield

Example Query

1 mutation ExampleMutation($input: DeleteCartMetafieldInput) {
2   deleteCartMetafield(input: $input) {
3     deletedMetafieldEntityId
4     errors
5   }
6 }

Variables

1 {
2   "input": {
3     "cartEntityId": "example",
4     "metafieldEntityId": 0
5   }
6 }

Example response

1 {
2   "data": {
3     "deleteCartMetafield": {
4       "deletedMetafieldEntityId": 0,
5       "errors": [
6         {
7           "message": "example"
8         }
9       ]
10     }
11   }
12 }

Deletes a metafield for cart object.

Was this page helpful?

updateCartMetafield

createCartRedirectUrls

Arguments

inputDeleteCartMetafieldInputRequired

Delete cart's metafield input object.

Returns

a DeleteCartMetafieldResult

errorslist of DeleteCartMetafieldErrors

Errors found during deletion of cart's metafield.

deletedMetafieldEntityIdInteger

Id of metafield deleted for cart.