Skip to main content

Bulk create or update customer addresses

POST 
/v2/customers/:lookupKey/:lookupValue/addresses/bulk

Process multiple addresses for a customer in a single operation with intelligent upsert logic.

Key Features​

  • Intelligent Upsert: Creates new addresses or updates existing ones based on type and code
  • Bulk Processing: Handle multiple addresses in a single API call for efficiency
  • Flexible Customer Lookup: Process addresses using internal ID or external source ID
  • Detailed Results: Returns comprehensive results with success/failure details for each address

Business Rules​

  • Customer must exist before bulk address processing
  • Addresses are matched by type and code combination
  • If address exists (same type + code), it will be updated
  • If address doesn't exist, it will be created
  • Default address management applies to all addresses in the batch
  • All addresses must belong to the same customer

Validation Rules​

  • Each address must have valid type and code
  • Street address, city, country, and postal code are required
  • Contact name fields have length restrictions
  • Email format validation when provided
  • Postal code format validation based on country

Use Cases​

  • Data Import: Import multiple addresses from external systems
  • Address Migration: Migrate addresses during system upgrades
  • Bulk Updates: Update multiple addresses simultaneously
  • Address Synchronization: Sync addresses between different systems

Request​

Responses​

Addresses processed successfully with detailed results for each address