---
title: "Add Location"
method: POST
path: "/v4/shippingLocations"
tags: ["Shipping Locations"]
---

# Add Location

`POST /v4/shippingLocations`

Create a new shipping location in the system by providing the location alias, timezone, and address details.

## Request body

- AddShippingLocationRequest — Shipping Location Add
  - `LocationAlias` string, required — A user-defined identifier for the shipping location. This information allows greater flexibility in recognising and referring to the location.
  - `Timezone` string, required — The timezone in which the shipping location is located, important for scheduling and logistical considerations.
  - `IsDefaultLocation` boolean, nullable — 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.*
  - `Address` AddShippingLocationAddress, required — The complete address of the shipping location, consisting of multiple components including street information, locality, and so on.
    - `AddressId` string, nullable — A unique identifier for the address associated with the shipping location. This ID serves as a reference point, allowing users to easily access, manage, and differentiate between different addresses stored in the system. <br /> <br />***Note:** This ID is stored in the system's address book. If this information is provided, then all the fields under the **Address** object are ignored and the stored address in the **Address Book** will be used.*
    - `Line1` string, nullable — The first line of the address, typically containing the primary address information such as house number and street name. <br />A maximum of 50 characters is permitted. However, it may vary depending on the carrier selection. <br /> <br />***Note:** This information is only required if the address is not used from the stored addresses in the **Address Book**.*
    - `Line2` string, nullable — An optional second line for the address, often used for additional details like apartment numbers or suite designations. <br />A maximum of 50 characters is permitted. However, it may vary depending on the carrier selection.
    - `Line3` string, nullable — A third optional line in the address to include any further address specifications, allowing for more detailed address information if necessary. <br />A maximum of 50 characters is permitted. However, it may vary depending on the carrier selection.
    - `Town` string, nullable — The town or city, indicating the specific locality where the shipping location is situated. <br />A maximum of 50 characters is permitted. However, it may vary depending on the carrier selection. <br /> <br />***Note:** This information is only 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 />A maximum of 50 characters is permitted. However, it may vary depending on the carrier selection. <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. <br />A maximum of 50 characters is permitted. However, it may vary depending on the carrier selection. <br /> <br />***Note:** This information may be required depending on the country. If the country is USA, Australia, or Canada, then it must be a valid state code or name. To check for the county/state/province requirements, refer to the **Countries** API.*
    - `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. <br /> <br />***Note**: This information is only required if the address is not used from the stored addresses in the **Address Book***
    - `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. <br /> <br />***Note:** Characters like +, /, -, or space are supported.*

## Response `200`

The shipping location was created successfully.

- AddShippingLocationResponse — Create Shipping Location Response
  - `ShippingLocationId` string, uuid — A unique identifier for the shipping location assigned by the system (shippingLocationId), allowing users to reference and manage specific locations effectively.

## 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)