Common ModelsAddresses

/addresses/{id}

Returns an Address object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:
show_enum_originsenumOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
Allowed values:

Response

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-only
The datetime that this object was modified by Merge.
typeenum or null
The address type. * `BILLING` - BILLING * `SHIPPING` - SHIPPING
Allowed values:
street_1string or null
Line 1 of the address's street.
street_2string or null
Line 2 of the address's street.
citystring or null
The address's city.
stateany or nullRead-only
The address's state or region.
country_subdivisionstring or null
The address's state or region.
countryenum or null

The address’s country. The country code in ISO 3166-1 alpha-2 format.

zip_codestring or null
The address's zip code.