v1

latestOpenAPI 3.0.12026-07-242073551.1 MB

Shipping Accounts

Get Accounts

Provides a list of all shipping accounts for all carriers (created on your customer account). <br />Information about the associated carrier, account number, account type, and contact details is included in the response.

get/v4/ShippingAccounts

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.

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
}