GET api/companies/{companyId}/ShippingAccounts?page={page}&pageSize={pageSize}&orderBy={orderBy}&ascending={ascending}

List the Shipping Accounts for a Company

Request Information

URI Parameters

Name	Description	Type	Additional information
companyId	The ID of the company	integer	Required
page	Page number	integer	Default value is 1
pageSize	Number of records a page can hold	integer	Default value is 50
orderBy	Order By	string	Default value is Id
ascending	Asc/Desc	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

A page of Shipping Accounts

PagedResultSetOfShippingAccountDTO

None.

Response Formats

application/json, text/json

Sample:

{
  "metadata": {
    "pageNumber": 1,
    "pageSize": 2,
    "totalNumberOfPages": 3,
    "totalNumberOfRecords": 4,
    "nextPageUrl": "sample string 5"
  },
  "results": [
    {
      "id": 1,
      "companyId": 1,
      "isDefault": true,
      "name": "sample string 2",
      "carrier": "sample string 3",
      "carrierType": 1,
      "accountNumber": "sample string 4"
    },
    {
      "id": 1,
      "companyId": 1,
      "isDefault": true,
      "name": "sample string 2",
      "carrier": "sample string 3",
      "carrierType": 1,
      "accountNumber": "sample string 4"
    }
  ]
}