v1

latestOpenAPI 3.0.12026-07-242073551.1 MB

Shipping Accounts

Get Associated Locations

Provides a list of all shipping locations associated with a Yodel shipping account.

get/v4/shippingAccounts/yodel/{shippingAccountId}/shippingLocations

Path parameters

shippingAccountIdstring required

Shipping Account Identifier <br />SAPIENT Shipping Account Id (assigned by SAPIENT) or Alias (assigned by you).

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 associated shipping locations.

TotalCountinteger required

An integer representing the total number of shipping locations associated with the specified shipping account that matches the search criteria, giving users a quick overview of how many locations are linked to their accounts.

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
}