Get Associated Locations

Provides a list of all shipping locations associated with a Royal Mail shipping account.

Path Params
string
required

Shipping Account Identifier
PRO SHIPPING Shipping Account Id (assigned by PRO SHIPPING) or Alias (assigned by you).

Query Params
string

Search Term

int32
1 to 2147483647
Defaults to 100

The maximum number of records per page.

int32
1 to 2147483647
Defaults to 1

The number of the requested page, starting at 1.

string
enum

Sort By
Default: Name

Allowed:
string
enum

Sort Direction
Default: Ascending

Allowed:
Responses

401

Unauthorized

403

Forbidden

404

The shipping account was not found.

500

Internal Server Error

Language
Credentials
OAuth2
Response
Choose an example:
application/json