Skip to main content
POST
/
api
/
rest
/
carriers
/
search
Search Carriers
curl --request POST \
  --url https://api.upwell.com/api/rest/carriers/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 10,
  "offset": 0,
  "orderBy": {},
  "where": {}
}
'
{
  "carriers": [
    {
      "addressId": "<string>",
      "billingAddressId": "<string>",
      "cargoInsuranceExpireDate": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "currency": "AED",
      "dotNumber": "<string>",
      "email": "<string>",
      "generalLiabilityInsuranceExpireDate": "<string>",
      "id": "<string>",
      "liabilityInsuranceExpireDate": "<string>",
      "mcNumber": "<string>",
      "name": "<string>",
      "phone": "<string>",
      "scacNumber": "<string>",
      "shipmentId": "<string>",
      "sourceSystem": "<string>",
      "sourceSystemId": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Headers

ā€‹
authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Query Parameters

ā€‹
limit
integer
default:10
ā€‹
offset
integer
default:0

Body

application/json

Query parameters can also be provided in the request body as a JSON object

ā€‹
limit
integer | null
default:10
ā€‹
offset
integer | null
default:0
ā€‹
orderBy
object[] | null
ā€‹
where
CarriersBoolExp Ā· object

Boolean expression to filter rows from the table "carriers". All fields are combined with a logical 'AND'.

Response

200 - application/json

Responses for POST /api/rest/carriers/search

ā€‹
carriers
Carriers Ā· object[]