Adobe Commerce only. Learn more.

giftRegistryIdSearch query

The giftRegistryIdSearch query returns a list of gift registries that match the specified registry ID. The ID is included in the email Magento sends to invitees on behalf of the registrant.

Syntax

1
giftRegistryIdSearch(giftRegistryUid: String!): [GiftRegistrySearchResult]

Example usage

The following example returns details about the specified gift registry.

Request:

1
2
3
4
5
6
7
8
9
query{
  giftRegistryIdSearch(giftRegistryUid: "W9YcRai9JmzGglqP3p0USodTTM3BmjjY"){
    event_date
    event_title
    gift_registry_uid
    name
    type
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "data": {
    "giftRegistryIdSearch": [
      {
        "event_date": "2021-01-28",
        "event_title": "Theo's 45th Birthday",
        "gift_registry_uid": "W9YcRai9JmzGglqP3p0USodTTM3BmjjY",
        "name": "Stacey Gaines",
        "type": "Birthday"
      }
    ]
  }
}

Input attributes

The giftRegistryIdSearch query requires the giftRegistryUid attribute as input.

Attribute Data Type Description
giftRegistryUid ID! The unique ID of the gift registry to search for

Output attributes

The GiftRegistrySearchResult object returns the following attributes:

Attribute Data Type Description
event_date String The date of the event
event_title String! The title given to the event
gift_registry_uid ID! The URL key of the gift registry
location String The location of the event
name String! The name of the registrant
type String The type of event being held