FleetRunnr API documentation

Retrieve Carriers

GET /carriers

Retrieve your connected carriers

Responses

• 200
Hide response attributes Show response attributes object
- message string
- data object
  
  Hide data attribute Show data attribute
  
  carriers array[object]
  
  Hide carriers attributes Show carriers attributes
  
  uuid string(uuid)
  
  name string
  
  avatar string(uri)
  
  shipping_methods array[object]
  
  Hide shipping_methods attributes Show shipping_methods attributes
  
  uuid string(uuid)
  
  name string
  
  base_fee number
  
  The base fee that is always applied when this shipping method is used
  
  Minimum value is 0.
  
  currency string
  
  Currency in ISO-3 format
  
  weight_threshold number
  
  The threshold in weight_unit:kg|oz at when the weight surcharge begins
  
  Minimum value is 0.
  
  weight_surcharge number
  
  The amount to charge based on boolean weight surcharge flat weight_unit:kg|oz above the weight_threshold
  
  Minimum value is 0.
  
  weight_surcharge_flat boolean
  
  true for constant weight surcharge
  
  weight_unit string
  
  Values are kg or oz.
  
  distance_threshold number
  
  The threshold in distance_unit:km|mi at when the distance surcharge begins
  
  Minimum value is 0.
  
  distance_surcharge number
  
  The amount to charge based on boolean distance surcharge flat distance_unit:km|mi above the distance_threshold
  
  Minimum value is 0.
  
  distance_surcharge_flat boolean
  
  true for constant distance surcharge
  
  distance_unit string
  
  Values are km or mi.
  
  volume_threshold number
  
  The threshold in volume_unit:cm3|in3 at when the volume surcharge begins
  
  volume_surcharge number
  
  The amount to charge based on boolean volume surchrage flat volume_unit:cm3|in3 above the volume_threshold
  
  volume_surcharge_flat boolean
  
  true for constant volume surcharge
  
  volume_divistor number
  
  volume_unit string
  
  Values are cm3 or in3.

GET /carriers

curl \
 -X GET https://{workspace}.fleetrunnr.com/api/v1/carriers \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "message": "success",
  "data": {
    "carriers": [
      {
        "uuid": "a66def5d-c2bc-4cbc-9ed6-a8815d08114c",
        "name": "ABC Logistics",
        "avatar": "https://example.com/logo.png",
        "shipping_methods": [
          {
            "uuid": "2beb8038-c028-480a-9d53-2eb1feea9252",
            "name": "On-Demand",
            "base_fee": 50,
            "currency": "LBP",
            "weight_threshold": 0,
            "weight_surcharge": 0,
            "weight_surcharge_flat": false,
            "weight_unit": "kg",
            "distance_threshold": 0,
            "distance_surcharge": 0,
            "distance_surcharge_flat": false,
            "distance_unit": "km",
            "volume_threshold": 0,
            "volume_surcharge": 0,
            "volume_surcharge_flat": false,
            "volume_divisor": 1,
            "volume_unit": "cm3"
          },
          {
            "uuid": "b990bed5-f4d9-4fca-be74-7e990a4cd450",
            "name": "3-Day Shipping",
            "base_fee": 50,
            "currency": "LBP",
            "weight_threshold": 0,
            "weight_surcharge": 0,
            "weight_surcharge_flat": false,
            "weight_unit": "kg",
            "distance_threshold": 0,
            "distance_surcharge": 0,
            "distance_surcharge_flat": false,
            "distance_unit": "km",
            "volume_threshold": 0,
            "volume_surcharge": 0,
            "volume_surcharge_flat": false,
            "volume_divisor": 1,
            "volume_unit": "in3"
          }
        ]
      }
    ]
  }
}