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
NA - Endpoint for project44 tenants created in the NA region
https://na12.api.project44.com/
EU - Endpoint for project44 tenants created in the EU region
https://eu12.api.project44.com/
Sandbox - 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

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

LTL: Electronic BOL

API used for creating Electronic BOL

Operations

LTL: Address Book

...

Operations

VLTL: Quotes

API used for quoting volume LTL rates.

Operations

VLTL: Dispatch

API used for scheduling volume LTL shipments.

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: Webhook

...

Operations

TL: Connected Capacity

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

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

Rail: Tracking

API used for accessing rail shipment tracking.

Operations

Ocean: Tracking

...

Operations

Shipment: Tracking

API used for Shipment Tracking.

Operations

Filter Suggestions

...

Operations

Shipment Attributes

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

Operations

Shipment: Loads

API used for tracking Loads.

Operations

Order Visibility

API used for orders and inventory items

Operations

Multi-Modal: Image Retrieval

Access shipment images.

Operations

Multi-Modal: Booking

API used for multi-modal Booking.

Operations

Multi-Modal: Document

...

Operations

Create Document

Request

Create a document

Bodymultipart/form-datarequired
documentstring
upload_filestring(binary)
curl -i -X POST \
  https://na12.api.project44.com/services/document/v1/documents \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F document=string \
  -F upload_file=string

Responses

Successful Response

Bodyapplication/json
addedByCompanystring

The company name of the tenant owning this document.

addedByUserstring

The name of the user owning this document.

createdDateTimestring(date-time)

The date and time when this document was created. This value is read only.

deletedDateTimestring(date-time)

The date and time when this document was deleted. This value is read only.

filesArray of objects(Image)

The list of images related to this document.

identifiersArray of objects(Identifier)non-empty

The list of identifiers related to this document. When x-tenant-role is 'CARRIER' InternalEntityType.SHIPPER_TENANT_UUID is MANDATORY if you want to associate this Document to Shipment. InternalEntityType.SHIPPER_TENANT_UUID is number identifying Shipper in project44.

idstring(uuid)

The id of this document. Will always be populated on response.

lastModifiedDateTimestring(date-time)

The date and time when this document was last modified. This value is read only.

namestring

The name of this document.

typestring

An enumeration.

Enum"BILL_OF_LADING""HOUSE_BILL_OF_LADING""AIRWAY_BILL""COMMERCIAL_INVOICE""CUSTOMS_DOCUMENTS""PACKING_SLIP""CERTIFICATE_OF_ORIGIN""PROOF_OF_DELIVERY""DELIVERY_RECEIPT""ECMR""WEIGHT_CERTIFICATE""INSPECTION_CERTIFICATE""LETTER_OF_AUTHORIZATION""LUMPER_CERTIFICATE""INVOICE"
Response
application/json
{ "addedByCompany": "string", "addedByUser": "string", "createdDateTime": "2019-08-24T14:15:22Z", "deletedDateTime": "2019-08-24T14:15:22Z", "files": [ { … } ], "identifiers": [ { … } ], "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "lastModifiedDateTime": "2019-08-24T14:15:22Z", "name": "string", "type": "BILL_OF_LADING" }

Get Document

Request

Get a document by ID

Path
documentIdstring(uuid)required
curl -i -X GET \
  'https://na12.api.project44.com/services/document/v1/documents/{documentId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Put Document

Request

Update a document

Path
documentIdstring(uuid)required
Bodyapplication/jsonrequired
identifiersArray of objects(Identifier)non-empty

The list of identifiers related to this document. When x-tenant-role is 'CARRIER' InternalEntityType.SHIPPER_TENANT_UUID is MANDATORY if you want to associate this Document to Shipment. InternalEntityType.SHIPPER_TENANT_UUID is number identifying Shipper in project44.

namestring

The name of this document.

typestring

An enumeration.

Enum"BILL_OF_LADING""HOUSE_BILL_OF_LADING""AIRWAY_BILL""COMMERCIAL_INVOICE""CUSTOMS_DOCUMENTS""PACKING_SLIP""CERTIFICATE_OF_ORIGIN""PROOF_OF_DELIVERY""DELIVERY_RECEIPT""ECMR""WEIGHT_CERTIFICATE""INSPECTION_CERTIFICATE""LETTER_OF_AUTHORIZATION""LUMPER_CERTIFICATE""INVOICE"
curl -i -X PUT \
  'https://na12.api.project44.com/services/document/v1/documents/{documentId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "identifiers": [
      {
        "type": "AIR_WAYBILL",
        "value": "string"
      }
    ],
    "name": "string",
    "type": "BILL_OF_LADING"
  }'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Delete Document

Request

Delete a document

Path
documentIdstring(uuid)required
curl -i -X DELETE \
  'https://na12.api.project44.com/services/document/v1/documents/{documentId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Patch Document

Request

Update a document

Path
documentIdstring(uuid)required
Bodyapplication/jsonrequired
identifiersArray of objects(Identifier)

The list of identifiers related to this document.

namestring

The name of this document.

typestring

An enumeration.

Enum"BILL_OF_LADING""HOUSE_BILL_OF_LADING""AIRWAY_BILL""COMMERCIAL_INVOICE""CUSTOMS_DOCUMENTS""PACKING_SLIP""CERTIFICATE_OF_ORIGIN""PROOF_OF_DELIVERY""DELIVERY_RECEIPT""ECMR""WEIGHT_CERTIFICATE""INSPECTION_CERTIFICATE""LETTER_OF_AUTHORIZATION""LUMPER_CERTIFICATE""INVOICE"
curl -i -X PATCH \
  'https://na12.api.project44.com/services/document/v1/documents/{documentId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "identifiers": [
      {
        "type": "AIR_WAYBILL",
        "value": "string"
      }
    ],
    "name": "string",
    "type": "BILL_OF_LADING"
  }'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Search Documents

Request

Get documents

Query
pageinteger>= 1
Default 1
sizeinteger[ 1 .. 500 ]
Default 10
Bodyapplication/json
identifiersobject

List of logistics identifiers. Only equal operator is supported.

nameobject

The name of the document to search for

typeobject

List of document types to filter. Only equal operator is supported.