Validate Address
이 콘텐츠는 아직 번역되지 않았습니다.
Address Validation do not require an order to be saved to your Teapplix system first. You provide an address and select a provider to validate the address. Typically, to use any of the below provider, you must link an account for that provider into your Teapplix account before you can make the call:
- Teapplix USPS
- FedEx
- UPS
POST Request
Address validation
| Property | Type | Description | Constraints |
|---|---|---|---|
Address |
Address | Address structure | Required |
Provider |
string | Provider which will be used for address validation. TEAPPLIX will map to USPS and however your account is configured to print USPS Labels. You must have linked carrier accounts for the provider you choose to use. | RequiredOne of: TEAPPLIX, UPS, FEDEX |
Address
Address structure
| Property | Type | Description | Constraints |
|---|---|---|---|
Street |
string | Street address 1st line | Max-Length: 255 |
Street2 |
string | Street address 2nd line | Max-Length: 255 |
City |
string | The city or town name. | Max-Length: 40Min-Length: 1 |
State |
string | State code or region name | Max-Length: 40 |
ZipCode |
string | ZIP or Postal Code | |
Country |
string | Country name. Default United States | |
CountryCode |
string | 2 letter ISO code. Default US | Max-Length: 2Min-Length: 2Pattern: [A-Z]{2} |
POST Response - 200
Address Validation Result
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | DEPRECATED: always true on this envelope. Read Status instead. Will be removed in the next API major version. | |
Status |
string | Operation status. Both Validated Changed and Validated Not Changed Status are considered good addresses. Not Changed return means address has hard failed and impossible to fix. If the validation system itself has failed we will be returning http status codes 4xx or 5xx with different return schema. | RequiredOne of: Validated Changed, Validated Not Changed, Not Changed |
Message |
string | Status message. Available when status is 'Not Changed' that indicate error from AV Engine | |
Description |
string[] | Not returned by address validation | |
Address |
Address | Address structure | Required |
Residential |
boolean | Address residential indicator, if available | |
DeliveryPoint |
string | The delivery point, if available |
Address
Address structure
| Property | Type | Description | Constraints |
|---|---|---|---|
Street |
string | Street address 1st line | Max-Length: 255 |
Street2 |
string | Street address 2nd line | Max-Length: 255 |
City |
string | The city or town name. | Max-Length: 40Min-Length: 1 |
State |
string | State code or region name | Max-Length: 40 |
ZipCode |
string | ZIP or Postal Code | |
Country |
string | Country name. Default United States | |
CountryCode |
string | 2 letter ISO code. Default US | Max-Length: 2Min-Length: 2Pattern: [A-Z]{2} |
POST Response - 400
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
POST Response - 422
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
POST Response - 500
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |