Exclusive feature only in Adobe Commerce (Learn more)

updateGiftRegistryItems mutation

The updateGiftRegistryItems mutation modifies the requested quantity of an item in the specified gift registry. It can also change the description of the item.

This mutation requires a valid customer authentication token.

Syntax

Copy
mutation {
    updateGiftRegistryItems(
        giftRegistryUid: ID!,
        items: [UpdateGiftRegistryItemInput!]!
    ) {
    UpdateGiftRegistryItemsOutput
    }
}
Copied to your clipboard
mutation {
    updateGiftRegistryItems(
        giftRegistryUid: ID!,
        items: [UpdateGiftRegistryItemInput!]!
    ) {
    UpdateGiftRegistryItemsOutput
    }
}

Reference

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

Example usage

The following example changes the quantity and description of an item in a gift registry

Request:

Copy
mutation{
  updateGiftRegistryItems(giftRegistryUid: "iSJHFdAtF8YBM5ALgNyNIgQmnbOW9t69",
    items: [{
      gift_registry_item_uid: "OQ=="
      quantity: 3
      note:  "This is the number one thing on our list."}
    ]){
    gift_registry {
      uid
      event_name
      items {
        uid
        product {
          sku
        }
        quantity
        quantity_fulfilled
      }
    }
  }
}
Copied to your clipboard
mutation{
  updateGiftRegistryItems(giftRegistryUid: "iSJHFdAtF8YBM5ALgNyNIgQmnbOW9t69",
    items: [{
      gift_registry_item_uid: "OQ=="
      quantity: 3
      note:  "This is the number one thing on our list."}
    ]){
    gift_registry {
      uid
      event_name
      items {
        uid
        product {
          sku
        }
        quantity
        quantity_fulfilled
      }
    }
  }
}

Response:

Copy
{
  "data": {
    "updateGiftRegistryItems": {
      "gift_registry": {
        "uid": "iSJHFdAtF8YBM5ALgNyNIgQmnbOW9t69",
        "event_name": "Bill and Julie's wedding",
        "items": [
          {
            "uid": "OQ==",
            "product": {
              "sku": "24-WB03"
            },
            "quantity": 3,
            "quantity_fulfilled": 0
          },
          {
            "uid": "MTM=",
            "product": {
              "sku": "24-WB02"
            },
            "quantity": 1,
            "quantity_fulfilled": 0
          }
        ]
      }
    }
  }
}
Copied to your clipboard
{
  "data": {
    "updateGiftRegistryItems": {
      "gift_registry": {
        "uid": "iSJHFdAtF8YBM5ALgNyNIgQmnbOW9t69",
        "event_name": "Bill and Julie's wedding",
        "items": [
          {
            "uid": "OQ==",
            "product": {
              "sku": "24-WB03"
            },
            "quantity": 3,
            "quantity_fulfilled": 0
          },
          {
            "uid": "MTM=",
            "product": {
              "sku": "24-WB02"
            },
            "quantity": 1,
            "quantity_fulfilled": 0
          }
        ]
      }
    }
  }
}

Last updated 5/7/2025

Was this helpful?

Yes

No