data-src=../../../../includes/commerce-only.md

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

giftRegistryTypeSearch(
    firstName: String!
    lastName: String!
    giftRegistryTypeUid: String
): [GiftRegistrySearchResult]

Reference

The giftRegistryTypeSearch reference provides detailed information about the types and fields defined in this query.

• Adobe Commerce as a Cloud Service

• On-Premises/Cloud

Example usage

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

Request:

query{
  giftRegistryTypeSearch(firstName: "Stacey", lastName: "Gaines"){
    event_date
    event_title
    gift_registry_uid
    name
    type
  }
}

Response:

{
  "data": {
    "giftRegistryTypeSearch": [
      {
        "event_date": "2021-01-28",
        "event_title": "Theo's 45th Birthday",
        "gift_registry_uid": "W9YcRai9JmzGglqP3p0USodTTM3BmjjY",
        "name": "Stacey Gaines",
        "type": "Birthday"
      }
    ]
  }
}