Overview

Retrieve address types

This method allows you to retrieve a specific address type or all address types. Use the optional query parameter locale to only retrieve the collection of localized fields for a specific locale across all Types. If none of the Types have a localized field collection for the specified locale, the HTTP status code of 404-Not Found is returned.

Header Parameters

Authorizationstring Required

Authorization token

Query Parameters

Idinteger

Optional Type Id. If specified, only the Type with this Id will be returned. Default value is 0.

localestring

A valid locale associated with the AddressType. Ex: “en”, “en-us”, “en-uk”, “fr-ca”.

Path Parameters

clientIdstring Required

This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.

Sections

Retrieve address types

Header Parameters

Query Parameters

Path Parameters

What made this section unhelpful for you?

Response

What made this section unhelpful for you?