Update Location

put

https://api.proshipping.net/v4/shippingLocations/{shippingLocationId}

Modify the details of an existing shipping location, such as address, contact details, and any other relevant fields.

Note: All the required fields must be populated in the request, regardless of whether they need to be updated.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

shippingLocationId

string

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.

Body Params

Shipping Location Details

Shipping Location Add / Update Request

LocationAlias

string

required

length between 1 and 100

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

Timezone

string

required

length between 1 and 100

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

IsDefaultLocation

boolean | null

A boolean value indicating whether the shipping location is set as the default for shipping operations, streamlining the selection process during shipments.
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.

Note: If true, then this location is set as the default one. Otherwise, it is set to false.

Address

object

required

The complete address of the shipping location, consisting of multiple components including street information, locality, and so on.

Responses

200

The shipping location was updated successfully.

401

Unauthorized

403

Forbidden

404

The shipping location was not found.

500

Internal Server Error

400Invalid request response.