Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Shipping Accounts

Get Associated Locations

Retrieves a list of shipping locations that are linked to a specific Royal Mail shipping account.

get/v4/shippingAccounts/rm/{shippingAccountId}/shippingLocations

Path parameters

shippingAccountIdstring required

A unique identifier for the shipping account assigned by the system (ShippingAccountId) or by you (AccountAlias), allowing for efficient reference and management of individual accounts within the system. The response will return the shipping locations linked to the shipping account ID provided here.

Query parameters

searchTermstring

A string representing the term or keywords used to filter location results. For example, a search term like "Manchester" would return locations associated with that city, helping to narrow down the list based on the user input.

pageSizeinteger

An integer that defines the number of location entries (records) returned per page in the response. For instance, if pageSize is set to 20, the API will return up to 20 accounts in each response. <br /> <br />Note: By default, this value is set to 100.

pageNumberinteger

An integer indicating the specific page of results to retrieve, allowing for pagination of larger datasets. For example, if pageNumber is set to 3, the API will return the results corresponding to the third page of accounts based on the specified pageSize. <br /> <br />Note: By default, this value is set to 1.

sortBy'Name'

Sort By

A string specifying the field by which to organise the search results. For instance, "Name" could be used to sort locations alphabetically, arranging the results in a more user-friendly order. <br /> <br />Note: By default, this value is set to Name.

sortDir'Ascending' | 'Descending'

Order Direction

A string indicating the direction in which to sort the results, typically set to "ascending" or "descending." For example, setting sortDir to "Ascending" while using "Name" as sortBy would arrange the locations from A to Z. <br /> <br />Note: By default, this value is set to Ascending.

Response

Returns a paged list of associated shipping locations.

TotalCountinteger required

An integer representing the total number of shipping locations associated with the specified shipping account that matches the search criteria, giving users a quick overview of how many locations are linked to their accounts.

Example response

{
  "ShippingLocations": [
    {
      "LocationAlias": "Main Warehouse",
      "CarrierSpecifics": {
        "ReceivingHubDescription": "002610",
        "PostingLocationCode": "2345654321",
        "ObaAccessCode": "123456",
        "ReceivingHubCode": "002610"
      },
      "Timezone": "Europe/London",
      "LastUpdatedDateUtc": "2022-02-06T16:13:24.010Z",
      "LastUpdatedBy": "User A",
      "Address": {
        "Line1": "Brown Cottage",
        "Line2": "Brown Cottage",
        "Town": "Christchurch",
        "Postcode": "TW20 0HJ",
        "County": "Surrey",
        "CountryCode": "GB",
        "What3Words": "brick.space.employ",
        "ContactPhone": "07123887422"
      }
    }
  ],
  "TotalCount": 303
}