Billing and Shipping Address Validation
Version 4.0.6
Endpoint
POST
https://sales-internal-api-test-e2.az.3pc.att.com/msapi/salesapi/geo-address-management-papi-test3/v1/address-validation
Copy
This operation takes address validation for shipping and billing address and it's provied all address type comma separated types billing,shipping,ppu.it's controls the maximum number of possible matches that are returned in the case of a multiple matches. Default is 10 if this field is not passed on the request
http
Enter the username and password here for authorization.
scheme:basic
The GeographicAddress to be validated
Query Parameters
- addressTypestringRequiredEnum: [billing, shipping, ppu]Address Type comma separated types billing,shipping,ppu
- maximumAlternativeAddressesintMaximum number of matches
Body Parameters
- objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
- geographicAddressobjectRequiredStructured textual way of describing how to find a Property in an urban area (country properties are often defined differently). Note : Address corresponds to SID UrbanPropertyAddress
- cartCharacteristicarray of objectsDescribes a given characteristic of an object or entity through a name/value pair.
- channelobjectRelated channel to another entity. May be online web, mobile app, social ,etc.
- placeobjectPlace reference. PlaceRef defines the placeRefs where the products are sold or delivered.
- @typestringWhen sub-classing, this defines the sub-class entity name.
Responses
Success
Body
application/json
- objectRequiredThis resource is used to manage address validation request and response
- idstringUnique identifier of the Address Validation
- hrefstringAn URI used to access to the address validation resource
- provideAlternativebooleanIndicator provided by the requester to specify if alternate addresses must be provided in case of partial or fail result.
- validationDatestringDate when the address validation is performed
- validationResultstringResult of the address validation (success, partial, fails)
- validationResultCodestringSee the addressMatchCode tab in the spreadsheet in the AID.Example: 3SMULength: 50
- validationResultDescriptionstringSee the addressMatchCode tab in the spreadsheet in the AID..Example: Address is missing unit information. Mail may not be deliveredLength: 256
- validationTypeRecommendationarray of objects
- alternateGeographicAddressarray of objectsStructured textual way of describing how to find a Property in an urban area (country properties are often defined differently). Note : Address corresponds to SID UrbanPropertyAddress
- statestringEnum: [accepted, terminatedWithError, inProgress, done]Possible values for the state of a task
- submittedGeographicAddressobjectStructured textual way of describing how to find a Property in an urban area (country properties are often defined differently). Note : Address corresponds to SID UrbanPropertyAddress
- validGeographicAddressobjectStructured textual way of describing how to find a Property in an urban area (country properties are often defined differently). Note : Address corresponds to SID UrbanPropertyAddress
- @baseTypestringWhen sub-classing, this defines the super-class
- @schemaLocationstringA URI to a JSON-Schema file that defines additional attributes and relationships
- @typestringWhen sub-classing, this defines the sub-class entity name