PRproshipping
Shipping Locations

Get Associated Accounts

Retrieves a list of shipping accounts that are linked to a specific shipping location.

get/v4/shippingLocations/{shippingLocationId}/shippingAccounts

Request

  • Base URL
    https://api.proshipping.net
  • URL
    https://api.proshipping.net/v4/shippingLocations/{shippingLocationId}/shippingAccounts
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://authentication.proshipping.net/connect/token

Path parameters

shippingLocationIdstring required

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

A string representing the term or keywords used to filter account results. For example, a search term like "Warehouse" would return shipping accounts containing the search term, helping to narrow down the list based on the user input.

pageSizeinteger

An integer that defines the number of account entries (record) returned per page in the response. For instance, if pageSize is set to 20, the API will return up to 20 accounts in each response. <br /> <br />Note: By default, this value is set to 100.

pageNumberinteger

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 accounts based on the specified pageSize. <br /> <br />Note: By default, this value is set to 1.

sortBy'Name' | 'Alias' | 'LastModified' | 'CarrierAccountNumber'

Sort By

A string specifying the field by which to organise the search results. For instance, "Name" could be used to sort accounts alphabetically, arranging the results in a more user-friendly order. <br /> <br />Note: By default, this value is set to Name.

sortDir'Ascending' | 'Descending'

Order Direction

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 accounts from A to Z. <br /> <br />Note: By default, this value is set to Ascending.

Response

Returns a paged list of associated shipping accounts.

TotalCountinteger required

An integer representing the total number of shipping accounts associated with the specified shipping location, giving users a quick overview of how many accounts are linked to their operations.

Example response

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

Changes

No recorded changes to this operation across all 5 revisions of this API.