Skip to main content

Customer Addresses

Comprehensive address management system for customers supporting multiple address types, validation, and hierarchical relationships.

Address Types

Customers support multiple address types for different purposes:

TypePurposeDescription
deliveryShippingPrimary delivery location for orders
invoiceInvoicingBilling address for financial transactions

Key Features

  • Multiple Addresses: Customers can have unlimited addresses
  • Type-Specific Usage: Different addresses for different business functions
  • Default Management: Automatic default address assignment
  • Validation: Comprehensive field validation and formatting
  • Bulk Operations: Efficient management of multiple addresses

Address Components

Location Information

  • Street address with number and extension
  • City, postal code, and country
  • Regional information

Contact Details

  • Phone and mobile numbers
  • Email addresses
  • Customer-specific contact information

Personal Information

  • Contact person names (first, middle, last)
  • Gender specification
  • Role and department information

Fields

FieldTypeRequiredDescription
idintegerAuto-generatedUnique Propeller address identifier
typestring (enum: delivery, invoice)yesAddress type used for routing and billing logic
codestringnoClient-defined unique code/identifier for the address
companystringnoCompany name for the address label
firstNamestringnoContact person's first name
middleNamestringnoContact person's middle name/initials
lastNamestringnoContact person's last name
genderstring (enum: M, F, U)noContact person's gender; default is U (unknown)
streetstringyesStreet name
numberstringnoHouse/building number
numberExtensionstringnoAddition to the house number (e.g., A, bis)
postalCodestringnoPostal/ZIP code
citystringyesCity
regionstringnoState/Province/Region
countrystring (ISO 3166-1 alpha-2)yesCountry code (e.g., NL, BE)
icpstring (enum: Y, N)noIntra-Community supply indicator; default is N
phonestringnoPrimary phone number
mobilestringnoMobile phone number
emailstringnoEmail address
urlstring (URI)noWebsite URL
isDefaultstring (enum: Y, N)noWhether this is the default address; default is N
notesstringnoFree-form notes related to the address

Management Operations

CRUD Operations

  • Create: Add new addresses with full validation
  • Read: Retrieve individual or filtered address lists
  • Update: Modify existing addresses with partial updates
  • Delete: Safe removal with dependency checking

Bulk Operations

  • Bulk Creation: Process multiple addresses in single requests
  • Upsert Logic: Automatic create-or-update based on codes
  • Batch Validation: Comprehensive validation across multiple addresses