Sponsoring

Checkout

verify/address.json

method: POST

secured: true

url: /v1/promote/checkout/verify/address.json

Sets a shipping address for the cart (and responds with verificaiton information)

Field	Notes
Type	A applciaiton has two addresses, shipping and mailing. Type: String (can be 'shipping' or 'mailing')
Choice	When an alternate address is presented you can choose to accept or override. This field makes note of that choice. Type: String (Accept|Override) (optional)
AddressPrimary	The first line of a shipping address. Type: String
AddressSecondary	The second line of a shipping address. Type: String (optional)
AddressTertiary	The third line of a shipping address. Type: String (optional)
City	The city to be shipped to. Type: String
Province	The province/state to be shipped to. Type: String (optional in markets that don't have provinces)
PostalCode	The postal code to be shipped to. Type: String

If the request is invalid but an valid address can be suggested you will see a response like this:

{
    "CanCorrect": true,
    "HasRequiredFields": true,
    "IsPOBox": false,
    "CanShipToProvince": true,
    "ValidContactInformation": true,
    "Name": "Jason Sperske",
    "AddressPrimary": "3500 Gateway Blvd ",
    "AddressSecondary": null,
    "AddressTertiary": null,
    "City": "Fremont",
    "Province": "CA",
    "PostalCode": "94538-6584",
    "BranchCount": 2,
    "success": false,
    "error": [
        {
            "field": "Address",
            "error": "ErrorSuggestedFix",
            "message": "Are you sure that this is a valid shipping address? Our address verification system indicates a problem with your mailing address. Please review your address thoroughly (Number and Street, City, State, Zip).However, if you feel this is the correct information, click \"Ship To This Address\". Please note that an incorrect address might cause a delay in the delivery of your order. If you need help, please contact call your local Distributor Services office for assistance."
        }
    ]
}

If you send a acceptable address (or accept the address suggested by the end point) you will see a response like this:

{
    "CanCorrect": false,
    "HasRequiredFields": true,
    "IsPOBox": false,
    "CanShipToProvince": false,
    "ValidContactInformation": true,
    "Name": null,
    "AddressPrimary": null,
    "AddressSecondary": null,
    "AddressTertiary": null,
    "City": null,
    "Province": null,
    "PostalCode": null,
    "BranchCount": 2,
    "success": true,
    "error": null
}