Website logo

Get a list of Shipping Regions

Retrieves a list of valid shipping regions to be used when creating a Shipping Template.

URL: https://api.trademe.co.nz/v1/Shipping/Regions.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: None
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Returns

Collection of <Region>

RegionId Integer

Unique identifier of the Region

Name String or null

The name of the Region

Example XML Response (switch to JSON)

<RegionCollection xmlns="http://api.trademe.co.nz/v1">
  <Region>
    <RegionId>123</RegionId>
    <Name>ABC</Name>
  </Region>
  <Region>
    <RegionId>123</RegionId>
    <Name>ABC</Name>
  </Region>
</RegionCollection>

Example JSON Response (switch to XML)

[
  {
    "RegionId": 123,
    "Name": "ABC"
  },
  {
    "RegionId": 123,
    "Name": "ABC"
  }
]