Adobe Commerce only. Learn more.

giftRegistryTypeSearch query

The giftRegistryTypeSearch query returns a list of gift registries that match the specified registrant name and, optionally, registry type ID. Use the giftRegistryTypes query to return list of registry type IDs.

Syntax

1
2
3
4
5
giftRegistryTypeSearch(
    firstName: String!
    lastName: String!
    typeUid: String
): [GiftRegistrySearchResult]

Example usage

The following example returns all gift registries in which the specified person is a registrant.

Request:

1
2
3
4
5
6
7
8
9
query{
  giftRegistryTypeSearch(firstName: "Stacey", lastName: "Gaines"){
    event_date
    event_title
    gift_registry_uid
    name
    type
  }
}

Response:

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

Input attributes

The giftRegistryTypeSearch query accepts the following input attributes.

Attribute Data Type Description
firstName String! The first name of the registrant
lastName String! The last name of the registrant
typeUid String The type UID of the registry

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