Order API
TypePostalAddress1
A postal address associated with an order, used for billing or shipping.
Postal addresses can be provided on orders to enable address-based referral fraud detection. When configured, Bubblehouse compares addresses across orders to identify cases where the same household is creating multiple referral accounts.
Address matching
Address matching uses address1, city, and country_code as the core identifying fields. Matching is case-insensitive and ignores leading/trailing whitespace. The province field is only compared when both addresses provide it. The zip, address2, company, and country fields are not used in matching.
Important: The country_code field (ISO 3166-1 alpha-2, e.g. "US", "CA", "GB") is required for address-based referral blocking to work. The country field is for display purposes only and is not used in matching.
| Kind | Type |
|---|---|
| Used in | EstimateAccrual1, UpdateOrders4 |
Properties
-
address1string optionalPrimary street address line
Required for address matching to work. If empty, the address is not considered specific enough for matching.
-
address2string optionalSecondary address line (apartment, suite, unit, etc.)
Not used in address matching. Stored for reference only.
-
citystring optionalCity or locality name
Required for address matching to work. If empty, the address is not considered specific enough for matching.
-
provincestring optionalState, province, or region name
Used in address matching only when both addresses being compared provide it. If one address has a province and the other does not, the province is ignored for that comparison.
-
countrystring optionalCountry name (display only)
This field is for display purposes only and is not used in address matching. Use
country_codeinstead. -
country_codestring optionalISO 3166-1 alpha-2 country code (e.g. "US", "CA", "GB")
Required for address matching to work. If empty, the address is not considered specific enough for matching.
Must be a two-letter ISO 3166-1 alpha-2 code. Common examples:
"US"(United States),"CA"(Canada),"GB"(United Kingdom),"AU"(Australia),"DE"(Germany). -
zipstring optionalPostal or ZIP code
Not used in address matching. Stored for reference only.
-
companystring optionalCompany or organization name
Not used in address matching. Stored for reference only.