Skip to main content

Retrieve customer by lookup identifier

GET 
/v2/customers/:lookupKey/:lookupValue

Retrieves a customer using flexible lookup methods. Supports both internal system IDs and external source identifiers for seamless integration with multiple systems.

Lookup Methods:

  • ID: Use internal customer ID (numeric)
  • SOURCE_ID: Use external system identifier (string/numeric)

Features:

  • Flexible identifier support for different integration scenarios
  • Optional source filtering for multi-source environments
  • Data expansion capabilities for related entities
  • Comprehensive error handling for invalid identifiers

Use Cases:

  • Customer profile retrieval by internal ID
  • Integration with external CRM systems
  • Customer lookup during order processing
  • Data synchronization between systems

Request​

Responses​

Entity found successfully with requested data