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/visibility/ocean/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

Unified Shipment Tracking

Operations

Deprecated Ocean Tracking

Operations

Create a tracked ocean shipment from a container id or vessel id.

Request

Required Fields

  • equipmentIdentifier.type
  • equipmentIdentifier.value
  • carrierSCACCode
Body
required

oceanShipment

attributesArray of objects(OceanAttribute)

An optional user-defined set of custom attributes to associate with this shipment.

carrierSCACCodestring

The SCAC code identifying the carrier transporting the given container. This field is required.

equipmentIdentifierobject(OceanEquipmentIdentifier)
masterShipmentIdstring(uuid)

This id links 1 or more legs as part of the same overall shipment. For intermodal shipments, pass an existing masterShipmentId to link this ocean leg to the overall master shipment. Otherwise pass any valid new UUID to create a new shipment. If no masterShipmentId is passed on POST request a new UUID will be generated. This value will always be returned on all responses.

oceanLegIdstring(uuid)

The project44-generated id for the ocean shipment. This id may be used in subsequent API calls to reference a shipment.

shipmentIdstring(uuid)

DEPRECATED: The project44-generated id for tracking an intermodal shipment. This id may be used in subsequent API calls to reference a shipment. This field is deprecated, use masterShipmentId instead.

shipmentIdentifiersArray of objects(OceanShipmentIdentifier)

A list of optional identifiers to associate with this shipment.

curl -i -X POST \
  https://developers.project44.com/_mock/guides/shippers/visibility/ocean/api/api/v4/ocean/shipments \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "attributes": [
      {
        "name": "string",
        "value": "string",
        "values": [
          "string"
        ]
      }
    ],
    "carrierSCACCode": "string",
    "equipmentIdentifier": {
      "type": "CONTAINER_ID",
      "value": "string"
    },
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "oceanLegId": "fb86bc46-1c8b-49c4-b28c-fcebe681d76f",
    "shipmentId": "47efd5a2-af91-4417-950a-7f546cd1b5cf",
    "shipmentIdentifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "string"
      }
    ]
  }'

Responses

Created

Body
infoMessagesArray of objects(Message)

System messages and messages from the capacity provider.

shipmentobject(OceanShipment)
Response
{
  "infoMessages": [
    { … }
  ],
  "shipment": {
    "attributes": [ … ],
    "carrierSCACCode": "string",
    "equipmentIdentifier": { … },
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "oceanLegId": "fb86bc46-1c8b-49c4-b28c-fcebe681d76f",
    "shipmentId": "47efd5a2-af91-4417-950a-7f546cd1b5cf",
    "shipmentIdentifiers": [ … ]
  }
}

Delete shipment by project44 id.

Request

Required Fields

  • id
Path
idstring(uuid)required

The project44-generated shipmentId or oceanLegId associated with this shipment.

curl -i -X DELETE \
  'https://developers.project44.com/_mock/guides/shippers/visibility/ocean/api/api/v4/ocean/shipments/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

No Content

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

Get shipment statuses by project44 id.

Request

Required Fields

  • id
Path
idstring(uuid)required

The project44-generated shipmentId or oceanLegId associated with this shipment.

Query
includeCustomAttributesboolean

Determines whether the custom shipment attributes should be included in the response.

Default false
includeMapUrlboolean

If this value is set to true, the response payload will contain a public link to view the shipment in the VOC

Default false
includePositionDataboolean

Determines whether the history of the container's position over water should be included in the response.

Default false
curl -i -X GET \
  'https://developers.project44.com/_mock/guides/shippers/visibility/ocean/api/api/v4/ocean/shipments/{id}/statuses?includeCustomAttributes=false&includeMapUrl=false&includePositionData=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
infoMessagesArray of objects(Message)

System messages and messages from the capacity provider.

trackedShipmentobject(OceanTrackedShipment)
Response
{
  "infoMessages": [
    { … }
  ],
  "trackedShipment": {
    "attributes": [ … ],
    "carrierSCACCode": "string",
    "containerDetails": { … },
    "equipmentIdentifier": { … },
    "events": [ … ],
    "mapUrl": "string",
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "oceanLegId": "fb86bc46-1c8b-49c4-b28c-fcebe681d76f",
    "positions": [ … ],
    "shipmentId": "47efd5a2-af91-4417-950a-7f546cd1b5cf",
    "shipmentIdentifiers": [ … ],
    "states": [ … ],
    "stops": [ … ],
    "vessels": [ … ]
  }
}

Webhook

Operations