Build Version:

GET portalcountries

Gets a list of portal countries.

Request Information

» Expands

Name	Description	Usage
country	This will retrieve the related country.	GET portalcountries?expand=country

» Filters

Name	Description	Usage
countryCode	This will filter the request by country code.	GET portalcountries?filter=countrycode~{operator}~{value}
isBillingActive	This will filter the request by the is billing active flag.	GET portalcountries?filter=isbillingactive~{operator}~{value}
isShippingActive	This will filter the request by the is shipping active flag.	GET portalcountries?filter=isshippingactive~{operator}~{value}
portalId	This will filter the request by portal ID.	GET portalcountries?filter=portalid~{operator}~{value}

» Sorting

Name	Description	Usage
countryCode	This will sort the response by country code.	GET portalcountries?sort=countrycode
portalCountryId	This will sort the response by portal country ID.	GET portalcountries?sort=portalcountryid

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET portalcountries?page=index~{value}
size	The size of the page when retrieving paged results.	GET portalcountries?page=size~{value}

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.

application/json

Sample:

	{
  "PortalCountries": [
    {
      "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"
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}