Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Shipping Locations

Update Location

Modify the details of an existing shipping location, such as address, contact details, and any other relevant fields. <br /> <br />Note: All the required fields must be populated in the request, regardless of whether they need to be updated.

put/v4/shippingLocations/{shippingLocationId}

Path parameters

shippingLocationIdstring required

A unique identifier assigned to the shipping location by the system (shippingLocationId) or by you (LocationAlias). 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.

Request body

LocationAliasstring required

A unique user-defined identifier for the shipping location, providing a convenient way to identify it, for example, Home or Warehouse.

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 />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": {
    "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 updated successfully.