Host Country State
GET {{host}}/api/partner/product/{{product_id}}/host-countries/{{host_country_id}}/states
Get the country states available for the given country. If the state is disabled, it cannot be used.
Request URL Parameters
All the below are required.
Key | Description | Example |
---|---|---|
product_id | Product ID. See product reference section. | 1002 |
hostcountryid | Host country ID. See Host Country Indexendpoint. | 25636 |
Response Body Parameters
The response will be an array of objects. Each object will have the below parameters:
Key | Description | Example |
---|---|---|
id | Host Country ID. | 1 |
is_disabled | Boolean value that determines if the associated host country is disabled. | false |
country_state | See country states reference below. |
Country States
Key | Description | Example |
---|---|---|
code | 2 letter code for state in ISO 3166-2 standard. Can also be an empty string for non-applicable countries. https://www.iso.org/obp/ui/#iso:code:3166:US | AU |
id | Host country state ID | 1 |
country_id | 3 letter code for country in ISO 3166-1 alpha 3 standard. | NSW |
name | State name | New South Wales |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"id":6447,"is_disabled":false,"country_state":{"code":"AL","id":1,"country_id":"US","name":"Alabama"}},{"id":6448,"is_disabled":false,"country_state":{"code":"AK","id":2,"country_id":"US","name":"Alaska"}},{"id":6449,"is_disabled":false,"country_state":{"code":"AZ","id":3,"country_id":"US","name":"Arizona"}},{"id":6450,"is_disabled":false,"country_state":{"code":"AR","id":4,"country_id":"US","name":"Arkansas"}},{"id":6451,"is_disabled":false,"country_state":{"code":"CA","id":5,"country_id":"US","name":"California"}},{"id":6452,"is_disabled":false,"country_state":{"code":"CO","id":6,"country_id":"US","name":"Colorado"}},{"id":6453,"is_disabled":false,"country_state":{"code":"CT","id":7,"country_id":"US","name":"Connecticut"}},{"id":6454,"is_disabled":false,"country_state":{"code":"DE","id":8,"country_id":"US","name":"Delaware"}},{"id":6455,"is_disabled":false,"country_state":{"code":"FL","id":9,"country_id":"US","name":"Florida"}},{"id":6456,"is_disabled":false,"country_state":{"code":"GA","id":10,"country_id":"US","name":"Georgia"}},{"id":6457,"is_disabled":false,"country_state":{"code":"HI","id":11,"country_id":"US","name":"Hawaii"}},{"id":6458,"is_disabled":false,"country_state":{"code":"ID","id":12,"country_id":"US","name":"Idaho"}},{"id":6459,"is_disabled":false,"country_state":{"code":"IL","id":13,"country_id":"US","name":"Illinois"}},{"id":6460,"is_disabled":false,"country_state":{"code":"IN","id":14,"country_id":"US","name":"Indiana"}},{"id":6461,"is_disabled":false,"country_state":{"code":"IA","id":15,"country_id":"US","name":"Iowa"}},{"id":6462,"is_disabled":false,"country_state":{"code":"KS","id":16,"country_id":"US","name":"Kansas"}},{"id":6463,"is_disabled":false,"country_state":{"code":"KY","id":17,"country_id":"US","name":"Kentucky"}},{"id":6464,"is_disabled":false,"country_state":{"code":"LA","id":18,"country_id":"US","name":"Louisiana"}},{"id":6465,"is_disabled":false,"country_state":{"code":"ME","id":19,"country_id":"US","name":"Maine"}},{"id":6466,"is_disabled":false,"country_state":{"code":"MD","id":20,"country_id":"US","name":"Maryland"}},{"id":6467,"is_disabled":false,"country_state":{"code":"MA","id":21,"country_id":"US","name":"Massachusetts"}},{"id":6468,"is_disabled":false,"country_state":{"code":"MI","id":22,"country_id":"US","name":"Michigan"}},{"id":6469,"is_disabled":false,"country_state":{"code":"MN","id":23,"country_id":"US","name":"Minnesota"}},{"id":6470,"is_disabled":false,"country_state":{"code":"MS","id":24,"country_id":"US","name":"Mississippi"}},{"id":6471,"is_disabled":false,"country_state":{"code":"MO","id":25,"country_id":"US","name":"Missouri"}},{"id":6472,"is_disabled":false,"country_state":{"code":"MT","id":26,"country_id":"US","name":"Montana"}},{"id":6473,"is_disabled":false,"country_state":{"code":"NE","id":27,"country_id":"US","name":"Nebraska"}},{"id":6474,"is_disabled":false,"country_state":{"code":"NV","id":28,"country_id":"US","name":"Nevada"}},{"id":6475,"is_disabled":false,"country_state":{"code":"NH","id":29,"country_id":"US","name":"New Hampshire"}},{"id":6476,"is_disabled":false,"country_state":{"code":"NJ","id":30,"country_id":"US","name":"New Jersey"}},{"id":6477,"is_disabled":false,"country_state":{"code":"NM","id":31,"country_id":"US","name":"New Mexico"}},{"id":6478,"is_disabled":false,"country_state":{"code":"NY","id":32,"country_id":"US","name":"New York"}},{"id":6479,"is_disabled":false,"country_state":{"code":"NC","id":33,"country_id":"US","name":"North Carolina"}},{"id":6480,"is_disabled":false,"country_state":{"code":"ND","id":34,"country_id":"US","name":"North Dakota"}},{"id":6481,"is_disabled":false,"country_state":{"code":"OH","id":35,"country_id":"US","name":"Ohio"}},{"id":6482,"is_disabled":false,"country_state":{"code":"OK","id":36,"country_id":"US","name":"Oklahoma"}},{"id":6483,"is_disabled":false,"country_state":{"code":"OR","id":37,"country_id":"US","name":"Oregon"}},{"id":6484,"is_disabled":false,"country_state":{"code":"PA","id":38,"country_id":"US","name":"Pennsylvania"}},{"id":6485,"is_disabled":false,"country_state":{"code":"RI","id":39,"country_id":"US","name":"Rhode Island"}},{"id":6486,"is_disabled":false,"country_state":{"code":"SC","id":40,"country_id":"US","name":"South Carolina"}},{"id":6487,"is_disabled":false,"country_state":{"code":"SD","id":41,"country_id":"US","name":"South Dakota"}},{"id":6488,"is_disabled":false,"country_state":{"code":"TN","id":42,"country_id":"US","name":"Tennessee"}},{"id":6489,"is_disabled":false,"country_state":{"code":"TX","id":43,"country_id":"US","name":"Texas"}},{"id":6490,"is_disabled":false,"country_state":{"code":"UT","id":44,"country_id":"US","name":"Utah"}},{"id":6491,"is_disabled":false,"country_state":{"code":"VT","id":45,"country_id":"US","name":"Vermont"}},{"id":6492,"is_disabled":false,"country_state":{"code":"VA","id":46,"country_id":"US","name":"Virginia"}},{"id":6493,"is_disabled":true,"country_state":{"code":"WA","id":47,"country_id":"US","name":"Washington"}},{"id":6494,"is_disabled":false,"country_state":{"code":"WV","id":48,"country_id":"US","name":"West Virginia"}},{"id":6495,"is_disabled":false,"country_state":{"code":"WI","id":49,"country_id":"US","name":"Wisconsin"}},{"id":6496,"is_disabled":false,"country_state":{"code":"WY","id":50,"country_id":"US","name":"Wyoming"}},{"id":6497,"is_disabled":false,"country_state":{"code":"DC","id":51,"country_id":"US","name":"District of Columbia"}}]}