Get Carrier Locations

get

https://api.intersoftsapient.net/v4/shippingLocations/{carrierCode}

Retrieves a list of all shipping locations associated with a specific carrier.

Note: A shipping location can be associated with more than one carrier. However, to get the carrier locations, you need to make individual API requests for each carrier.

Path Params

carrierCode

string

required

A unique identifier for the carrier associated with the shipping location. This code is alphanumeric and helps in identifying the specific carrier linked to the shipping location.

Query Params

searchTerm

string

A string representing the term or keywords used to filter location results. For example, a search term like "Manchester" would return locations associated with that city, helping to narrow down the list based on the user input.

pageSize

int32

1 to 2147483647

Defaults to 100

An integer that defines the number of location entries (record) returned per page in the response. For instance, if pageSize is set to 20, the API will return up to 20 locations in each response.

Note: By default, this value is set to 100.

pageNumber

int32

1 to 2147483647

Defaults to 1

An integer indicating the specific page of results to retrieve, allowing for pagination of larger datasets. For example, if pageNumber is set to 3, the API will return the results corresponding to the third page of locations based on the specified pageSize.

Note: By default, this value is set to 1.

sortBy

string

enum

A string specifying the field by which to organise the search results. For instance, "Name" could be used to sort locations alphabetically, arranging the results in a more user-friendly order.

Note: By default, this value is set to Name.

Allowed:

sortDir

string

enum

A string indicating the direction in which to sort the results, typically set to "ascending" or "descending." For example, setting sortDir to "Ascending" while using "Name" as sortBy would arrange the locations from A to Z.

Note: By default, this value is set to Ascending.

Allowed:

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

200Returns a paged list of shipping locations linked to accounts for the given carrier.

400Invalid request response.