Look Up Customer

Used primarily in POS integrations, this task looks up a customer profile by exact match. Request payload for the associated endpoint can match on several optional attributes, including email, phone, user_id, external_customer_id, or transaction details.

Responses returned by the customer lookup contain several standard attributes describing the customer, as well as spendable points, available offers, and point account information.

Sequence Diagram

See the overall flow for this task below.

CUSTOMER CUSTOMER CLIENT MIDDLEWARE CLIENT MIDDLEWARE SESSIONM SESSIONM LOOK UP CUSTOMER Approach store register Look up customer Search for customer by identifier Return success message, customer profile, and offer wallet Display customer profile and offer wallet

API Endpoints & Constraints

POST /api/2.0/lookup

  • Search criteria used in these exact match searches must be unique per customer account.
  • If multiple rows are returned in the response, the API returns an error.