v1

latestOpenAPI 3.0.12026-07-242073551.1 MB

Shipping Locations

Get Carrier Locations

Provides a list of all shipping locations associated with a specified carrier. <br />Note: A shipping location can be associated with more than one carrier. You would need to make individual API requests for each carrier.

get/v4/shippingLocations/{carrierCode}

Path parameters

carrierCodestring required

Carrier Code

Query parameters

searchTermstring

Search Term

pageSizeinteger

The maximum number of records per page.

pageNumberinteger

The number of the requested page, starting at 1.

sortBy'Name'

Sort By

Sort By <br />Default: Name

sortDir'Ascending' | 'Descending'

Order Direction

Sort Direction <br />Default: Ascending

Response

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

TotalCountinteger required

An integer representing the total number of shipping locations that match the specified query criteria. This provides users with an overview of how many shipping locations are available on the system, enabling better understanding of the dataset.

Example response

{
  "ShippingLocations": [
    {
      "LocationAlias": "Main Warehouse",
      "Timezone": "Europe/London",
      "LastUpdatedDateUtc": "2022-02-06T16:13:24.010Z",
      "LastUpdatedBy": "User A",
      "Address": {
        "Line1": "Brown Cottage",
        "Line2": "Brown Cottage",
        "Town": "Christchurch",
        "Postcode": "TW20 0HJ",
        "County": "Surrey",
        "CountryCode": "GB",
        "What3Words": "brick.space.employ",
        "ContactPhone": "07123887422"
      }
    }
  ],
  "TotalCount": 303
}