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

Create an item.

Request

InventoryItem should be passed without populating the id field. A unique id will be generated and returned in the response. This id will be used to identify the item across all other methods. This method will return 202 Accepted when the item has been queued for creation. The item is created asynchronously.

Bodyapplication/jsonrequired

item

consumeByDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
descriptionstring
idstring
inventoryDimensionalWeightobject(DimensionalWeight)
inventoryIdentifiersArray of objects(InventoryIdentifier)
lineItemHazmatDetailobject(LineItemHazmatDetail)

Provides important information about the hazardous materials to be transported, as required by the US Department of Transportation (DOT). Only required for shipment requests.

manufacturedDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
orderIdsArray of strings
packagedDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
perUnitCostobject(MonetaryValue)

A monetary value expressing amount and currency type.

perUnitRetailValueobject(MonetaryValue)

A monetary value expressing amount and currency type.

perishableboolean
promotionalDateTimeWindowobject(OffsetDateTimeWindow)

A date and time range, with time zone offset.

sellByDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
serialNumberstring
shipmentIdsArray of strings(uuid)
stockKeepingUnitstring
taxableboolean
universalProductCodestring
curl -i -X POST \
  https://developers.project44.com/_mock/api-reference/api-docs/api/v4/inventory/items \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "consumeByDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "description": "string",
    "id": "string",
    "inventoryDimensionalWeight": {
      "cubicDimension": {
        "length": 0,
        "width": 0,
        "height": 0
      },
      "lengthUnit": "IN",
      "packageType": "BAG",
      "quantity": 0,
      "weight": {
        "weight": 0,
        "weightUnit": "LB"
      }
    },
    "inventoryIdentifiers": [
      {
        "description": "string",
        "type": "DEPARTMENT",
        "value": "string"
      }
    ],
    "lineItemHazmatDetail": {
      "identificationNumber": "string",
      "properShippingName": "string",
      "hazardClass": "string",
      "packingGroup": "I"
    },
    "manufacturedDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "orderIds": [
      "string"
    ],
    "packagedDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "perUnitCost": {
      "currency": "USD",
      "amount": 0
    },
    "perUnitRetailValue": {
      "currency": "USD",
      "amount": 0
    },
    "perishable": true,
    "promotionalDateTimeWindow": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "endDateTime": "2019-08-24T14:15:22Z"
    },
    "sellByDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "serialNumber": "string",
    "shipmentIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "stockKeepingUnit": "string",
    "taxable": true,
    "universalProductCode": "string"
  }'

Responses

Accepted

Body
idstring
Response
{ "id": "string" }

createItems

Request

Bodyapplication/jsonrequired

items

itemsArray of objects(InventoryItem)
curl -i -X POST \
  https://developers.project44.com/_mock/api-reference/api-docs/api/v4/inventory/items/bulk \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "consumeByDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
        "description": "string",
        "id": "string",
        "inventoryDimensionalWeight": {
          "cubicDimension": {
            "length": 0,
            "width": 0,
            "height": 0
          },
          "lengthUnit": "IN",
          "packageType": "BAG",
          "quantity": 0,
          "weight": {
            "weight": 0,
            "weightUnit": "LB"
          }
        },
        "inventoryIdentifiers": [
          {
            "description": "string",
            "type": "DEPARTMENT",
            "value": "string"
          }
        ],
        "lineItemHazmatDetail": {
          "identificationNumber": "string",
          "properShippingName": "string",
          "hazardClass": "string",
          "packingGroup": "I"
        },
        "manufacturedDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
        "orderIds": [
          "string"
        ],
        "packagedDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
        "perUnitCost": {
          "currency": "USD",
          "amount": 0
        },
        "perUnitRetailValue": {
          "currency": "USD",
          "amount": 0
        },
        "perishable": true,
        "promotionalDateTimeWindow": {
          "startDateTime": "2019-08-24T14:15:22Z",
          "endDateTime": "2019-08-24T14:15:22Z"
        },
        "sellByDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
        "serialNumber": "string",
        "shipmentIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "stockKeepingUnit": "string",
        "taxable": true,
        "universalProductCode": "string"
      }
    ]
  }'

Responses

OK

Body
idsArray of objects(InventoryId)
Response
{ "ids": [ { … } ] }

Search for items.

Request

Use the BasicInventoryItemSearchCriteria, page number, page size and sort field to perform Inventory Item search

Query
pageinteger(int32)

Page number valid range: [1, 50]

sizeinteger(int32)

Page size valid range: [1, 100]

sortstring

Inventory Sortable Fields: [stockKeepingUnit, description, universalProductCode, inventoryIdentifiers.type, manufacturedDateTime, packagedDateTime, sellByDateTime, consumeByDateTime, lineItemHazmatDetail.hazardClass]

Default "stockKeepingUnit:ASC"
Bodyapplication/jsonrequired

criteria

consumeByDateTimeRangeobject(OffsetDateTimeRangeFilter)

A date and time range filter, with time zone offset.

hazardClassesArray of strings
idsArray of strings
inventoryIdentifiersArray of objects(InventoryIdentifier)
manufacturedDateTimeRangeobject(OffsetDateTimeRangeFilter)

A date and time range filter, with time zone offset.

orderIdsArray of strings
packagedDateTimeRangeobject(OffsetDateTimeRangeFilter)

A date and time range filter, with time zone offset.

perUnitCostobject(MonetaryValueRangeFilter)
perUnitRetailValueobject(MonetaryValueRangeFilter)
perishableboolean
searchTextstring
sellByDateTimeRangeobject(OffsetDateTimeRangeFilter)

A date and time range filter, with time zone offset.

shipmentIdsArray of strings(uuid)
skusArray of strings
taxableboolean
upcsArray of strings
curl -i -X POST \
  'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/inventory/items/search?page=0&size=0&sort=stockKeepingUnit%3AASC' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "consumeByDateTimeRange": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "startDateTimeInclusive": true,
      "endDateTime": "2019-08-24T14:15:22Z",
      "endDateTimeInclusive": true
    },
    "hazardClasses": [
      "string"
    ],
    "ids": [
      "string"
    ],
    "inventoryIdentifiers": [
      {
        "description": "string",
        "type": "DEPARTMENT",
        "value": "string"
      }
    ],
    "manufacturedDateTimeRange": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "startDateTimeInclusive": true,
      "endDateTime": "2019-08-24T14:15:22Z",
      "endDateTimeInclusive": true
    },
    "orderIds": [
      "string"
    ],
    "packagedDateTimeRange": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "startDateTimeInclusive": true,
      "endDateTime": "2019-08-24T14:15:22Z",
      "endDateTimeInclusive": true
    },
    "perUnitCost": {
      "minimumValue": {
        "currency": "USD",
        "amount": 0
      },
      "minimumValueInclusive": true,
      "maximumValue": {
        "currency": "USD",
        "amount": 0
      },
      "maximumValueInclusive": true
    },
    "perUnitRetailValue": {
      "minimumValue": {
        "currency": "USD",
        "amount": 0
      },
      "minimumValueInclusive": true,
      "maximumValue": {
        "currency": "USD",
        "amount": 0
      },
      "maximumValueInclusive": true
    },
    "perishable": true,
    "searchText": "string",
    "sellByDateTimeRange": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "startDateTimeInclusive": true,
      "endDateTime": "2019-08-24T14:15:22Z",
      "endDateTimeInclusive": true
    },
    "shipmentIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "skus": [
      "string"
    ],
    "taxable": true,
    "upcs": [
      "string"
    ]
  }'

Responses

OK

Body
paginationInfoobject(PaginationInfo)

Pagination information about a collection of resources.

resultsArray of objects(InventoryItem)

List of resources contained on this page.

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

Delete an item.

Request

Use InventoryItem.id to delete the InventoryItem.

Path
idstringrequired

The project44-generated id of the item you wish to delete.

curl -i -X DELETE \
  'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/inventory/items/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Accepted

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

Get an item by project44 id.

Request

Use the id returned from createItem to retrieve the InventoryItem.

Path
idstringrequired

The project44-generated id of the item you wish to query.

curl -i -X GET \
  'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/inventory/items/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
consumeByDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
descriptionstring
idstring
inventoryDimensionalWeightobject(DimensionalWeight)
inventoryIdentifiersArray of objects(InventoryIdentifier)
lineItemHazmatDetailobject(LineItemHazmatDetail)

Provides important information about the hazardous materials to be transported, as required by the US Department of Transportation (DOT). Only required for shipment requests.

manufacturedDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
orderIdsArray of strings
packagedDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
perUnitCostobject(MonetaryValue)

A monetary value expressing amount and currency type.