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
Languages
Servers
Mock server
https://developers.project44.com/_mock/api-reference/api-docs/
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/

OAuth 2.0: Client Applications

API used for registering and managing OAuth 2.0 client applications. See the "Authentication" section above for more information. To authorize API requests to project44 for an API integration, first your client application must be registered with project44, which will issue your application a client id and secret. These credentials can then be used to generate bearer tokens, which can be included on all other API requests to authorize your client application. The client application is authorized through the project44 user management UI as a machine user with username "app-{client_id}@client-applications.project44.com".

An admin user (with VOC user role "Customer Admin") must use HTTP Basic Authentication with this API to manage client applications. Basic Authentication is deprecated for all other APIs, besides token generation, in favor of passing the access token generated via OAuth 2.0.

Operations

OAuth 2.0: Token Generation

API for OAuth 2.0 token generation. See the "Authentication" section above for more information. Once your client application is registered, you can use the token generation endpoint to authenticate with your application's client id and secret in exchange for a bearer token to be included on all other API requests to authenticate as that client application. The client application is authorized through the project44 user management UI as a machine user with username "app-{client_id}@client-applications.project44.com".

To generate an access token, you may authenticate your client application by providing its client id and secret either in the body of the request or in the form of HTTP Basic Authentication (but you may not use both ways in the same request).

Operations

LTL: Quotes

Quote LTL rates and retrieve transit times.

Operations

VLTL: Quotes

API used for quoting volume LTL rates.

Operations

VLTL: Dispatch

API used for scheduling volume LTL shipments.

Operations

LTL: Dispatch

API used for scheduling LTL shipments.

Operations

LTL: Tracking

API used for the retrieval of shipment status.

Operations

LTL: Image Retrieval

Access shipment images.

Operations

TL: Tracking

project44's Truckload Tracking endpoints give you or your customers visibility into your truckload shipments, including such features as predictive ETAs and temperature tracking. Use these endpoints to initialize (POST), track (GET), update (PUT), cancel (POST) or delete(DELETE) truckload shipments. You can return shipment information by either unique system ID or by identifier.

Operations

TL: Available Vehicles

API used for fetching vehicles within a specific radius and time window. Can only be used if opted into a project44 Co-Op.

Operations

TL: Connected Capacity

API for finding new connected carrier partners in the project44 network based on tracking performance

Operations

Rail: Tracking

API used for accessing rail shipment tracking.

Operations

Capacity Provider Account Group Management

Manage capacity provider account groups. Groups are used to sort capacity provider accounts on a per customer or location basis.

For example, you can add multiple capacity providers to a group if they all share lanes to the same origin/destination location.

Another example, if certain customers receive different rates for a capacity provider, it may be reasonable to use separate groups for each customer's capacity provider accounts.

Use these APIs to create (POST), retrieve (GET) or delete (DELETE) capacity provider account groups.

Operations

Capacity Provider Account Management

Manage capacity provider accounts where a capacity provider is typically used to represent a carrier.

Capacity providers have capacity provider account definitions also known as capacity provider account types. Capacity provider accounts are arranged in sets where each set contains one or more accounts for the same capacity provider. Each capacity provider's service is compatible with one and only one of these capacity provider accounts. Because most capacity providers have only one capacity provider account definition, most sets will contain only one capacity provider account. For capacity providers with more then one account definition, the set of accounts may consist of one account per account definition.

For example, FedEx has a standard account to be used with LTL rating, LTL and Volume LTL dispatch, tracking, and imaging and a separate account for Volume LTL rating. A set of FedEx capacity provider accounts may have a single standard account, a single volume LTL rating account, or both. Providing the capacity provider account set code in the request resolves which capacity provider account to use.

Capacity provider specific credential information is available in the portal.

Use these APIs to create (POST), retrieve (GET), update (POST) or delete (DELETE) capacity provider accounts.

Operations

Capacity Provider Contact Management

Manage locations. Locations combine physical addresses with contact details and are used in configuring Capacity Provider Accounts and Stop Locations, for example to identify the Bill To party.

Use these APIs to create (POST), update (PUT) or retrieve (GET) locations.

These operations are also all available under the /locations endpoint for backward compatibility.

Operations

Order Visibility

API used for orders and inventory items

Operations

Shipment: Tracking

API used for Shipment Tracking.

Operations

Shipment: Loads

API used for tracking Loads.

Operations

Multi-Modal: Image Retrieval

Access shipment images.

Operations

Shipment Attributes

Create and fetch predefined custom attributes for shipments. You must be a organization admin to perform this operation.

Operations

Capacity Provider Metadata

Retrieve capacity provider information needed to set up capacity provider accounts.

Operations

LTL: Push Tracking

As a capacity provider, push project44 shipments and status updates.

Operations

Upsert shipment details.

Request

Required Fields

  • customerAccount:
    • accountIdentifier
  • carrierIdentifier:
    • type
    • value
  • shipmentIdentifiers:
    • type
    • value
    • primaryForType (if more than one shipment identifier of the same type)
Bodyrequired

shipment

carrierIdentifierobject(CapacityProviderIdentifier)

A capacity provider identifier object.

customerAccountobject(CustomerAccount)
shipmentIdentifiersArray of objects(LtlShipmentIdentifier)

A list of shipment identifiers that, with the exception of the EXTERNAL type, can be used to track the shipment. At least one identifier of type 'PRO' must be included in the list. The source field cannot be provided in this API.

shipmentStopsArray of objects(LtlTrackedShipmentStop)

A list of the shipment stops for the shipment. When stop data is provided, there must be at least two stops -- one of type 'ORIGIN' and one of type 'DESTINATION'. 'ORIGIN' and 'DESTINATION' stops must have location address information including addressLines, city, state, country, postalCode and location contact information including companyName. Stops of type 'TERMINAL' (service center) may be included or added as the shipment is tracked and they are discovered. 'TERMINAL' stops must have location address information including city, state, country, postalCode and location contact information including companyName. 'TERMINAL' stops must also have terminalCode. All stop types require a stop number. The stop number represents the order for which the stops will be visited. Besides 'ORIGIN' always being stopNumber: 1, stopNumber may change as 'TERMINAL's are discovered throughout tracking (i.e. initially there may only be two known stops; 'ORIGIN' with stopNumber 1 and 'DESTINATION' with stopNumber 2. Once a 'TERMINAL' stop is discovered, the 'DESTINATION' stop will now have stopNumber 3. Stop objects contain an object called 'appointmentWindow'. These appointment windows are the requested appointment windows found on the bill of lading. If the stop type is 'ORIGIN', it is a requested pickup appointment window and if the stop type is 'DESTINATION', it is a requested delivery appointment window.

sourceTypestring

The original type of data source for where this shipment originated from. (default: API)

Enum"API""EDI"
transitDaysinteger(int32)

The number of days it will take to deliver the load after pickup.

curl -i -X PUT \
  https://developers.project44.com/_mock/api-reference/api-docs/api/v4/capacityproviders/ltl/shipments \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "carrierIdentifier": {
      "type": "SCAC",
      "value": "string"
    },
    "customerAccount": {
      "accountIdentifier": "string"
    },
    "shipmentIdentifiers": [
      {
        "type": "PRO",
        "value": "string",
        "primaryForType": true,
        "source": "CUSTOMER"
      }
    ],
    "shipmentStops": [
      {
        "additionalAppointmentWindows": [
          {
            "type": "STRATEGIC",
            "appointmentWindow": {
              "startDateTime": "2019-08-24T14:15:22Z",
              "endDateTime": "2019-08-24T14:15:22Z",
              "localTimeZoneIdentifier": "string"
            },
            "appointmentStatus": "PENDING",
            "identifiers": [
              {
                "type": "DOCK",
                "value": "string"
              }
            ]
          }
        ],
        "appointmentWindow": {
          "startDateTime": "2019-08-24T14:15:22Z",
          "endDateTime": "2019-08-24T14:15:22Z",
          "localTimeZoneIdentifier": "string"
        },
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "id": 0,
        "involvedParties": [
          {
            "partyIdentifiers": [
              {
                "type": "ACCOUNT",
                "value": "string"
              }
            ]
          }
        ],
        "location": {
          "address": {
            "postalCode": "string",
            "addressLines": [
              "str"
            ],
            "city": "string",
            "state": "string",
            "country": "US"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "stopDescription": "string",
        "stopName": "string",
        "stopNumber": 0,
        "stopType": "ORIGIN",
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
      }
    ],
    "sourceType": "API",
    "transitDays": 0
  }'

Responses

Accepted

Body
Response
{ "httpStatusCode": 0, "httpMessage": "string", "errorMessage": "string", "errors": [ {} ], "supportReferenceId": "string" }

Create status updates for a shipment.

Request

Required Fields

  • customerAccount:
    • accountIdentifier
  • carrierIdentifier:
    • type
    • value
  • shipmentIdentifiers:
    • type
    • value
    • primaryForType (if more than one shipment identifier of the same type)
  • statusCode
  • location: (if statusCode is 'ARRIVED_AT_TERMINAL' or 'DEPARTED_TERMINAL')
    • address: (if location provided)
      • city (if location provided)
      • state (if location provided and country is US)
      • country (if location provided and country is not US. Default: US)
  • deliveryAppointmentWindow: (if statusCode is 'UPDATED_DELIVERY_APPT')
  • timestamp
Bodyrequired

statusUpdate

arrivalEstimateobject(LtlCapacityProviderPushShipmentArrivalEstimate)
carrierIdentifierobject(CapacityProviderIdentifier)

A capacity provider identifier object.

customerAccountobject(CustomerAccount)
deliveryAppointmentWindowobject(OffsetDateTimeWindow)

A date and time range, with time zone offset.

geoCoordinatesobject(GeoCoordinates)
locationobject(Location)

A physical location.

proIdentifierobject(LtlShipmentIdentifier)
shipmentIdentifiersArray of objects(LtlShipmentIdentifier)

A list of shipment identifiers that, with the exception of the EXTERNAL type, can be used to track the shipment. At least one identifier of type 'PRO' must be included in the list. The source field cannot be provided in this API.

sourceTypestring

The original type of data source for where this status update originated from. (default: API)

Enum"API""EDI"
statusCodestring

The project44 status code for this status update. This field must always be populated.

Enum"READY_FOR_PICKUP""UPDATED_PICKUP_APPT""EXCEPTION""PICKED_UP""ARRIVED_AT_TERMINAL""REWEIGHT_RECLASS""INFO""UPDATED_DELIVERY_APPT""DEPARTED_TERMINAL""OUT_FOR_DELIVERY""DELIVERED"
statusReasonobject(LtlCapacityProviderPushStatusReason)
stopNumberinteger(int32)

The stop number, where '1' is the origin and the destination has the largest number, with any stops in between ordered by appointment time.

stopTypestring

The type of the shipment stop to which this status update corresponds, if any. For example, a status update with code 'AT_STOP' will typically have this field populated with the stop type the vehicle is at.

Enum"ORIGIN""DESTINATION""TERMINAL"
terminalCodestring

The service center's code. For example, the capacity provider's service center in Miami may have a code like 'MIA-123' or 'MIA'. This should match a stop code of one of the shipment stop's stop codes.

timestampstring

The timestamp of this status update in the time zone of the location (format: yyyy-MM-dd'T'HH:mm:ssZ). If this status update has no location, the time zone should be UTC.

curl -i -X POST \
  https://developers.project44.com/_mock/api-reference/api-docs/api/v4/capacityproviders/ltl/shipments/statusupdates \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "arrivalEstimate": {
      "estimatedArrivalWindow": {
        "startDateTime": "2019-08-24T14:15:22Z",
        "endDateTime": "2019-08-24T14:15:22Z"
      }
    },
    "carrierIdentifier": {
      "type": "SCAC",
      "value": "string"
    },
    "customerAccount": {
      "accountIdentifier": "string"
    },
    "deliveryAppointmentWindow": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "endDateTime": "2019-08-24T14:15:22Z"
    },
    "geoCoordinates": {
      "latitude": -90,
      "longitude": -180
    },
    "location": {
      "address": {
        "postalCode": "string",
        "addressLines": [
          "str"
        ],
        "city": "string",
        "state": "string",
        "country": "US"
      },
      "contact": {
        "companyName": "string",
        "contactName": "string",
        "phoneNumber": "string",
        "phoneNumberCountryCode": "string",
        "phoneNumber2": "string",
        "phoneNumber2CountryCode": "string",
        "email": "string",
        "faxNumber": "string",
        "faxNumberCountryCode": "string"
      }
    },
    "proIdentifier": {
      "type": "PRO",
      "value": "string",
      "primaryForType": true,
      "source": "CUSTOMER"
    },
    "shipmentIdentifiers": [
      {
        "type": "PRO",
        "value": "string",
        "primaryForType": true,
        "source": "CUSTOMER"
      }
    ],
    "sourceType": "API",
    "statusCode": "READY_FOR_PICKUP",
    "statusReason": {
      "description": "string",
      "reasonDetailCode": "APPOINTMENT_SET",
      "reasonSummaryCode": "APPOINTMENT_ISSUE"
    },
    "stopNumber": 0,
    "stopType": "ORIGIN",
    "terminalCode": "string",
    "timestamp": "string"
  }'

Responses

Accepted

Body
Response
{ "httpStatusCode": 0, "httpMessage": "string", "errorMessage": "string", "errors": [ {} ], "supportReferenceId": "string" }

LTL: Push Imaging

As a capacity provider, push project44 images related to shipments.

Operations

TL: Capacity Provider Push

As a capacity provider, push project44 shipment-related info and quotes.

Operations

Asset Tracking

Track the location of an enrolled asset.

Operations

Webhook

Register client webhooks.

Operations

Parcel: Tracking

Track parcel shipments. Before parcel shipments can be tracked, they must first be initialized with a shipment identifier. Shipments cannot be modified once initialized and tracking has begun. To stop tracking a shipment, delete it.

Use these APIs to initialize (POST), track (GET), or delete (DELETE) parcel shipments.

Operations

Parcel: Webhook

Receive updates for a tracked parcel by defining a parcel-tracking-webhook.

Operations

Carrier: Document

API for managing carrier documents.

Analytics: Port Intelligence

API for Port Intelligence.

Operations

Filter Suggestions

Operations

Multi-modal: Booking

API used for multi-modal Booking.

LTL: Electronic BOL

API used for creating Electronic BOL

Operations

Webhook Data

Operations to describe the payload expected from project44 when integrated with a webhook.

Operations

Postal Address Validation

Operations

Parcel: Push Tracking

Operations

location-controller

Operations

Ocean: Tracking

Operations

Stop Location Management

Operations

TL: Webhook

Operations

Push Updates

Operations

Multi-Modal: Booking

Operations

APIs

Operations

Invitations

Operations

Multi-Modal: Document

Operations