GET lookup/getCarriers?isUserCarrierOnly={isUserCarrierOnly}

Returns the carriers registered by a company in FreightPOP application

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action

Request Information

URI Parameters

NameDescriptionTypeAdditional information
isUserCarrierOnly

boolean
Default value is False

Body Parameters

None.

Response Information

Resource Description

List of company carriers

CarrierResponse
NameDescriptionTypeAdditional information
Data

Carrier object for carrier details

CarrierResponseObject

None.

Code

Response code returned by api

HttpStatusCode

None.

Message

Human readable message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "Carriers": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "AccountNickName": "sample string 3",
        "CarrierType": "sample string 4",
        "Other": 0,
        "Services": [
          {
            "Id": 1,
            "Name": "sample string 2"
          },
          {
            "Id": 1,
            "Name": "sample string 2"
          }
        ]
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "AccountNickName": "sample string 3",
        "CarrierType": "sample string 4",
        "Other": 0,
        "Services": [
          {
            "Id": 1,
            "Name": "sample string 2"
          },
          {
            "Id": 1,
            "Name": "sample string 2"
          }
        ]
      }
    ]
  },
  "Code": 100,
  "Message": "sample string 1"
}