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

Servers

Mock server

https://developers.project44.com/_mock/guides/shippers/other/loads/api/

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/

Manage Client Applications

Operations

Generate Tokens

Operations

Shipment Loads

Operations

Create a load.

Request

Required Fields

identifiers: (at least one)

type
value

Bodyapplication/jsonrequired

load

deliveryStopReferenceobject(StopReference)

Reference to a specific stop on a shipment.

descriptionstring

A description of the overall load.

handlingUnitsobject(LoadHandlingUnits)

A description of handling units for a load

idstring(uuid)

The unique project44-generated id of the load. This can be null when the load is created, but will always exist in the response after the load has been created.

identifiersArray of objects(LogisticsIdentifier)

The identifiers that can identify this Load. This could be, but not limited to, a shipment identifier such as a BOL or an order-based identifier such as Purchase Order or ASN.

involvedPartiesArray of objects(Party)

Parties which are specifically related to this load and the identifiers which are associated with those parties. This identifies the relationship between the load and its relevant parties.

itemsArray of objects(LoadItem)

A list of items contained within this load.

masterShipmentIdstring(uuid)

The project44-generated id of the shipment with which the load is associated.

pickupStopReferenceobject(StopReference)

Reference to a specific stop on a shipment.

curl -i -X POST \
  https://developers.project44.com/_mock/guides/shippers/other/loads/api/api/v4/loads \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "deliveryStopReference": {
      "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43"
    },
    "description": "string",
    "handlingUnits": {
      "details": [
        {
          "cubicDimension": {
            "height": 0,
            "length": 0,
            "unit": "IN",
            "width": 0
          },
          "handlingUnitType": "BAG",
          "quantity": 0,
          "volume": {
            "unit": "CUBIC_FT",
            "value": 0
          },
          "weight": {
            "weight": 0,
            "weightUnit": "LB"
          }
        }
      ]
    },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "identifiers": [
      {
        "type": "AIR_WAYBILL",
        "value": "string"
      }
    ],
    "involvedParties": [
      {
        "partyIdentifiers": [
          {
            "type": "ACCOUNT",
            "value": "string"
          }
        ]
      }
    ],
    "items": [
      {
        "description": "string",
        "identifiers": [
          {
            "type": "STOCK_KEEPING_UNIT",
            "value": "string"
          }
        ],
        "orderIdentifierReferences": [
          {
            "orderId": "string",
            "orderIdentifier": "string",
            "orderIdentifierAuthority": "string",
            "orderType": "PURCHASE_ORDER"
          }
        ],
        "unitQuantity": 0,
        "unitType": "BAG"
      }
    ],
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "pickupStopReference": {
      "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43"
    }
  }'

Responses

Accepted

Body

idstring(uuid)

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get a load by load id.

Request

Required Fields

loadId

Path

loadIdstring(uuid)required

loadId

curl -i -X GET \
  'https://developers.project44.com/_mock/guides/shippers/other/loads/api/api/v4/loads/{loadId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Body

deliveryStopReferenceobject(StopReference)

Reference to a specific stop on a shipment.

descriptionstring

A description of the overall load.

handlingUnitsobject(LoadHandlingUnits)

A description of handling units for a load

idstring(uuid)

The unique project44-generated id of the load. This can be null when the load is created, but will always exist in the response after the load has been created.

identifiersArray of objects(LogisticsIdentifier)

The identifiers that can identify this Load. This could be, but not limited to, a shipment identifier such as a BOL or an order-based identifier such as Purchase Order or ASN.

involvedPartiesArray of objects(Party)

Parties which are specifically related to this load and the identifiers which are associated with those parties. This identifies the relationship between the load and its relevant parties.

itemsArray of objects(LoadItem)

A list of items contained within this load.

masterShipmentIdstring(uuid)

The project44-generated id of the shipment with which the load is associated.

pickupStopReferenceobject(StopReference)

Reference to a specific stop on a shipment.

Response

{
  "deliveryStopReference": {
    "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43"
  },
  "description": "string",
  "handlingUnits": {
    "details": [ … ]
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "identifiers": [
    { … }
  ],
  "involvedParties": [
    { … }
  ],
  "items": [
    { … }
  ],
  "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
  "pickupStopReference": {
    "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43"
  }
}

Update a load.

Request

Required Fields

loadId
masterShipmentId
identifiers: (at least one)

type
value

Path

loadIdstring(uuid)required

loadId

Bodyapplication/jsonrequired

load

deliveryStopReferenceobject(StopReference)

Reference to a specific stop on a shipment.

descriptionstring

A description of the overall load.

handlingUnitsobject(LoadHandlingUnits)

A description of handling units for a load

idstring(uuid)

The unique project44-generated id of the load. This can be null when the load is created, but will always exist in the response after the load has been created.

identifiersArray of objects(LogisticsIdentifier)

The identifiers that can identify this Load. This could be, but not limited to, a shipment identifier such as a BOL or an order-based identifier such as Purchase Order or ASN.

involvedPartiesArray of objects(Party)

Parties which are specifically related to this load and the identifiers which are associated with those parties. This identifies the relationship between the load and its relevant parties.

itemsArray of objects(LoadItem)

A list of items contained within this load.

masterShipmentIdstring(uuid)

The project44-generated id of the shipment with which the load is associated.

pickupStopReferenceobject(StopReference)

Reference to a specific stop on a shipment.

curl -i -X PUT \
  'https://developers.project44.com/_mock/guides/shippers/other/loads/api/api/v4/loads/{loadId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "deliveryStopReference": {
      "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43"
    },
    "description": "string",
    "handlingUnits": {
      "details": [
        {
          "cubicDimension": {
            "height": 0,
            "length": 0,
            "unit": "IN",
            "width": 0
          },
          "handlingUnitType": "BAG",
          "quantity": 0,
          "volume": {
            "unit": "CUBIC_FT",
            "value": 0
          },
          "weight": {
            "weight": 0,
            "weightUnit": "LB"
          }
        }
      ]
    },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "identifiers": [
      {
        "type": "AIR_WAYBILL",
        "value": "string"
      }
    ],
    "involvedParties": [
      {
        "partyIdentifiers": [
          {
            "type": "ACCOUNT",
            "value": "string"
          }
        ]
      }
    ],
    "items": [
      {
        "description": "string",
        "identifiers": [
          {
            "type": "STOCK_KEEPING_UNIT",
            "value": "string"
          }
        ],
        "orderIdentifierReferences": [
          {
            "orderId": "string",
            "orderIdentifier": "string",
            "orderIdentifierAuthority": "string",
            "orderType": "PURCHASE_ORDER"
          }
        ],
        "unitQuantity": 0,
        "unitType": "BAG"
      }
    ],
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "pickupStopReference": {
      "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43"
    }
  }'

Responses

Accepted

Body

Response

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

Delete a load.

Request

Required Fields

loadId

Path

loadIdstring(uuid)required

loadId

curl -i -X DELETE \
  'https://developers.project44.com/_mock/guides/shippers/other/loads/api/api/v4/loads/{loadId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Accepted

Body

Response

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

Get loads by masterShipmentId.

Request

Required Fields

masterShipmentId

Path

masterShipmentIdstring(uuid)required

The masterShipmentId of the shipment for which you wish to query the associated loads.

Query

pageinteger(int32)

Page number valid range: [1, 100]

Default 1

sizeinteger(int32)

Page size valid range: [1, 1000]

Default 100

curl -i -X GET \
  'https://developers.project44.com/_mock/guides/shippers/other/loads/api/api/v4/shipments/{masterShipmentId}/loads?page=1&size=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Body

paginationInfoobject(PaginationInfo)

Pagination information about a collection of resources.

resultsArray of objects(Load)

List of resources contained on this page.

Response

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

project44 REST API (4.0.0)

Manage Client Applications

Generate Tokens

Shipment Loads

Create a load.

Request

Required Fields

Responses

Was this section helpful?

Get a load by load id.

Request

Required Fields

Responses

Was this section helpful?

Update a load.

Request

Required Fields

Responses

Was this section helpful?

Delete a load.

Request

Required Fields

Responses

Was this section helpful?

Get loads by masterShipmentId.

Request

Required Fields

Responses

Was this section helpful?