--- title: "Get Associated Locations" method: GET path: "/v4/shippingAccounts/rm/{shippingAccountId}/shippingLocations" tags: ["Shipping Accounts"] --- # Get Associated Locations `GET /v4/shippingAccounts/rm/{shippingAccountId}/shippingLocations` ## Request - Base URL: `https://api.intersoftsapient.net` - URL: `https://api.intersoftsapient.net/v4/shippingAccounts/rm/{shippingAccountId}/shippingLocations` - Auth: OAuth 2 - Client credentials - Token URL: `https://authentication.intersoftsapient.net/connect/token` Retrieves a list of shipping locations that are linked to a specific Royal Mail shipping account. ## Path parameters - `shippingAccountId` string, required ## Query parameters - `searchTerm` string - `pageSize` integer - `pageNumber` integer - `sortBy` 'Name': Sort By - `sortDir` 'Ascending' | 'Descending': Order Direction ## Response `200` Returns a paged list of associated shipping locations. - RoyalMailViewShippingAccountLocationShippingLocationsForAccountPagedResponse: The paged response containing the entities for the requested page only, and the total number available. - `ShippingLocations` RoyalMailViewShippingAccountLocationShippingLocationForAccount[], required: An array containing the shipping locations associated with the shipping accound ID provided in the path parameter. - `ShippingLocationId` string, uuid, required: A unique identifier assigned to the shipping location by the system (**shippingLocationId**). This ID is used to distinguish between different shipping locations within the system, facilitating, referencing and operations, such as updates, deletions, or specific queries related to that location. - `LocationAlias` string, required: A unique user-defined identifier for the shipping location, providing a convenient way to identify it, for example, Home or Warehouse. - `CarrierSpecifics` RoyalMailViewShippingAccountLocation, required: Used to provide details and attributes that pertain to Royal Mail's operational specifics related to a particular account location. - `ReceivingHubDescription` string, required: Detailed information about a specific Receiving Hub, including its name and the range of postcodes that it serves as outlined in the gazetteer file. This description helps users identify the Receiving Hub's function and geographic reach, allowing them to understand which areas are covered by that hub. This information is crucial for efficiently managing shipments and ensuring that packages are routed through the appropriate distribution centres. - `AccountLocationStatus` 'Pending' | 'Active' | 'Disabled': The current status of the associated account location. It can hold one of the following values:

� **Pending:** The account location is awaiting approval or activation and is not yet fully functional.
� **Active:** The account location is fully operational, and shipping activities can be conducted without restrictions.
� **Disabled:** The account location has been deactivated or suspended, meaning that it cannot be used for shipping until further actions are taken to reactivate it. - `PostingLocationCode` string, required: A unique number assigned to this location by Royal Mail. This code is essential for identifying the particular location from which shipments are dispatched. It facilitates the processing and tracking of mail and packages by providing a clear reference to the origin of the shipment within the Royal Mail network. - `ObaAccessCode` string, nullable: The OBA Access Code (Online Business Account Access Code) is a password associated with the Royal Mail shipping account that grants access to the Online Business Account (OBA) services. This code is crucial for ensuring that the account is secure and allows for the management of shipping tasks online.

***Note:** A Royal Mail shipping account cannot be activated or used for shipping unless the OBA Access Code has been provided.* - `ReceivingHubCode` string, required: A code that refers to the Receiving Hub or Regional Distribution Center (RDC) used for this shipping location. This code must correspond to an existing Receiving Hub recognised by Royal Mail.

***Note:** If the Receiving Hub code is not provided during the account creation process, Royal Mail will automatically match it to the Receiving Hub that corresponds to the postcode of the location's address. For more information, refer to the Royal Mail Receiving Hubs for a list of possible locations.* - `Timezone` string, required: The timezone in which the shipping location is located, important for scheduling and logistical considerations. - `LastUpdatedDateUtc` string, date-time, required: A timestamp indicating the last time the shipping location details were updated, formatted in Coordinated Universal Time (UTC). - `LastUpdatedBy` string, required: The identifier (such as a username or system account) of the individual or system that last modified the shipping location information, ensuring accountability. - `Address` ShippingLocationAddress, required: The complete address of the shipping location, consisting of multiple components including street information, locality, and so on. - `Line1` string, nullable: The first line of the address, typically containing the primary address information such as house number and street name.

***Note:** Characters like +, /, -, or space are supported.* - `Line2` string, nullable: An optional second line for the address, often used for additional details like apartment numbers or suite designations. - `Line3` string, nullable: A third optional line in the address to include any further address specifications, allowing for more detailed address information if necessary. - `Town` string, nullable: The town or city, indicating the specific locality where the shipping location is situated.

***Note:** This information is required if the address is not used from the stored addresses in the **Address Book**.* - `Postcode` string, nullable: The postal or ZIP code corresponding to the shipping location, used for mail sorting and to identify specific geographic areas.

***Note:** This information is only required for the addresses in the UK and for some outside it. To check for the postcode requirements, refer to the **Countries** API.* - `County` string, nullable: The county, state, or province in which the shipping location resides, providing additional geographical context for the address. - `CountryCode` string, nullable: An abbreviation representing the country of the shipping location, following the ISO 3166-1 alpha-2 standard, for example, "GB" for the United Kingdom. - `What3Words` string, nullable: A three-word location identifier provided by the What3words service, offering a precise way to define locations using a unique combination of three words, for example, the front door of 10 Downing Street in London is identified by slurs.this.shark. - `ContactPhone` string, tel, nullable: The contact phone number associated with the shipping location, facilitating communication regarding shipments or deliveries. - `TotalCount` integer, 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. ## Other responses - `400`: Invalid request response. - `401`: Unauthorized - `403`: Forbidden - `404`: The shipping account was not found. - `500`: Internal Server Error --- [API](https://skmtc.dev/intersoftsapient/apis/royal-mail.md) - [All operations](https://skmtc.dev/intersoftsapient/apis/royal-mail/llms.txt) - [OpenAPI document](https://skmtc.dev/intersoftsapient/apis/royal-mail/revisions/acb747a1c3b6?raw)