Skip to main content

Retrieve customer addresses

GET 
/v2/customers/:lookupKey/:lookupValue/addresses

Retrieve all addresses associated with a specific customer, with optional filtering by address type.

Key Features​

  • Flexible Lookup: Find customer by internal ID or external source ID
  • Type Filtering: Filter addresses by type (delivery, invoice, etc.)
  • Complete Address Data: Returns full address details including contact information
  • Default Address Identification: Identifies which address is marked as default

Business Rules​

  • Only returns addresses belonging to the specified customer
  • Addresses are returned in creation order unless filtered
  • Empty result set returned if no addresses exist for the customer
  • Source parameter required when using sourceId lookup method

Use Cases​

  • Order Processing: Retrieve delivery addresses for order fulfillment
  • Billing Management: Get invoice addresses for billing purposes
  • Address Management: Display all customer addresses in admin interfaces
  • Data Validation: Verify address completeness before processing orders

Request​

Responses​

Customer addresses retrieved successfully with complete address details