Skip to content

Download GDPR Data Export

Returns an ad-hoc data dump (not bound to a GDPR request) of everything stored for the customer.

See the GDPR Requests overview for the full feature flow.

EndpointMethod
/api/admin/customers/{customerId}/gdpr-download-dataPOST

Response fields

FieldTypeNotes
customerIdintegerThe exported customer.
customerEmailstring
generatedAtstringWhen the export was produced.
data.customerobjectProfile fields. password and remember_token are never included.
data.addressesarrayThe customer's saved addresses.
data.ordersarrayOrders (with items, addresses, payment).
data.reviewsarrayProduct reviews authored by the customer.
data.wishlistarrayWishlist entries.
data.notesarrayAdmin notes recorded on the customer.

Full GDPR export

This covers addresses, orders, reviews, wishlist, and notes. A sub-section that has no rows returns an empty array.

Permission: customers.gdpr_requests.view.

Released under the MIT License.