Skip to content

View GDPR Request

About

The gdprRequest query returns a single GDPR data request owned by the authenticated customer. If the request does not exist or belongs to a different customer, the query returns a not-found error — a customer can only view their own requests.

Authentication

This query requires an authenticated customer — send the storefront key and a customer Bearer token. See the Authentication page.

GDPR must be enabled

If GDPR data requests are disabled in the store's admin configuration, the query fails with the message "GDPR data requests are disabled. Please enable GDPR from the admin configuration." in errors[]. The feature has been turned off on the admin side.

Arguments

ArgumentTypeRequiredDescription
idID!✅ YesThe request IRI, e.g. /api/shop/gdpr-requests/12.

Possible Returns

FieldTypeDescription
_idInt!Numeric request ID.
typeString!Request type: delete or update.
statusString!Request status: pending, processing, declined, approved, revoked.
messageStringThe customer's message describing the request.
emailString!Email address tied to the request.
revokedAtDateTimeTimestamp when the request was revoked, or null.
createdAtDateTime!Request creation timestamp.
updatedAtDateTime!Request last update timestamp.
customerCustomer!The customer who owns the request.
customer._idInt!Numeric customer ID of the owner.

Released under the MIT License.