Add Location

post

https://api.proshipping.net/v4/shippingLocations

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

Body Params

Shipping Location Details

LocationAlias

string

required

length between 1 and 100

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

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.

Enum [true, false]

Address

object

required

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

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

200The shipping location was created successfully.

400Invalid request response.