Zoey REST API reference ยท Interactive version: apidocs.zoey.com
When setting address data to an Account, Contact, Quote, or Order you can use the GET /address/countries to get the list of available countries.
Using the country_id, you can then query GET /address/countries/:country_id to get the list of supported regions and their associated region_id .
If the country doesn't support regions it will be an empty array and you can set the address region value to text instead of setting the address region_id value to an integer.
GET https://container-url.zoeysite.com/api/rest/address/countries
Example response (Get), HTTP 200:
[
{
"country_id": "AF",
"country_name": "Afghanistan"
},
{
"country_id": "AL",
"country_name": "Albania"
},
{
"country_id": "DZ",
"country_name": "Algeria"
},
{
"country_id": "AS",
"country_name": "American Samoa"
},
{
"country_id": "AD",
"country_name": "Andorra"
},
{
"country_id": "AO",
"country_name": "Angola"
},
{
"country_id": "AI",
"country_name": "Anguilla"
},
{
"country_id": "AQ",
"country_name": "Antarctica"
},
{
"country_id": "AG",
"country_name": "Antigua and Barbuda"
},
{
"country_id": "AR",
"country_name": "Argentina"
},
{
"country_id": "AM",
"country_name": "Armenia"
},
{
"country_id": "AW",
"country_name": "Aruba"
},
{
"country_id": "AU",
"country_name": "Australia"
},
{
"country_id": "AT",
"country_name": "Austria"
},
{
"country_id": "AZ",
"country_name": "Azerbaijan"
},
{
"country_id": "BS",
"country_name": "Bahamas"
},
{
"country_id": "BH",
"country_name": "Bahrain"
},
{
"country_id": "BD",
"country_name": "Bangladesh"
},
{
"country_id": "BB",
"country_name": "Barbados"
},
{
"country_id": "BY",
"country_name": "Belarus"
},
{
"country_id": "BE",
"country_name": "Belgium"
},
{
"country_id": "BZ",
"country_name": "Belize"
},
{
"country_id": "BJ",
"country_name": "Benin"
},
{
"country_id": "BM",
"country_name": "Bermuda"
},
{
"country_id": "BT",
"country_name": "Bhutan"
},
{
"country_id": "BO",
"country_name": "Bolivia"
},
{
"country_id": "BA",
"country_name": "Bosnia and Herzegovina"
},
{
"country_id": "BW",
"country_name": "Botswana"
},
{
"country_id": "BV",
"country_name": "Bouvet Island"
},
{
"country_id": "BR",
"country_name": "Brazil"
},
{
"country_id": "IO",
"country_name": "British Indian Ocean Territory"
},
{
"country_id": "VG",
"country_name": "British Virgin Islands"
},
{
... (truncated)
GET https://container-url.zoeysite.com/api/rest/address/countries/:country_id
Example response (Get), HTTP 200:
{
"country_id": "US",
"country_name": "United States",
"iso2_code": "US",
"iso3_code": "USA",
"regions": [
{
"region_id": "1",
"country_id": "US",
"code": "AL",
"default_name": "Alabama",
"name": "Alabama"
},
{
"region_id": "2",
"country_id": "US",
"code": "AK",
"default_name": "Alaska",
"name": "Alaska"
},
{
"region_id": "3",
"country_id": "US",
"code": "AS",
"default_name": "American Samoa",
"name": "American Samoa"
},
{
"region_id": "4",
"country_id": "US",
"code": "AZ",
"default_name": "Arizona",
"name": "Arizona"
},
{
"region_id": "5",
"country_id": "US",
"code": "AR",
"default_name": "Arkansas",
"name": "Arkansas"
},
{
"region_id": "6",
"country_id": "US",
"code": "AF",
"default_name": "Armed Forces Africa",
"name": "Armed Forces Africa"
},
{
"region_id": "7",
"country_id": "US",
"code": "AA",
"default_name": "Armed Forces Americas",
"name": "Armed Forces Americas"
},
{
"region_id": "8",
"country_id": "US",
"code": "AC",
"default_name": "Armed Forces Canada",
"name": "Armed Forces Canada"
},
{
"region_id": "9",
"country_id": "US",
"code": "AE",
"default_name": "Armed Forces Europe",
"name": "Armed Forces Europe"
},
{
"region_id": "10",
"country_id": "US",
"code": "AM",
"default_name": "Armed Forces Middle East",
"name": "Armed Forces Middle East"
},
{
"region_id": "11",
"country_id": "US",
"code": "AP",
"default_name": "Armed Forces Pacific",
"name": "Armed Forces Pacific"
},
{
"region_id": "12",
"country_id": "US",
"code": "CA",
"default_name": "California",
"name": "California"
},
{
"region_id": "13",
"
... (truncated)