setCustomAttributesOnCart mutation

The setCustomAttributesOnCart mutation sets custom attributes on a cart. The mutation accepts a cart ID and an array of custom attribute key/value pairs. It returns the updated cart. All ID values are treated as strings.

When the quote is converted to an order, the custom attributes are copied to the order.

To remove a custom attribute, rerun the mutation without the previously applied custom attribute.

Syntax

Copy
mutation {
  setCustomAttributesOnCart(
    input: CartCustomAttributesInput
  ){    
    AddCustomAttributesToCartItemOutput
  }
}
Copied to your clipboard
mutation {
  setCustomAttributesOnCart(
    input: CartCustomAttributesInput
  ){    
    AddCustomAttributesToCartItemOutput
  }
}

Reference

The setCustomAttributesOnCart reference provides detailed information about the types and fields defined in this mutation.

Example usage

The following mutation sets custom attributes on a cart with the specified ID. The custom attributes are provided as an array of key-value pairs.

Request:

Copy
mutation {
  setCustomAttributesOnCart(
    input: {
      cart_id: "8k0Q4MpH2IGahWrTRtqM61YV2MtLPApz"
      custom_attributes: [
        { 
          attribute_code: "custom_attribute_1",
          value: "value1"
        }
        {
          attribute_code: "custom_attribute_2",
          value: "value2"
      }
      ]
    }
  ) {
    cart {
      id
      custom_attributes {
        attribute_code
        value
      }
    }
  }
}
Copied to your clipboard
mutation {
  setCustomAttributesOnCart(
    input: {
      cart_id: "8k0Q4MpH2IGahWrTRtqM61YV2MtLPApz"
      custom_attributes: [
        { 
          attribute_code: "custom_attribute_1",
          value: "value1"
        }
        {
          attribute_code: "custom_attribute_2",
          value: "value2"
      }
      ]
    }
  ) {
    cart {
      id
      custom_attributes {
        attribute_code
        value
      }
    }
  }
}

Response:

Copy
{
  "data": {
    "setCustomAttributesOnCart": {
      "cart": {
        "id": "8k0Q4MpH2IGahWrTRtqM61YV2MtLPApz",
        "custom_attributes": [
          {
            "attribute_code": "custom_attribute_1",
            "value": "value1"
          },
          {
            "attribute_code": "custom_attribute_2",
            "value": "value2"
          }
        ]
      }
    }
  }
}
Copied to your clipboard
{
  "data": {
    "setCustomAttributesOnCart": {
      "cart": {
        "id": "8k0Q4MpH2IGahWrTRtqM61YV2MtLPApz",
        "custom_attributes": [
          {
            "attribute_code": "custom_attribute_1",
            "value": "value1"
          },
          {
            "attribute_code": "custom_attribute_2",
            "value": "value2"
          }
        ]
      }
    }
  }
}

Last updated 6/10/2025

Was this helpful?

Yes

No