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

# Get Carrier Locations

`GET /v4/shippingLocations/{carrierCode}`

Provides a list of all shipping locations associated with a specified carrier.
<br />Note: A shipping location can be associated with more than one carrier. You would need to make individual API requests for each carrier.

## Path parameters

- `carrierCode` 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 shipping locations linked to accounts for the given carrier.

- 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 associated with a user or account requested for the specific page only.
    - `ShippingLocationId` string, uuid, required — A unique identifier for the shipping location assigned by the system (shippingLocationId), allowing users to reference and manage specific locations effectively.
    - `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 shipping. <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. <br/> <br/> ***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. <br/> <br/> ***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.<br/> <br/> ***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 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/intersoftsapient/apis/sapient-core-api.md) · [All operations](https://skmtc.dev/intersoftsapient/apis/sapient-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/intersoftsapient/sapient-core-api/revisions/3315ad0b5875/schema)