Get address structure

This endpoint returns the essential fields, validation rules, and address format (such as zipcode, city, street, etc.) you need for proper quoting, label creation, and shipping compliance. Results are tailored by country—use it to build dynamic, country-specific address forms and ensure all required info is captured for each shipment.

Why use this endpoint?

• Address formats differ by country: This API handles region-specific rules automatically so you don't have to manage complex country-by-country logic
• Get validation requirements: Returns required fields, data types, formatting rules, and constraints for address forms
• Prevent failed shipments: Ensure all required information is captured before quoting or label creation
• Build localized forms: Create dynamic, country-specific address forms that guide users to provide exactly what's needed

What's Next?

Use the field structure in your checkout, quoting, and shipping workflows:

1. Call this endpoint with the destination country code to retrieve address requirements
2. Dynamically validate addresses using the returned validation rules and required fields
3. Guide users to supply all required data for each destination country
4. Auto-complete info using the field metadata and geocoding support where available
5. Ensure compliance by capturing all mandatory fields before creating shipment labels