Required scopes:
customers_read
Arguments
The email address of the customer to fetch. Mutually exclusive with id.
The id (or legacy Mongo id) of the customer to fetch. Mutually exclusive with
email.
Returns
A shopper who has interacted with the merchant, with their contact and location
details.
When the customer record was created.
Merchant-defined custom field values, keyed by each field’s name. Null when the customer has no custom fields set.
The customer’s primary email address.
The customer’s first name.
The customer’s last name.
The customer’s legacy identifier (the source Mongo ObjectId), accepted anywhere an id is.
The customer’s current location, if known.
The city, town, or village.
The IANA time zone name for the location (e.g. America/New_York).
The latitude of the location, if geocoded.
The longitude of the location, if geocoded.
The state, province, or region name.
The state, province, or region code.
The first line of the street address.
The second line of the street address.
The customer’s primary phone number.
When the customer record was last updated.
Example
