Countries
GET {{host_gateway}}/api/partner/product/{{api_product_id}}/countries
Use this to receive the list of home countries and destination countries allowed for this product. It also provides a list of host country states, if applicable.
Request URL Parameters
All the below are required.
| Key | Description | Example |
|---|---|---|
| product_id | Product ID. See product reference section. | 6 |
Response Body Parameters
The response will be an array of objects. Each object will have the below parameters:
| Key | Description |
|---|---|
| host_countries | See Host Countries reference below. |
| destination_countries | See Destination Countries reference below. |
Host Countries
| Key | Description | Example |
|---|---|---|
| code | Country code in ISO 3166 alpha-2 format. | US |
| name | Country name | United States |
| is_disabled | Boolean value that determines if the associated host country is disabled. | false |
| states | See States reference below. |
Destination Countries
| Key | Description | Example |
|---|---|---|
| code | Country code in ISO 3166 alpha-2 format. | US |
| name | Country name | United States |
| is_disabled | Boolean value that determines if the associated destination country is disabled. | false |
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 | OH |
| name | State name | Ohio |
| is_disabled | Boolean value that determines if the associated state is disabled. | false |
RESPONSES
status: OK
{"data":{"host_countries":[{"code":"AU","name":"Australia","is_disabled":false,"states":[{"code":"NSW","name":"New South Wales","is_disabled":false},{"code":"VIC","name":"Victoria","is_disabled":false},{"code":"QLD","name":"Queensland","is_disabled":false},{"code":"WA","name":"Western Australia","is_disabled":false},{"code":"SA","name":"South Australia","is_disabled":false},{"code":"TAS","name":"Tasmania","is_disabled":false}]}],"destination_countries":[{"code":"US","name":"United States","is_disabled":false},{"code":"PR","name":"Puerto Rico","is_disabled":false}]}}