GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/customers/by_email/{email}

Get customer by email

Returns a B2C customer.

Parameters

tenantIdpathstringnon-nullrequired
eComStoreIdpathstringnon-nullrequired
emailpathstringnon-nullrequired: The URL-encoded email address of the customer to retrieve

Responses

200Response

application/jsonobjectnon-null

countryIsoCodestringnullableoptional

ISO 3166-1 alpha-2 country code

Example"NO"

customerNumberstringnullableoptional

Human-readable customer number

Example"CUST-10042"

deliveryAddressobjectnullableoptional

Customer's main delivery address

Show child fields

citystringnon-nullrequired: Example"Oslo"
countryIsoCodestringnon-nullrequired: ISO 3166-1 alpha-2 country code
Example"NO"
postCodestringnon-nullrequired: Example"0123"
streetstringnon-nullrequired: Street address including house number
Example"Storgata 1"

electronicReceiptbooleannon-nullrequired

Whether the customer wants electronic receipts

Exampletrue

emailstringnullableoptional

Example"ola.nordmann@example.com"

firstNamestringnullableoptional

Example"Ola"

idstringnon-nullrequired

Example"01234567-89ab-cdef-0123-456789abcdef"

invoiceAddressobjectnullableoptional

Customer's main invoice/billing address

Show child fields

citystringnon-nullrequired: Example"Oslo"
countryIsoCodestringnon-nullrequired: ISO 3166-1 alpha-2 country code
Example"NO"
postCodestringnon-nullrequired: Example"0123"
streetstringnon-nullrequired: Street address including house number
Example"Storgata 1"

languageIsoCodestringnullableoptional

ISO 639-2 language code

Example"NOR"

lastNamestringnullableoptional

Example"Nordmann"

loyaltyProgramCustomerIdstringnullableread-onlyoptional

Authoritative provider customer ID for this ecom store's configured loyalty program. Null if there is no configured program, no link, or the link is not ID-authoritative. Not proof of active membership. Read-only.

loyaltyProgramsarray of objectnon-nullrequired

List of loyalty programs and the customer's enrollment status

Show item fields

Loyalty program enrollment status for a customer

enrolledbooleannon-nullrequired: Whether the customer is enrolled in this loyalty program
Exampletrue
idstringnon-nullrequired: Unique identifier of the loyalty program
Example"01234567-89ab-cdef-0123-456789abcdef"
namestringnon-nullrequired: Example"Premium Members Club"

phonestringnullableoptional

Customer's phone number in E.164 format

Example"+4790123456"

View schema definition

401Unauthorized - Invalid or missing authentication

Unauthorized - Invalid or missing authentication

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

403

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

404Not Found - Customer not found

Not Found - Customer not found

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

500

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition