Address
This type is used to define an address. It is used by all containers in the Post-Order API that provide an address.
Types that use Address:
Calls that use Address:
/post-order/v2/casemanagement/{caseId} GET, /post-order/v2/casemanagement/{caseId}/provide_return_address POST, /post-order/v2/inquiry/{inquiryId} GET, /post-order/v2/return POST, /post-order/v2/return/{returnId} GET
Fields
addressLine1 ( string )
addressLine2 ( string )
addressType ( string )
nationalRegion ( string )
postalCode ( string )
worldRegion ( string )
The first line of the street address. The first line of the street address is always used by containers using the Address type.
See the Field Index to learn which calls use addressLine1.
The second line of the street address. This field is not always used, but it should be provided if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
See the Field Index to learn which calls use addressLine2.
This enumeration value indicates whether the address is a business, a personal address, PO Box, or other type of address. This field is not always used by containers using the Address type.
The list of enumeration values that may be returned in this field are defined in the AddressTypeEnum type definition.
The list of enumeration values that may be returned in this field are defined in the AddressTypeEnum type definition.
See the Field Index to learn which calls use addressType.
The city of the address. This field is always used by containers using the Address type.
See the Field Index to learn which calls use city.
This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type.
The list of two-digit country codes that may be returned in this field are defined in the CountryCodeEnum type definition.
The list of two-digit country codes that may be returned in this field are defined in the CountryCodeEnum type definition.
See the Field Index to learn which calls use country.
The county of the address. This field is not always used, but it should be provided if applicable.
See the Field Index to learn which calls use county.
This Boolean field is returned as
true if language transliteration was required.
See the Field Index to learn which calls use isTransliterated.
This string value indicates a specific region or metropolitan area within a country in which the address resides. Not all countries have defined national regions.
See the Field Index to learn which calls use nationalRegion.
The postal code of the address. This field is always used by containers using the Address type.
See the Field Index to learn which calls use postalCode.
This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is
The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition.
true. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition.
See the Field Index to learn which calls use script.
The state or province of the address. This field is always used by containers using the Address type.
See the Field Index to learn which calls use stateOrProvince.
This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.
The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition.
The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition.
See the Field Index to learn which calls use transliteratedFromScript.
This string value indicates the region of the world in which the address resides. This field is not always used by containers using the Address type.
The list of world region enumeration values that may be returned in this field are defined in the WorldRegionEnum type definition.
The list of world region enumeration values that may be returned in this field are defined in the WorldRegionEnum type definition.
See the Field Index to learn which calls use worldRegion.