Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Shipping Accounts

Get Accounts

The Get Carrier Accounts endpoint will be used to retrieve the shipping account details associated with FedEx

get/v4/shippingAccounts/fedex

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 shipping accounts for the given carrier.

TotalCountinteger required

An integer representing the total number of shipping accounts that match the query parameters sent in the request, 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
}