---
title: "Get Locations"
method: GET
path: "/v4/shippingLocations"
tags: ["Shipping Locations"]
---

# Get Locations

`GET /v4/shippingLocations`

Retrieves a list of all shipping locations set up on the system under your customer account.

## Query parameters

- `searchTerm` string
- `pageSize` integer
- `pageNumber` integer
- `sortBy` 'Name' — Sort By
- `sortDir` 'Ascending' | 'Descending' — Order Direction

## Response `200`

Returns a paged list of shipping locations.

- ShippingLocationsPagedResponse — The paged response containing the entities for the requested page only, and the total number available.
  - `ShippingLocations` ShippingLocation[], required — An array containing all shipping locations for the user account associated with the CarrierCode that was requested for the specific page only.
    - `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.
    - `IsDefaultLocation` boolean, required — A boolean value indicating whether the shipping location is set as the default for shipping operations, streamlining the selection process during shipments. <br /> <br />If the location is set as the default one, the customers no longer need to specify the location for every shipment request, reducing the risk of errors and delays. It enhances consistency by ensuring that all shipments are directed to the same default location. <br /> <br />***Note:** If true, then this location is set as the default one. Otherwise, it is set to false.*
    - `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.
      - `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.
      - `Postcode` string, nullable — The postal or ZIP code corresponding to the shipping location, used for mail sorting and to identify specific geographic areas.
      - `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 that match the specified query criteria. This provides users with an overview of how many shipping locations are available on the system, enabling better understanding of the dataset.

## Other responses

- `400` — Invalid request response.
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.dev/proshipping/apis/pro-shipping-core-api.md) · [All operations](https://skmtc.dev/proshipping/apis/pro-shipping-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/proshipping/pro-shipping-core-api/revisions/ae5fc5e90109/schema)