Carriers API

API endpoints for Carriers operations in LSP.

Endpoints

POST Create a carrier/v1/lsp/carriers/create
GET Get Carrier profile/v1/lsp/carriers/:id
GET Get all carriers/v1/lsp/carriers
PATCH Update carrier profile/v1/lsp/carriers/:id
DELETE Delete carrier/v1/lsp/carriers/:id
PUT Add/Remove pricing to/from a carrier/v1/lsp/carriers/:id/pricing/:action
PUT Set transport capability/v1/lsp/carriers/:id/capabilities/transport
PATCH Update transport capability/v1/lsp/carriers/:id/capabilities/transport
GET Get transport capability/v1/lsp/carriers/:id/capabilities/transport
DELETE Remove transport capability/v1/lsp/carriers/:id/capabilities/transport
PUT Set fleet capability/v1/lsp/carriers/:id/capabilities/fleet
PATCH Update fleet capability/v1/lsp/carriers/:id/capabilities/fleet
GET Get fleet capability/v1/lsp/carriers/:id/capabilities/fleet
PUT Set handling capability/v1/lsp/carriers/:id/capabilities/handling
PATCH Update handling capability/v1/lsp/carriers/:id/capabilities/handling
GET Get handling capability/v1/lsp/carriers/:id/capabilities/handling
PUT Set coverage capability/v1/lsp/carriers/:id/capabilities/coverage
PATCH Update coverage capability/v1/lsp/carriers/:id/capabilities/coverage
GET Get coverage capability/v1/lsp/carriers/:id/capabilities/coverage
PUT Set technology capability/v1/lsp/carriers/:id/capabilities/technology
PATCH Update technology capability/v1/lsp/carriers/:id/capabilities/technology
GET Get technology capability/v1/lsp/carriers/:id/capabilities/technology
PUT Set service capability/v1/lsp/carriers/:id/capabilities/service
PATCH Update service capability/v1/lsp/carriers/:id/capabilities/service
GET Get service capability/v1/lsp/carriers/:id/capabilities/service
PUT Set compliance capability/v1/lsp/carriers/:id/capabilities/compliance
PATCH Update compliance capability/v1/lsp/carriers/:id/capabilities/compliance
GET Get service capability/v1/lsp/carriers/:id/capabilities/service
GET Get transport capability/v1/lsp/carriers/:id/capacities/:ctype

API Reference

Create a carrier

http

POST /v1/lsp/carriers/create

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Request Body

typescript

interface Create a carrierRequest {
  type: string;
  code: string;
  name: string;
  description: string;
  contacts: {
    emails: string[];
    phones: string[]
  };
  address: {
    name: string;
    street1: string;
    city: string;
    state: string;
    country: string;
    coordinates: number[]
  };
  timezone: string;
  level: string;
  operatingMode: string;
  operatingHours: {
    dayOfWeek: string;
    openTime: string;
    closeTime: string;
    isClosed: boolean
  }[];
  digitalTwinSync: boolean;
}

Example:

json

{
  "type": "TRANSIT",
  "code": "4A-5",
  "name": "Mijo Transit",
  "description": "Fast transport service within Accra, Greater region",
  "contacts": {
    "emails": [
      "[email protected]"
    ],
    "phones": [
      "+1 898 938 382 422",
      "+233 204 55323"
    ]
  },
  "address": {
    "name": "Rolling Plaza",
    "street1": "Spintex Road, Baatsona",
    "city": "Accra",
    "state": "Greater Accra",
    "country": "Ghana",
    "coordinates": [
      -0.1387423,
      5.1284859
    ]
  },
  "timezone": "Africa/Accra",
  "level": "STANDARD",
  "operatingMode": "24_7",
  "operatingHours": [
    {
      "dayOfWeek": "MONDAY",
      "openTime": "07:00",
      "closeTime": "19:00",
      "isClosed": false
    },
    {
      "dayOfWeek": "TUESDAY",
      "openTime": "07:00",
      "closeTime": "19:00",
      "isClosed": false
    },
    {
      "dayOfWeek": "WEDNESDAY",
      "openTime": "07:00",
      "closeTime": "19:00",
      "isClosed": false
    },
    {
      "dayOfWeek": "THURSDAY",
      "openTime": "07:00",
      "closeTime": "19:00",
      "isClosed": false
    },
    {
      "dayOfWeek": "FRIDAY",
      "openTime": "07:00",
      "closeTime": "19:00",
      "isClosed": false
    },
    {
      "dayOfWeek": "SATURDAY",
      "openTime": "08:00",
      "closeTime": "16:00",
      "isClosed": false
    },
    {
      "dayOfWeek": "SUNDAY",
      "openTime": "00:00",
      "closeTime": "00:00",
      "isClosed": true
    }
  ],
  "digitalTwinSync": true
}

Get Carrier profile

http

GET /v1/lsp/carriers/:id

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Get all carriers

http

GET /v1/lsp/carriers

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Update carrier profile

http

PATCH /v1/lsp/carriers/:id

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Delete carrier

http

DELETE /v1/lsp/carriers/:id

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Add/Remove pricing to/from a carrier

http

PUT /v1/lsp/carriers/:id/pricing/:action

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Set transport capability

http

PUT /v1/lsp/carriers/:id/capabilities/transport

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Request Body

typescript

interface Set transport capabilityRequest {
  serviceTypes: string[];
  transportModes: string[];
  routeTypes: string[];
  deliveryOptions: {
    doorToDoor: boolean;
    terminalToTerminal: boolean;
    doorToTerminal: boolean;
    terminalToDoor: boolean;
    pickupService: boolean;
    dropOffService: boolean;
    consolidatedDelivery: boolean;
    distributedDelivery: boolean;
    scheduledPickup: boolean;
    onDemandPickup: boolean;
    routeDelivery: boolean;
    dedicatedDelivery: boolean
  };
  transitCapabilities: {
    expeditedService: boolean;
    guaranteedService: boolean;
    timeWindowDelivery: boolean;
    appointmentDelivery: boolean;
    afterHoursDelivery: boolean;
    weekendDelivery: boolean;
    holidayDelivery: boolean;
    emergencyService: boolean;
    rushService: boolean;
    criticalShipments: boolean
  };
}

Example:

json

{
  "serviceTypes": [
    "STANDARD_DELIVERY",
    "SCHEDULED_DELIVERY",
    "EXPRESS_DELIVERY"
  ],
  "transportModes": [
    "GROUND",
    "AIR"
  ],
  "routeTypes": [
    "INTERMODAL",
    "LAST_MILE",
    "MIDDLE_MILE"
  ],
  "deliveryOptions": {
    "doorToDoor": false,
    "terminalToTerminal": false,
    "doorToTerminal": false,
    "terminalToDoor": false,
    "pickupService": false,
    "dropOffService": false,
    "consolidatedDelivery": false,
    "distributedDelivery": false,
    "scheduledPickup": false,
    "onDemandPickup": false,
    "routeDelivery": false,
    "dedicatedDelivery": false
  },
  "transitCapabilities": {
    "expeditedService": false,
    "guaranteedService": false,
    "timeWindowDelivery": false,
    "appointmentDelivery": false,
    "afterHoursDelivery": false,
    "weekendDelivery": false,
    "holidayDelivery": false,
    "emergencyService": false,
    "rushService": false,
    "criticalShipments": false
  }
}

Update transport capability

http

PATCH /v1/lsp/carriers/:id/capabilities/transport

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Request Body

typescript

interface Update transport capabilityRequest {
  routeTypes: string[];
  deliveryOptions.doorToDoor: boolean;
  deliveryOptions.consolidatedDelivery: boolean;
  transitCapabilities.guaranteedService: boolean;
}

Example:

json

{
  "routeTypes": [
    "INTERMODAL",
    "LAST_MILE"
  ],
  "deliveryOptions.doorToDoor": true,
  "deliveryOptions.consolidatedDelivery": true,
  "transitCapabilities.guaranteedService": true
}

Get transport capability

http

GET /v1/lsp/carriers/:id/capabilities/transport

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Remove transport capability

http

DELETE /v1/lsp/carriers/:id/capabilities/transport

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Set fleet capability

http

PUT /v1/lsp/carriers/:id/capabilities/fleet

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Request Body

typescript

interface Set fleet capabilityRequest {
  vehicleTypes: string[];
  fleetComposition: {
    ownedVehicles: number;
    leasedVehicles: number;
    contractorVehicles: number;
    partnerVehicles: number;
    totalFleetSize: number;
    averageVehicleAge: {
    year: number
  };
    fleetUtilization: number;
    vehicleAvailability: number
  };
  specialEquipment: {
    liftGate: boolean;
    ramp: boolean;
    crane: boolean;
    forklift: boolean;
    palletJack: boolean;
    dolly: boolean;
    straps: boolean;
    blankets: boolean;
    tarp: boolean;
    chains: boolean;
    refrigeration: boolean;
    heating: boolean;
    temperatureMonitoring: boolean;
    gpsTracking: boolean;
    securitySystems: boolean;
    cameraSystems: boolean;
    scanningEquipment: boolean;
    weighingEquipment: boolean;
    dimensioningEquipment: boolean
  };
  fuelTypes: string[];
  maintenanceCapability: {
    inHouseMaintenance: boolean;
    certifiedTechnicians: number;
    maintenanceFacilities: number;
    preventiveMaintenance: boolean;
    emergencyRepair: boolean;
    roadsideAssistance: boolean;
    partsInventory: boolean;
    maintenanceTracking: boolean;
    complianceMonitoring: boolean
  };
}

Example:

json

{
  "vehicleTypes": [
    "MOTORCYCLE",
    "CAR_CARRIER",
    "DRONE"
  ],
  "fleetComposition": {
    "ownedVehicles": 54,
    "leasedVehicles": 21,
    "contractorVehicles": 35,
    "partnerVehicles": 0,
    "totalFleetSize": 105,
    "averageVehicleAge": {
      "year": 2.5
    },
    "fleetUtilization": 100,
    "vehicleAvailability": 68
  },
  "specialEquipment": {
    "liftGate": false,
    "ramp": false,
    "crane": false,
    "forklift": false,
    "palletJack": false,
    "dolly": false,
    "straps": false,
    "blankets": false,
    "tarp": false,
    "chains": true,
    "refrigeration": false,
    "heating": false,
    "temperatureMonitoring": false,
    "gpsTracking": true,
    "securitySystems": true,
    "cameraSystems": true,
    "scanningEquipment": true,
    "weighingEquipment": true,
    "dimensioningEquipment": true
  },
  "fuelTypes": [
    "GASOLINE",
    "ELECTRIC",
    "HYBRID"
  ],
  "maintenanceCapability": {
    "inHouseMaintenance": true,
    "certifiedTechnicians": 6,
    "maintenanceFacilities": 2,
    "preventiveMaintenance": true,
    "emergencyRepair": true,
    "roadsideAssistance": false,
    "partsInventory": false,
    "maintenanceTracking": true,
    "complianceMonitoring": true
  }
}

Update fleet capability

http

PATCH /v1/lsp/carriers/:id/capabilities/fleet

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Request Body

typescript

interface Update fleet capabilityRequest {
  fleetCompositionvehicleAvailability: number;
  fuelTypes: string[];
  maintenanceCapability.inHouseMaintenance: boolean;
  maintenanceCapability.maintenanceFacilities: number;
}

Example:

json

{
  "fleetCompositionvehicleAvailability": 54,
  "fuelTypes": [
    "ELECTRIC",
    "HYBRID"
  ],
  "maintenanceCapability.inHouseMaintenance": true,
  "maintenanceCapability.maintenanceFacilities": 3
}

Get fleet capability

http

GET /v1/lsp/carriers/:id/capabilities/fleet

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Set handling capability

http

PUT /v1/lsp/carriers/:id/capabilities/handling

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Request Body

typescript

interface Set handling capabilityRequest {
  packageTypes: string[];
  cargoSpecialties: string[];
  specialHandling: {
    supportedRestrictions: string[];
    fragileHandling: boolean;
    hazmatCertified: boolean;
    hazmatClasses: string[];
    temperatureControlled: boolean;
    climateControlled: boolean;
    secureTransport: boolean;
    chainOfCustody: boolean;
    whiteGloveService: boolean;
    insideDelivery: boolean;
    assemblyService: boolean;
    installationService: boolean;
    unpackingService: boolean;
    debrisRemoval: boolean;
    customsHandling: boolean;
    bonded: boolean
  };
  handlingLimits: {
    maxPackageWeight: {
    value: number;
    unit: string
  };
    maxPackageDimensions: {
    width: number;
    height: number;
    length: number;
    unit: string
  };
    maxPackageVolume: {
    value: number;
    unit: string
  };
    maxPalletWeight: {
    value: number;
    unit: string
  };
    maxPalletDimensions: {
    width: number;
    height: number;
    length: number;
    unit: string
  };
    maxShipmentWeight: {
    value: number;
    unit: string
  };
    maxShipmentVolume: {
    value: number;
    unit: string
  };
    maxShipmentValue: {
    amount: number;
    currency: {
    name: string;
    code: string;
    symbol: string
  }
  };
    oversizedHandling: boolean;
    overweightHandling: boolean;
    irregularShapeHandling: boolean;
    longItemHandling: boolean;
    stackableOnly: boolean;
    orientationSensitive: boolean
  };
  loadingCapabilities: {
    loadingMethods: string[];
    maxLoadingHeight: {
    value: number;
    unit: string
  };
    dockAccess: boolean;
    curbsideAccess: boolean;
    residentialAccess: boolean;
    appointmentRequired: boolean;
    accessRestrictions: any[]
  };
  accessibleBy: string[];
}

Example:

json

{
  "packageTypes": [
    "ENVELOPE",
    "PAK",
    "BOX"
  ],
  "cargoSpecialties": [
    "FRAGILE_ITEMS",
    "FROZEN",
    "FOOD_GRADE",
    "PHARMACEUTICAL"
  ],
  "specialHandling": {
    "supportedRestrictions": [
      "HAZMAT_ONLY"
    ],
    "fragileHandling": true,
    "hazmatCertified": true,
    "hazmatClasses": [
      "CLASS_9_MISCELLANEOUS"
    ],
    "temperatureControlled": false,
    "climateControlled": false,
    "secureTransport": true,
    "chainOfCustody": false,
    "whiteGloveService": false,
    "insideDelivery": false,
    "assemblyService": false,
    "installationService": false,
    "unpackingService": false,
    "debrisRemoval": false,
    "customsHandling": false,
    "bonded": false
  },
  "handlingLimits": {
    "maxPackageWeight": {
      "value": 250,
      "unit": "kg"
    },
    "maxPackageDimensions": {
      "width": 2,
      "height": 3,
      "length": 5,
      "unit": "m"
    },
    "maxPackageVolume": {
      "value": 20,
      "unit": "cbm"
    },
    "maxPalletWeight": {
      "value": 50,
      "unit": "kg"
    },
    "maxPalletDimensions": {
      "width": 0.5,
      "height": 1,
      "length": 2.5,
      "unit": "m"
    },
    "maxShipmentWeight": {
      "value": 1500,
      "unit": "kg"
    },
    "maxShipmentVolume": {
      "value": 2000,
      "unit": "cbm"
    },
    "maxShipmentValue": {
      "amount": 35000,
      "currency": {
        "name": "US Dollar",
        "code": "USD",
        "symbol": "$"
      }
    },
    "oversizedHandling": true,
    "overweightHandling": false,
    "irregularShapeHandling": false,
    "longItemHandling": false,
    "stackableOnly": true,
    "orientationSensitive": false
  },
  "loadingCapabilities": {
    "loadingMethods": [
      "MANUAL_LOADING",
      "FORKLIFT"
    ],
    "maxLoadingHeight": {
      "value": 3.5,
      "unit": "m"
    },
    "dockAccess": true,
    "curbsideAccess": false,
    "residentialAccess": true,
    "appointmentRequired": true,
    "accessRestrictions": []
  },
  "accessibleBy": [
    "MANUAL",
    "AGV"
  ]
}

Update handling capability

http

PATCH /v1/lsp/carriers/:id/capabilities/handling

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Request Body

typescript

interface Update handling capabilityRequest {
  specialHandling.temperatureControlled: boolean;
  handlingLimits.maxShipmentVolume: {
    value: number;
    unit: string
  };
  handlingLimits.maxShipmentValue.amount: number;
  loadingCapabilities.maxLoadingHeight: {
    value: number;
    unit: string
  };
  accessibleBy: string[];
}

Example:

json

{
  "specialHandling.temperatureControlled": false,
  "handlingLimits.maxShipmentVolume": {
    "value": 2500,
    "unit": "cbm"
  },
  "handlingLimits.maxShipmentValue.amount": 10000,
  "loadingCapabilities.maxLoadingHeight": {
    "value": 3,
    "unit": "m"
  },
  "accessibleBy": [
    "MANUAL",
    "FORKLIFT",
    "AGV"
  ]
}

Get handling capability

http

GET /v1/lsp/carriers/:id/capabilities/handling

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Set coverage capability

http

PUT /v1/lsp/carriers/:id/capabilities/coverage

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Request Body

typescript

interface Set coverage capabilityRequest {
  geography: {
    localService: boolean;
    regionalService: boolean;
    nationalService: boolean;
    internationalService: boolean;
    crossBorderService: boolean
  };
  routing: {
    routeOptimization: boolean;
    dynamicRouting: boolean;
    realTimeRerouting: boolean;
    multiStopOptimization: boolean;
    loadOptimization: boolean;
    timeWindowOptimization: boolean;
    trafficAvoidance: boolean;
    weatherRouting: boolean;
    fuelOptimization: boolean;
    emissionOptimization: boolean;
    costOptimization: boolean;
    constraints: {
    weightRestrictions: boolean;
    heightRestrictions: boolean;
    lengthRestrictions: boolean;
    tunnelRestrictions: boolean;
    bridgeRestrictions: boolean;
    hazmatRestrictions: boolean;
    timeRestrictions: boolean;
    seasonalRestrictions: boolean;
    permitRequired: boolean
  };
    specialRoutes: {
    dedicatedRoutes: boolean;
    expressRoutes: boolean;
    directRoutes: boolean;
    consolidatedRoutes: boolean;
    hubRoutes: boolean;
    shuttleRoutes: boolean;
    milkRunRoutes: boolean;
    backhaul: boolean;
    roundTrip: boolean
  }
  };
  networkIntegration: {
    hubConnectivity: boolean;
    partnerCarriers: boolean;
    interlineAgreements: boolean;
    networkExtensions: boolean;
    lastMilePartners: boolean;
    internationalPartners: boolean;
    modalPartners: any[]
  };
}

Example:

json

{
  "geography": {
    "localService": false,
    "regionalService": false,
    "nationalService": false,
    "internationalService": false,
    "crossBorderService": false
  },
  "routing": {
    "routeOptimization": false,
    "dynamicRouting": false,
    "realTimeRerouting": false,
    "multiStopOptimization": false,
    "loadOptimization": false,
    "timeWindowOptimization": false,
    "trafficAvoidance": false,
    "weatherRouting": false,
    "fuelOptimization": false,
    "emissionOptimization": false,
    "costOptimization": false,
    "constraints": {
      "weightRestrictions": false,
      "heightRestrictions": false,
      "lengthRestrictions": false,
      "tunnelRestrictions": false,
      "bridgeRestrictions": false,
      "hazmatRestrictions": false,
      "timeRestrictions": false,
      "seasonalRestrictions": false,
      "permitRequired": false
    },
    "specialRoutes": {
      "dedicatedRoutes": false,
      "expressRoutes": false,
      "directRoutes": false,
      "consolidatedRoutes": false,
      "hubRoutes": false,
      "shuttleRoutes": false,
      "milkRunRoutes": false,
      "backhaul": false,
      "roundTrip": false
    }
  },
  "networkIntegration": {
    "hubConnectivity": false,
    "partnerCarriers": false,
    "interlineAgreements": false,
    "networkExtensions": false,
    "lastMilePartners": false,
    "internationalPartners": false,
    "modalPartners": []
  }
}

Update coverage capability

http

PATCH /v1/lsp/carriers/:id/capabilities/coverage

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Request Body

typescript

interface Update coverage capabilityRequest {
  routing.expressRoutes: boolean;
  networkIntegration: {
    hubConnectivity: boolean;
    partnerCarriers: boolean;
    interlineAgreements: boolean;
    networkExtensions: boolean;
    lastMilePartners: boolean;
    internationalPartners: boolean;
    modalPartners: string[]
  };
}

Example:

json

{
  "routing.expressRoutes": false,
  "networkIntegration": {
    "hubConnectivity": true,
    "partnerCarriers": true,
    "interlineAgreements": false,
    "networkExtensions": false,
    "lastMilePartners": false,
    "internationalPartners": true,
    "modalPartners": [
      "AIR"
    ]
  }
}

Get coverage capability

http

GET /v1/lsp/carriers/:id/capabilities/coverage

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Set technology capability

http

PUT /v1/lsp/carriers/:id/capabilities/technology

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Request Body

typescript

interface Set technology capabilityRequest {
  tracking: {
    technology: string[];
    frequency: string;
    events: string[];
    visibilityLevel: string;
    proofOfDelivery: {
    signature: boolean;
    photo: boolean;
    timestamp: boolean;
    gpsLocation: boolean;
    barcodeScan: boolean;
    recipientName: boolean;
    deliveryNotes: boolean
  }
  };
  communicationSystems: {
    driver: string[];
    customer: {
    pickupNotifications: boolean;
    deliveryNotifications: boolean;
    exceptionNotifications: boolean;
    proactiveAlerts: boolean;
    smsNotifications: boolean;
    emailNotifications: boolean;
    pushNotifications: boolean;
    webPortal: boolean;
    mobileApp: boolean;
    callCenter: boolean;
    chatSupport: boolean;
    multilingualSupport: boolean
  };
    integration: {
    apiAvailable: boolean;
    restfulApi: boolean;
    graphqlApi: boolean;
    webhooks: boolean;
    ediCapability: boolean;
    cloudIntegration: boolean;
    wmsIntegration: boolean;
    tmsIntegration: boolean;
    ecommerceIntegration: boolean;
    erpIntegration: boolean;
    customsIntegration: boolean;
    paymentIntegration: boolean
  }
  };
  operationalSystems: {
    dispatchSystem: {
    automated: boolean;
    optimized: boolean;
    realTime: boolean;
    cloudBased: boolean;
    mobile: boolean
  };
    routeManagement: {
    routePlanning: boolean;
    routeOptimization: boolean;
    dynamicRouting: boolean;
    trafficIntegration: boolean;
    weatherIntegration: boolean
  };
    fleetManagement: {
    vehicleTracking: boolean;
    maintenanceScheduling: boolean;
    fuelManagement: boolean;
    driverManagement: boolean;
    complianceMonitoring: boolean;
    performanceAnalytics: boolean
  };
    documentManagement: {
    electronicBillOfLading: boolean;
    digitalPod: boolean;
    customsDocuments: boolean;
    invoiceGeneration: boolean;
    reportGeneration: boolean;
    documentStorage: boolean;
    auditTrail: boolean
  }
  };
}

Example:

json

{
  "tracking": {
    "technology": [
      "BARCODE",
      "QR_CODE",
      "RFID",
      "GPS",
      "IOT_SENSORS",
      "GEOFENCING"
    ],
    "frequency": "REAL_TIME",
    "events": [
      "PICKUP",
      "DEPARTURE",
      "DELIVERY",
      "RETURN"
    ],
    "visibilityLevel": "REAL_TIME",
    "proofOfDelivery": {
      "signature": false,
      "photo": false,
      "timestamp": false,
      "gpsLocation": false,
      "barcodeScan": false,
      "recipientName": false,
      "deliveryNotes": false
    }
  },
  "communicationSystems": {
    "driver": [
      "MOBILE_APP",
      "VEHICLE_TABLET",
      "HANDHELD_DEVICE"
    ],
    "customer": {
      "pickupNotifications": false,
      "deliveryNotifications": false,
      "exceptionNotifications": false,
      "proactiveAlerts": false,
      "smsNotifications": false,
      "emailNotifications": false,
      "pushNotifications": false,
      "webPortal": false,
      "mobileApp": false,
      "callCenter": false,
      "chatSupport": false,
      "multilingualSupport": false
    },
    "integration": {
      "apiAvailable": false,
      "restfulApi": false,
      "graphqlApi": false,
      "webhooks": false,
      "ediCapability": false,
      "cloudIntegration": false,
      "wmsIntegration": false,
      "tmsIntegration": false,
      "ecommerceIntegration": false,
      "erpIntegration": false,
      "customsIntegration": false,
      "paymentIntegration": false
    }
  },
  "operationalSystems": {
    "dispatchSystem": {
      "automated": false,
      "optimized": false,
      "realTime": false,
      "cloudBased": false,
      "mobile": false
    },
    "routeManagement": {
      "routePlanning": false,
      "routeOptimization": false,
      "dynamicRouting": false,
      "trafficIntegration": false,
      "weatherIntegration": false
    },
    "fleetManagement": {
      "vehicleTracking": false,
      "maintenanceScheduling": false,
      "fuelManagement": false,
      "driverManagement": false,
      "complianceMonitoring": false,
      "performanceAnalytics": false
    },
    "documentManagement": {
      "electronicBillOfLading": false,
      "digitalPod": false,
      "customsDocuments": false,
      "invoiceGeneration": false,
      "reportGeneration": false,
      "documentStorage": false,
      "auditTrail": false
    }
  }
}

Update technology capability

http

PATCH /v1/lsp/carriers/:id/capabilities/technology

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Request Body

typescript

interface Update technology capabilityRequest {
  tracking.proofOfDelivery.signature: boolean;
}

Example:

json

{
  "tracking.proofOfDelivery.signature": true
}

Get technology capability

http

GET /v1/lsp/carriers/:id/capabilities/technology

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Set service capability

http

PUT /v1/lsp/carriers/:id/capabilities/service

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Request Body

typescript

interface Set service capabilityRequest {
  serviceStandards: {
    onTimePerformance: number;
    deliveryAccuracy: number;
    damageRate: number;
    lossRate: number;
    customerSatisfaction: number;
    complaintResolutionTime: {
    hour: number
  };
    firstAttemptDelivery: number;
    serviceRecovery: boolean
  };
  customerService: {
    customerPortal: boolean;
    mobileApp: boolean;
    trackingPortal: boolean;
    reportingPortal: boolean;
    supportChannels: string[];
    supportHours: {
    hoursPerDay: number;
    daysPerWeek: number;
    holidaySupport: boolean;
    emergencySupport: boolean;
    multilingualSupport: boolean;
    dedicatedAccountManager: boolean
  };
    responseTime: {
    phoneResponse: {
    minute: number
  };
    emailResponse: {
    hour: number
  };
    chatResponse: {
    minute: number
  };
    emergencyResponse: {
    second: number
  };
    complaintResponse: {
    hour: number
  };
    claimResponse: {
    minute: number
  }
  }
  };
  valueAddedServices: {
    packaging: boolean;
    labeling: boolean;
    sorting: boolean;
    consolidation: boolean;
    deconsolidation: boolean;
    crossDocking: boolean;
    warehouse: boolean;
    inventoryManagement: boolean;
    kitting: boolean;
    return: boolean;
    reverseLogistics: boolean;
    customsClearance: boolean;
    dutyPayment: boolean;
    insurance: boolean;
    cashOnDelivery: boolean;
    billAndHold: boolean;
    appointmentScheduling: boolean;
    notification: boolean;
    photo: boolean;
    sigature: boolean
  };
  qualityAssurance: {
    qualityManagementSystem: boolean;
    processDocumentation: boolean;
    trainingPrograms: boolean;
    performanceMonitoring: boolean;
    continuousImprovement: boolean;
    customerFeedback: boolean;
    auditPrograms: boolean;
    corrective: boolean;
    preventiveActions: boolean
  };
}

Example:

json

{
  "serviceStandards": {
    "onTimePerformance": 90,
    "deliveryAccuracy": 99,
    "damageRate": 5,
    "lossRate": 0,
    "customerSatisfaction": 92,
    "complaintResolutionTime": {
      "hour": 2
    },
    "firstAttemptDelivery": 60,
    "serviceRecovery": false
  },
  "customerService": {
    "customerPortal": false,
    "mobileApp": false,
    "trackingPortal": false,
    "reportingPortal": false,
    "supportChannels": [
      "PHONE",
      "EMAIL",
      "CHAT",
      "WEB_PORTAL",
      "MOBILE_APP",
      "SMS",
      "SOCIAL_MEDIA",
      "IN_PERSON"
    ],
    "supportHours": {
      "hoursPerDay": 9,
      "daysPerWeek": 7,
      "holidaySupport": false,
      "emergencySupport": false,
      "multilingualSupport": false,
      "dedicatedAccountManager": false
    },
    "responseTime": {
      "phoneResponse": {
        "minute": 15
      },
      "emailResponse": {
        "hour": 12
      },
      "chatResponse": {
        "minute": 5
      },
      "emergencyResponse": {
        "second": 15
      },
      "complaintResponse": {
        "hour": 2
      },
      "claimResponse": {
        "minute": 30
      }
    }
  },
  "valueAddedServices": {
    "packaging": false,
    "labeling": false,
    "sorting": false,
    "consolidation": false,
    "deconsolidation": false,
    "crossDocking": false,
    "warehouse": false,
    "inventoryManagement": false,
    "kitting": false,
    "return": false,
    "reverseLogistics": false,
    "customsClearance": false,
    "dutyPayment": false,
    "insurance": false,
    "cashOnDelivery": false,
    "billAndHold": false,
    "appointmentScheduling": false,
    "notification": false,
    "photo": false,
    "sigature": false
  },
  "qualityAssurance": {
    "qualityManagementSystem": false,
    "processDocumentation": false,
    "trainingPrograms": false,
    "performanceMonitoring": false,
    "continuousImprovement": false,
    "customerFeedback": false,
    "auditPrograms": false,
    "corrective": false,
    "preventiveActions": false
  }
}

Update service capability

http

PATCH /v1/lsp/carriers/:id/capabilities/service

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Request Body

typescript

interface Update service capabilityRequest {
  serviceStandards.damageRate: number;
  customerService.responseTime.phoneResponse: {
    minute: number
  };
  valueAddedServices.packaging: boolean;
  valueAddedServices.consolidation: boolean;
  qualityAssurance: {
    qualityManagementSystem: boolean;
    processDocumentation: boolean;
    trainingPrograms: boolean;
    performanceMonitoring: boolean;
    continuousImprovement: boolean;
    customerFeedback: boolean;
    auditPrograms: boolean;
    corrective: boolean;
    preventiveActions: boolean
  };
}

Example:

json

{
  "serviceStandards.damageRate": 2,
  "customerService.responseTime.phoneResponse": {
    "minute": 5
  },
  "valueAddedServices.packaging": true,
  "valueAddedServices.consolidation": true,
  "qualityAssurance": {
    "qualityManagementSystem": true,
    "processDocumentation": true,
    "trainingPrograms": false,
    "performanceMonitoring": true,
    "continuousImprovement": true,
    "customerFeedback": true,
    "auditPrograms": true,
    "corrective": true,
    "preventiveActions": true
  }
}

Get service capability

http

GET /v1/lsp/carriers/:id/capabilities/service

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Set compliance capability

http

PUT /v1/lsp/carriers/:id/capabilities/compliance

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Request Body

typescript

interface Set compliance capabilityRequest {
  certifications: string[];
  regulatoryCompliance: {
    dot: boolean;
    fmcsa: boolean;
    iat: boolean;
    tsa: boolean;
    customs: boolean;
    epa: boolean;
    osha: boolean;
    eeoc: boolean;
    localRegulations: boolean;
    stateRegulations: boolean;
    federalRegulations: boolean;
    internationalRegulations: boolean
  };
  safetyStandards: {
    safetyManagementSystem: boolean;
    driverSafetyTraining: boolean;
    vehicleSafetyInspections: boolean;
    accidentPrevention: boolean;
    emergencyResponse: boolean;
    safetyReporting: boolean;
    safetyMetrics: boolean;
    safetyRatings: {
    dot: string;
    insurance: string;
    carrier: number
  }
  };
  securityMeasures: {
    driverBackgroundChecks: boolean;
    vehicleSecuritySystems: boolean;
    cargoSecuritySystems: boolean;
    facilitySecuritySystems: boolean;
    securityTraining: boolean;
    securityProcedures: boolean;
    incidentReporting: boolean;
    securityAudits: boolean;
    chainOfCustody: boolean;
    sealedLoad: boolean;
    secureTransport: boolean;
    highValueCargo: boolean
  };
  insurance: {
    generalLiability: {
    amount: number;
    currency: {
    code: string;
    name: string;
    symbol: string
  }
  };
    cargoInsurance: {
    amount: number;
    currency: {
    code: string;
    name: string;
    symbol: string
  }
  };
    autoLiability: {
    amount: number;
    currency: {
    code: string;
    name: string;
    symbol: string
  }
  };
    workersCompensation: {
    amount: number;
    currency: {
    code: string;
    name: string;
    symbol: string
  }
  };
    selfInsured: boolean;
    deductibles: object
  };
}

Example:

json

{
  "certifications": [
    "FREIGHT_FORWARDER",
    "HAZMAT_CERTIFIED",
    "DOT_CERTIFIED"
  ],
  "regulatoryCompliance": {
    "dot": false,
    "fmcsa": false,
    "iat": false,
    "tsa": false,
    "customs": false,
    "epa": false,
    "osha": false,
    "eeoc": false,
    "localRegulations": false,
    "stateRegulations": false,
    "federalRegulations": false,
    "internationalRegulations": false
  },
  "safetyStandards": {
    "safetyManagementSystem": false,
    "driverSafetyTraining": false,
    "vehicleSafetyInspections": false,
    "accidentPrevention": false,
    "emergencyResponse": false,
    "safetyReporting": false,
    "safetyMetrics": false,
    "safetyRatings": {
      "dot": "SATISFACTORY",
      "insurance": "38-AB-38442",
      "carrier": 78
    }
  },
  "securityMeasures": {
    "driverBackgroundChecks": false,
    "vehicleSecuritySystems": false,
    "cargoSecuritySystems": false,
    "facilitySecuritySystems": false,
    "securityTraining": false,
    "securityProcedures": false,
    "incidentReporting": false,
    "securityAudits": false,
    "chainOfCustody": false,
    "sealedLoad": false,
    "secureTransport": false,
    "highValueCargo": false
  },
  "insurance": {
    "generalLiability": {
      "amount": 120,
      "currency": {
        "code": "GHS",
        "name": "Ghana Cedis",
        "symbol": "GHc"
      }
    },
    "cargoInsurance": {
      "amount": 40,
      "currency": {
        "code": "USD",
        "name": "US Dollar",
        "symbol": "$"
      }
    },
    "autoLiability": {
      "amount": 120,
      "currency": {
        "code": "GHS",
        "name": "Ghana Cedis",
        "symbol": "GHc"
      }
    },
    "workersCompensation": {
      "amount": 300,
      "currency": {
        "code": "GHS",
        "name": "Ghana Cedis",
        "symbol": "GHc"
      }
    },
    "selfInsured": false,
    "deductibles": {}
  }
}

Update compliance capability

http

PATCH /v1/lsp/carriers/:id/capabilities/compliance

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Request Body

typescript

interface Update compliance capabilityRequest {
  regulatoryCompliance.dot: boolean;
  safetyStandards.safetyManagementSystem: boolean;
  insurance.garagekeepersLiability: {
    amount: number;
    currency: {
    code: string;
    name: string;
    symbol: string
  }
  };
}

Example:

json

{
  "regulatoryCompliance.dot": true,
  "safetyStandards.safetyManagementSystem": true,
  "insurance.garagekeepersLiability": {
    "amount": 250,
    "currency": {
      "code": "GHS",
      "name": "Ghana Cedis",
      "symbol": "GHc"
    }
  }
}

Get service capability

http

GET /v1/lsp/carriers/:id/capabilities/service

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Get transport capability

http

GET /v1/lsp/carriers/:id/capacities/:ctype

Headers

de-user-agent (required)
de-auth-token (required)
de-auth-device (required)

Carriers API ​

Endpoints ​

API Reference ​

Create a carrier ​

Headers ​

Request Body ​

Get Carrier profile ​

Headers ​

Get all carriers ​

Headers ​

Update carrier profile ​

Headers ​

Delete carrier ​

Headers ​

Add/Remove pricing to/from a carrier ​

Headers ​

Set transport capability ​

Headers ​

Request Body ​

Update transport capability ​

Headers ​

Request Body ​

Get transport capability ​

Headers ​

Remove transport capability ​

Headers ​

Set fleet capability ​

Headers ​

Request Body ​

Update fleet capability ​

Headers ​

Request Body ​

Get fleet capability ​

Headers ​

Set handling capability ​

Headers ​

Request Body ​

Update handling capability ​

Headers ​

Request Body ​

Get handling capability ​

Headers ​

Set coverage capability ​

Headers ​

Request Body ​

Update coverage capability ​

Headers ​

Request Body ​

Get coverage capability ​

Headers ​

Set technology capability ​

Headers ​

Request Body ​

Update technology capability ​

Headers ​

Request Body ​

Get technology capability ​

Headers ​

Set service capability ​

Headers ​

Request Body ​

Update service capability ​

Headers ​

Request Body ​

Get service capability ​

Headers ​

Set compliance capability ​

Headers ​

Request Body ​

Update compliance capability ​

Headers ​

Request Body ​

Get service capability ​

Headers ​

Get transport capability ​

Headers ​

Carriers API

Endpoints

API Reference

Create a carrier

Headers

Request Body

Get Carrier profile

Headers

Get all carriers

Headers

Update carrier profile

Headers

Delete carrier

Headers

Add/Remove pricing to/from a carrier

Headers

Set transport capability

Headers

Request Body

Update transport capability

Headers

Request Body

Get transport capability

Headers

Remove transport capability

Headers

Set fleet capability

Headers

Request Body

Update fleet capability

Headers

Request Body

Get fleet capability

Headers

Set handling capability

Headers

Request Body

Update handling capability

Headers

Request Body

Get handling capability

Headers

Set coverage capability

Headers

Request Body

Update coverage capability

Headers

Request Body

Get coverage capability

Headers

Set technology capability

Headers

Request Body

Update technology capability

Headers

Request Body

Get technology capability

Headers

Set service capability

Headers

Request Body

Update service capability

Headers

Request Body

Get service capability

Headers

Set compliance capability

Headers

Request Body

Update compliance capability

Headers

Request Body

Get service capability

Headers

Get transport capability

Headers