Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Shipping Locations

Add Location

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

post/v4/shippingLocations

Request body

LocationAliasstring required

A user-defined identifier for the shipping location. This information allows greater flexibility in recognising and referring to the location.

Timezonestring required

The timezone in which the shipping location is located, important for scheduling and logistical considerations.

IsDefaultLocationboolean 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.

Example request

{
  "LocationAlias": "Main Warehouse",
  "Timezone": "Europe/London",
  "Address": {
    "AddressId": "John Brown Default",
    "Line1": "Brown Cottage",
    "Line2": "10 Sky Lane",
    "Line3": "Hills End",
    "Town": "Christchurch",
    "Postcode": "TW20 0HJ",
    "County": "Surrey",
    "CountryCode": "GB",
    "What3Words": "brick.space.employ",
    "ContactPhone": "07123887422"
  }
}

Response

The shipping location was created successfully.

ShippingLocationIdstring uuid

A unique identifier for the shipping location assigned by the system (shippingLocationId), allowing users to reference and manage specific locations effectively.