v1

latestOpenAPI 3.0.12026-07-242073551.1 MB

Shipping Locations

Get Associated Accounts

Provides a list of all shipping accounts associated with a specified shipping location.

get/v4/shippingLocations/{shippingLocationId}/shippingAccounts

Path parameters

shippingLocationIdstring required

A unique identifier assigned to the shipping location by the system (ShippingLocationId) or by you (alias). 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.

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' | 'Alias' | 'LastModified' | 'CarrierAccountNumber'

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 accounts.

TotalCountinteger required

Total Count <br />The total number of accounts available

Example response

{
  "ShippingAccounts": [
    {
      "CarrierCode": "RM",
      "AccountNumber": "0123456789",
      "AccountName": "AB VideoGames",
      "AccountAlias": "JSL",
      "AccountStatus": "Enabled",
      "ContactName": "John Smith",
      "ContactNumber": "0123456789",
      "LastUpdatedBy": "User A"
    }
  ],
  "TotalCount": 303
}