Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.

project44 REST API (4.0.0)

Version 4.0.0 of project44's API

Download OpenAPI description
api.json
api.yaml
Overview
License © 2024 project44 - Terms of Use
Languages
Servers
Mock server
https://developers.project44.com/_mock/guides/shippers/other/truckload-cooperative/api/
API endpoint for project44 tenants created in NA region
https://na12.api.project44.com/
API endpoint for project44 tenants created in EU region
https://eu12.api.project44.com/
API endpoint for project44 tenants created in the Sandbox environment
https://na12.api.sandbox.p-44.com/

Manage Client Applications

Operations

Generate Tokens

Operations

TL: Available Vehicles

Operations

Get a list of available vehicles within the radius.

Request

Use this POST call to get ETA of all vehicles that are terminating their route within the radius. Search can be enhanced with the type of truck, radius size from the given location and a termination time window.


Required Fields

  • timeRange:
    • startDateTime
  • location:
    • address: (if no geoCoordinates provided)
      • postalCode
      • addressLines
      • city
      • state (for USA, Mexico and Canada)
    • geoCoordinates (if no address provided)
      • latitude
      • longitude
Query
pageinteger(int32)

Page number valid range: [1, 1000]

sizeinteger(int32)

Page size valid range: [1, 1000]

sortstring

Sortable Fields [distance, carrierContact, estimatedArrivalDateTime, truckType]

Bodyapplication/jsonrequired

availableVehiclesQuery

addressobject(Address)

A postal address.

geoCoordinatesobject(GeoCoordinates)
includeMyShipmentsboolean

Allows users to exclude shipments belonging to their tenant.

radiusinteger(int32)

Search radius for capacity. Default is 25 miles or 40 km if no value is submitted. Valid values are any integer between 10-50 for miles and 16-80 for km.

radiusUnitstring

Unit of the search radius for capacity. Default is miles.

Enum"FT""M""MI""KM"
sharingPoolstring

Optional parameter that will only return results from a specified pool. This will only apply to customers in more than 1 pool.

timeRangeobject(OffsetDateTimeWindow)

A date and time range, with time zone offset.

truckTypestring

Optional parameter that will return available capacity specific to the type of truck requested.

Enum"AUTO_CARRIER""B_TRAIN""CONESTOGA""CONTAINER""CONTAINER_INSULATED""CONTAINER_REFRIGERATED""CONVEYOR""DOUBLE_DROP""DROP_DECK_LANDOLL""DUMP_TRAILER""FLAT_BED""FLATBED_AIR_RIDE""FLATBED_CONESTOGA""FLATBED_DOUBLE""FLATBED_HAZMAT"
curl -i -X POST \
  'https://developers.project44.com/_mock/guides/shippers/other/truckload-cooperative/api/api/v4/tl/available-vehicles/query?page=0&size=0&sort=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "address": {
      "postalCode": "string",
      "addressLines": [
        "str"
      ],
      "city": "string",
      "state": "string",
      "country": "US"
    },
    "geoCoordinates": {
      "latitude": -90,
      "longitude": -180
    },
    "includeMyShipments": true,
    "radius": 0,
    "radiusUnit": "FT",
    "sharingPool": "string",
    "timeRange": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "endDateTime": "2019-08-24T14:15:22Z"
    },
    "truckType": "AUTO_CARRIER"
  }'

Responses

OK

Bodyapplication/json
paginationInfoobject(PaginationInfo)

Pagination information about a collection of resources.

resultsArray of objects(AvailableVehicles)

List of resources contained on this page.

Response
application/json
{
  "paginationInfo": {
    "total": 0,
    "pageSize": 0,
    "pageNumber": 0
  },
  "results": [
    { … }
  ]
}