Get Associated Locations

get

https://api.proshipping.net/v4/shippingAccounts/rm/{shippingAccountId}/shippingLocations

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

shippingAccountId

string

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 Params

searchTerm

string

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.

pageSize

int32

1 to 2147483647

Defaults to 100

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.

Note: By default, this value is set to 100.

pageNumber

int32

1 to 2147483647

Defaults to 1

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.

Note: By default, this value is set to 1.

sortBy

string

enum

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.

Note: By default, this value is set to Name.

Allowed:

sortDir

string

enum

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.

Note: By default, this value is set to Ascending.

Allowed:

Responses

401

Unauthorized

403

Forbidden

404

The shipping account was not found.

500

Internal Server Error

200Returns a paged list of associated shipping locations.

400Invalid request response.