Build Version:
GET portalcountries/{portalCountryId}
Gets a portal country.
Request Information
» Parameters
| Name | Description | Additional information |
|---|---|---|
| portalCountryId | The ID of the portal country. |
Define this parameter in the request URI. |
» Expands
| Name | Description | Usage |
|---|---|---|
| country | This will retrieve the related country. | GET portalcountries/{portalCountryId}?expand=country |
Response Information
» Response Body Formats
If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.
Sample:
{
"PortalCountry": {
"Country": {
"Code": "US",
"DisplayOrder": 0,
"IsActive": true,
"Name": "UNITED STATES",
"States": [],
"IsBillingActive": null,
"IsShippingActive": null
},
"CountryCode": "US",
"IsBillingActive": true,
"IsShippingActive": true,
"PortalCountryId": 1,
"PortalId": 1,
"CountryName": "United States"
},
"IsPortalCountryAdded": false,
"ErrorCode": null,
"ErrorMessage": null,
"StackTrace": null,
"AllowHtmlResponse": false,
"HasError": false,
"StringResponse": null
}