API Create an address

POST    https://:account.api-us1.com/api/3/addresses

• JSON

{
	"address": {
		"company_name": "TEST NAME",
		"address_1": "TEST ADDRESS",
		"country": "US"
	}
}

 

 

 200 OK

{
    "address": {
        "companyName": "TEST NAME",
        "address1": "TEST ADDRESS",
        "country": 3,
        "links": {
            "addressGroup": "https://:account.api-us1.com/api/3/addresses/3/addressGroup",
            "addressList": "https://:account.api-us1.com/api/3/addresses/3/addressList",
            "forms": "https://:account.api-us1.com/api/3/addresses/3/forms"
        },
        "id": "3"
    }
}

BODY PARAMS

address

object

 

address.groupid

int32

 

address.global

mixed type

 

address.company_name    REQUIRED

string

 

address.address_1             REQUIRED

string

 

address.address_2

string

 

address.city

string

 

address.state

string

 

address.zip

string

 

address.district

string                                  (Optional for countries that use it)

 

address.country                 REQUIRED

string                                  Accepts a (2) two character string - country code (eg 'US', 'CA', 'MX')

 

address.allgroup

int32

 

address.is_default

boolean                               Indicates default address