Search param

Mandatory

Description

email

No

Customer Email.
when supplied with other search param will be search by AND condition

sms_phone_number

No

Customer phone number E164 format.
when supplied with other search param will be search by AND condition

id

No

Customer id from the eCommerce platform.
when supplied with other search param will be search by AND condition

Search for a customer by an email address

To search a customer by email, you can use the GET /customers method with the email filter.
For example:

curl --request GET \
  --url https://app.remarkety.com/api/v2/stores/{store_id}/[email protected] \
  --header 'accept: application/json'

Search for a customer by a phone number

curl --request GET \
  --url https://app.remarkety.com/api/v2/stores/{store_id}/customers?sms_phone_number=+972541231234 \
  --header 'accept: application/json'