GET api/shipping/regions/lookup/{filter}?matchPartial={matchPartial}&startingRowNumber={startingRowNumber}&rowCount={rowCount}

Retrieves the code and description of the regions supported by the API.

Request Information

URI Parameters

Name	Type	Additional information
filter	string	None.
matchPartial	boolean	Default value is False
startingRowNumber	integer	Default value is 0
rowCount	integer	Default value is 50

Body Parameters

None.

Response Information

Resource Description

Collection of CodeDescription

Name	Description	Type	Additional information
Code	Code	string	None.
Description	Description	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Code": "sample string 1",
    "Description": "sample string 2"
  },
  {
    "Code": "sample string 1",
    "Description": "sample string 2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCodeDescription xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CodeDescription>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
  </CodeDescription>
  <CodeDescription>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
  </CodeDescription>
</ArrayOfCodeDescription>