Geography
Get All Countries
GET /stores/{store_hash}/v2/countries
Request
Get a list of all countries available. A country or territory, identifiable by an ISO 3166 country code.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
- Accept in header with default of application/json - string - required
- Content-Type in header with default of application/json - string - required
- page in query - number
Number of pages
- limit in query - number
Count per page
- country in query - string
- country_iso2 in query - string
- country_iso3 in query - string
example
Response
Body
array | application/json
example
Get a Country
GET /stores/{store_hash}/v2/countries/{id}
Request
Returns a single Country. Gets a country. A country or territory, identifiable by an ISO 3166 country code.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
- id in path - integer - required
The ID of the country.
- Accept in header with default of application/json - string - required
- Content-Type in header with default of application/json - string - required
example
Response
Body
application/json
idinteger
Id of the country.
Example: 13
countrystring
Country name.
Example: Australia
country_iso2string
2-letter country code.
Example: AU
country_iso3string
3-letter country code.
Example: AUS
statesobject
Refers to the
states
object return inGET
countries requests.
response
Get a Count of All Countries
GET /stores/{store_hash}/v2/countries/count
Request
Returns a count of all countries.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
example
Response
Body
object | application/json
countinteger
response
Did you find what you were looking for?