Build Version:

GET countries

Gets a list of countries.

Request Information

» Expands

Name	Description	Usage
states	This will retrieve the related list of states.	GET countries?expand=states

» Filters

Name	Description	Usage
code	This will filter the request by code.	GET countries?filter=code~{operator}~{value}
isActive	This will filter the request by the is active flag.	GET countries?filter=isactive~{operator}~{value}
name	This will filter the request by name.	GET countries?filter=name~{operator}~{value}

» Sorting

Name	Description	Usage
code	This will sort the response by code.	GET countries?sort=code
displayOrder	This will sort the response by display order.	GET countries?sort=displayorder
name	This will sort the response by name.	GET countries?sort=name

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET countries?page=index~{value}
size	The size of the page when retrieving paged results.	GET countries?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:

	{
  "Countries": [
    {
      "Code": "US",
      "DisplayOrder": 0,
      "IsActive": true,
      "Name": "UNITED STATES",
      "States": [],
      "IsBillingActive": null,
      "IsShippingActive": null
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}