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. If you're not familiar with project44, we recommend checking out our guides first: https://developers.project44.com/guides/shippers and https://developers.project44.com/guides/carriers.

Download OpenAPI description
api-docs.json
api-docs.yaml
Overview
License © 2024 project44 - Terms of Use
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 Movement 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

Shipment: Tracking

...

Operations

Shipment Search

...

Operations

Filter Suggestions

...

Operations

Shipment Attributes

...

Operations

Shipment: Loads

...

Operations

Order Visibility

...

Operations

LTL: Quotes

...

Operations

LTL: Dispatch

...

Operations

LTL: Image Retrieval

...

Operations

LTL: Electronic BOL

API used for creating Electronic BOL

Operations

VLTL: Quotes

...

Operations

VLTL: Dispatch

...

Operations

TL: Available Vehicles

...

Operations

TL: Connected Capacity

...

Operations

Asset Tracking

...

Operations

Multi-Modal: Image Retrieval

...

Operations

Multi-Modal: Rating

API used for multi-modal Rating.

Operations

Multi-Modal: Booking

API used for multi-modal Booking.

Operations

Multi-Modal: Packaging

API used for managing packages for shipment planning.

Operations

Multi-Modal: Document

...

Operations

Webhook

...

Operations

Shipment Webhook Data

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

Operations

Inventory Order and Load Webhook Data

Operations to describe the payload expected from project44 when integrated with a webhook for orders and loads.

Operations

Capacity Provider Metadata

...

Operations

Capacity Provider Contact Management

...

Operations

Capacity Provider Account Management

...

Operations

Capacity Provider Account Group Management

...

Operations

LTL: Push Tracking

...

Operations

LTL: Push Imaging

...

Operations

TL: Capacity Provider Push

...

Operations

Parcel: Push Tracking

...

Operations

Universal Push: Truckload

...

Operations

Push Updates

...

Operations

Analytics: Port Intelligence

...

Operations

Stop Location Management

...

Operations

Postal Address Validation

...

Operations

Appointments

Create, reschedule, cancel, fetch appointments in Yard Management Systems(YMS)

Operations

Capacity

Get capacity for a YMS site within the specified time range

Operations

Milestones

Update yard milestones for a shipment

Operations

Reason Codes

Retrieve all reason codes for the specified YMS site

Operations

Site Codes

Retrieve all sites for the specified YMS tenant

Operations

Slots

Get available slots for a shipment in Yard Management Systems(YMS)

Operations

Invitations

...

Operations

Ocean: Point-to-Point Schedules

...

Operations

LTL: Tracking

...

Operations

Query the status of a shipment.

Request

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
Body
required
apiConfigurationobject(ShipmentStatusApiConfiguration)

Contains fields used to configure the shipment status API.

capacityProviderAccountGroupobject(CapacityProviderAccountGroup)

The requested capacity provider account group containing the account used for authentication with the capacity provider's API.

destinationAddressobject(Address)

A postal address.

originAddressobject(Address)

A postal address.

pickupDatestring(date)

The pickup date in the timezone of the origin location of the shipment being looked up. Required when providing a shipment identifier of any type other than 'PRO'. Necessary for some capacity providers to authorize shipment status access or look up shipment status. (format: yyyy-MM-dd)

shipmentIdentifiersArray of objects(ShipmentIdentifier)non-empty

List of shipment identifiers used to look up shipments. Only one identifier of each type may be provided.

curl -i -X POST \
  'https://na12.api.project44.com/api/v2/statuses/query?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "apiConfiguration": {
      "fallBackToDefaultAccountGroup": true
    },
    "capacityProviderAccountGroup": {
      "accounts": [
        {
          "code": "string"
        }
      ],
      "code": "string"
    },
    "destinationAddress": {
      "addressLines": [
        "string"
      ],
      "city": "string",
      "country": "US",
      "postalCode": "string",
      "state": "string"
    },
    "originAddress": {
      "addressLines": [
        "string"
      ],
      "city": "string",
      "country": "US",
      "postalCode": "string",
      "state": "string"
    },
    "pickupDate": "2019-08-24",
    "shipmentIdentifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "string"
      }
    ]
  }'

Responses

OK

Body
actualDeliveryDateTimestring(date-time)

The actual delivery date and time in the timezone of the destination location of the shipment, if provided. (format: yyyy-MM-dd'T'HH:mm:ss)

currentStatusobject(ShipmentStatusUpdate)

A single shipment status update provided by the capacity provider.

destinationTerminalobject(Terminal)

A carrier terminal.

destinationLocationobject(Location)

A physical location.

estimatedDeliveryDateTimestring(date-time)

The estimated delivery date and time in the timezone of the destination location of the shipment, if provided. (format: yyyy-MM-dd'T'HH:mm:ss)

imagesArray of objects(ShipmentStatusImage)

A list of images of documents related to the shipment.

infoMessagesArray of objects(Message)

System messages and messages from the capacity provider with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.

originLocationobject(Location)

A physical location.

originTerminalobject(Terminal)

A carrier terminal.

pickupDateTimestring(date-time)

The pickup date and time in the timezone of the origin location of the shipment, if provided. (format: yyyy-MM-dd'T'HH:mm:ss)

retrievalDateTimestring(date-time)

The date and time project44 retrieved this shipment status update from the capacity provider in UTC. Project44 stores shipment statuses and does not always retrieve status information directly from the capacity provider (e.g., if the status was retrieved just a few minutes prior). (format: yyyy-MM-dd'T'HH:mm:ss)

shipmentIdentifiersArray of objects(ShipmentIdentifier)

A list of identifiers for the shipment. If the shipment status was successfully retrieved, the shipment's PRO number will always appear here.

statusUpdateHistoryArray of objects(ShipmentStatusUpdate)

A list of shipment status updates that have been retrieved by project44. Some capacity providers always provide a full history of shipment status updates, while others provide only the curent status with each retrieval. For the former category of capacity providers, this list will be comprehensive. For the latter category of capacity providers, this list can contain only the statuses project44 retrieved during the lifetime of this shipment's status retrieval.

Response
{
  "actualDeliveryDateTime": "2019-08-24T14:15:22Z",
  "currentStatus": {
    "code": "AT_PICKUP",
    "description": "string",
    "retrievalDateTime": "2019-08-24T14:15:22Z",
    "timestamp": "2019-08-24T14:15:22Z",
    "terminal": { … }
  },
  "destinationTerminal": {
    "carrierCode": "string",
    "terminalCode": "string",
    "terminalName": "string",
    "terminalLocation": { … }
  },
  "destinationLocation": {
    "address": { … },
    "contact": { … }
  },
  "estimatedDeliveryDateTime": "2019-08-24T14:15:22Z",
  "images": [
    { … }
  ],
  "infoMessages": [
    { … }
  ],
  "originLocation": {
    "address": { … },
    "contact": { … }
  },
  "originTerminal": {
    "carrierCode": "string",
    "terminalCode": "string",
    "terminalName": "string",
    "terminalLocation": { … }
  },
  "pickupDateTime": "2019-08-24T14:15:22Z",
  "retrievalDateTime": "2019-08-24T14:15:22Z",
  "shipmentIdentifiers": [
    { … }
  ],
  "statusUpdateHistory": [
    { … }
  ]
}

Query the status of a shipment.

Request

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
Body
required
apiConfigurationobject(ShipmentStatusApiConfiguration)

Contains fields used to configure the shipment status API.

capacityProviderAccountGroupobject(CapacityProviderAccountGroup)

The requested capacity provider account group containing the account used for authentication with the capacity provider's API.

destinationAddressobject(Address)

A postal address.

originAddressobject(Address)

A postal address.

pickupDatestring(date)

The pickup date in the timezone of the origin location of the shipment being looked up. Required when providing a shipment identifier of any type other than 'PRO'. Necessary for some capacity providers to authorize shipment status access or look up shipment status. (format: yyyy-MM-dd)

shipmentIdentifiersArray of objects(ShipmentIdentifier)non-empty

List of shipment identifiers used to look up shipments. Only one identifier of each type may be provided.

curl -i -X POST \
  'https://na12.api.project44.com/api/v3/statuses/query?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "apiConfiguration": {
      "fallBackToDefaultAccountGroup": true
    },
    "capacityProviderAccountGroup": {
      "accounts": [
        {
          "code": "string"
        }
      ],
      "code": "string"
    },
    "destinationAddress": {
      "addressLines": [
        "string"
      ],
      "city": "string",
      "country": "US",
      "postalCode": "string",
      "state": "string"
    },
    "originAddress": {
      "addressLines": [
        "string"
      ],
      "city": "string",
      "country": "US",
      "postalCode": "string",
      "state": "string"
    },
    "pickupDate": "2019-08-24",
    "shipmentIdentifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "string"
      }
    ]
  }'

Responses

OK

Body
actualDeliveryDateTimestring(date-time)

The actual delivery date and time in the timezone of the destination location of the shipment, if provided. (format: yyyy-MM-dd'T'HH:mm:ss)

currentStatusobject(ShipmentStatusUpdate)

A single shipment status update provided by the capacity provider.

destinationTerminalobject(Terminal)

A carrier terminal.

destinationLocationobject(Location)

A physical location.

estimatedDeliveryDateTimestring(date-time)

The estimated delivery date and time in the timezone of the destination location of the shipment, if provided. (format: yyyy-MM-dd'T'HH:mm:ss)

imagesArray of objects(ShipmentStatusImage)

A list of images of documents related to the shipment.

infoMessagesArray of objects(Message)

System messages and messages from the capacity provider with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.

originLocationobject(Location)

A physical location.

originTerminalobject(Terminal)

A carrier terminal.

pickupDateTimestring(date-time)

The pickup date and time in the timezone of the origin location of the shipment, if provided. (format: yyyy-MM-dd'T'HH:mm:ss)

retrievalDateTimestring(date-time)

The date and time project44 retrieved this shipment status update from the capacity provider in UTC. Project44 stores shipment statuses and does not always retrieve status information directly from the capacity provider (e.g., if the status was retrieved just a few minutes prior). (format: yyyy-MM-dd'T'HH:mm:ss)

shipmentIdentifiersArray of objects(ShipmentIdentifier)

A list of identifiers for the shipment. If the shipment status was successfully retrieved, the shipment's PRO number will always appear here.

statusUpdateHistoryArray of objects(ShipmentStatusUpdate)

A list of shipment status updates that have been retrieved by project44. Some capacity providers always provide a full history of shipment status updates, while others provide only the curent status with each retrieval. For the former category of capacity providers, this list will be comprehensive. For the latter category of capacity providers, this list can contain only the statuses project44 retrieved during the lifetime of this shipment's status retrieval.

Response
{
  "actualDeliveryDateTime": "2019-08-24T14:15:22Z",
  "currentStatus": {
    "code": "AT_PICKUP",
    "description": "string",
    "retrievalDateTime": "2019-08-24T14:15:22Z",
    "timestamp": "2019-08-24T14:15:22Z",
    "terminal": { … }
  },
  "destinationTerminal": {
    "carrierCode": "string",
    "terminalCode": "string",
    "terminalName": "string",
    "terminalLocation": { … }
  },
  "destinationLocation": {
    "address": { … },
    "contact": { … }
  },
  "estimatedDeliveryDateTime": "2019-08-24T14:15:22Z",
  "images": [
    { … }
  ],
  "infoMessages": [
    { … }
  ],
  "originLocation": {
    "address": { … },
    "contact": { … }
  },
  "originTerminal": {
    "carrierCode": "string",
    "terminalCode": "string",
    "terminalName": "string",
    "terminalLocation": { … }
  },
  "pickupDateTime": "2019-08-24T14:15:22Z",
  "retrievalDateTime": "2019-08-24T14:15:22Z",
  "shipmentIdentifiers": [
    { … }
  ],
  "statusUpdateHistory": [
    { … }
  ]
}

Start tracking an LTL shipment

Request

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
Body
required
apiConfigurationobject(LtlTrackedShipmentApiConfiguration)

${LtlTrackedShipment.apiModel.apiConfiguration.value}

capacityProviderAccountGroupobject(CapacityProviderAccountGroup)

The requested capacity provider account group containing the account used for authentication with the capacity provider's API.

idinteger(int64)

${LtlTrackedShipment.apiModel.id.value}

shipmentIdentifiersArray of objects(LtlShipmentIdentifier)[ 1 .. 250 ] items

${LtlTrackedShipment.apiModel.shipmentIdentifiers.value}

shipmentStopsArray of objects(LtlTrackedShipmentStop)

${LtlTrackedShipment.apiModel.shipmentStops.value}

curl -i -X POST \
  'https://na12.api.project44.com/api/v4/ltl/trackedshipments?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "apiConfiguration": {
      "fallBackToDefaultAccountGroup": true
    },
    "capacityProviderAccountGroup": {
      "accounts": [
        {
          "code": "string"
        }
      ],
      "code": "string"
    },
    "id": 0,
    "shipmentIdentifiers": [
      {
        "primaryForType": true,
        "source": "CUSTOMER",
        "type": "PRO",
        "value": "string"
      }
    ],
    "shipmentStops": [
      {
        "appointmentWindow": {
          "endDateTime": "2019-08-24T14:15:22Z",
          "localTimeZoneIdentifier": "string",
          "startDateTime": "2019-08-24T14:15:22Z"
        },
        "additionalAppointmentWindows": [
          {
            "appointmentWindow": {
              "endDateTime": "2019-08-24T14:15:22Z",
              "localTimeZoneIdentifier": "string",
              "startDateTime": "2019-08-24T14:15:22Z"
            },
            "appointmentStatus": "PENDING",
            "identifiers": [
              {
                "type": "DOCK",
                "value": "string"
              }
            ],
            "type": "STRATEGIC"
          }
        ],
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "id": 0,
        "involvedParties": [
          {
            "addressInfo": {
              "addressLines": [
                "string"
              ],
              "addressLabel": "string",
              "city": "string",
              "country": "US",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "postalCode": "string",
              "state": "string"
            },
            "contactInfo": {
              "companyName": "string",
              "email": "user@example.com",
              "familyName": "string",
              "givenName": "string",
              "mobilePhoneNumber": "string",
              "phoneNumber": "string"
            },
            "identifyingCodes": {
              "codeListProvider": "WAVE",
              "codeListName": "DID",
              "partyCode": "string"
            },
            "locationIdentifiers": [
              {
                "type": "EXTERNAL",
                "value": "string"
              }
            ],
            "partyType": "SHIPPER",
            "vatNumber": "string"
          }
        ],
        "location": {
          "address": {
            "addressLines": [
              "string"
            ],
            "city": "string",
            "country": "US",
            "postalCode": "string",
            "state": "string"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "stopType": "ORIGIN",
        "stopDescription": "string",
        "stopName": "string",
        "stopNumber": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
      }
    ]
  }'

Responses

Created

Body
infoMessagesArray of objects(Message)

${LtlTrackedShipmentConfirmation.apiModel.infoMessages.value}

shipmentobject(LtlTrackedShipment)
Response
{
  "infoMessages": [
    { … }
  ],
  "shipment": {
    "apiConfiguration": { … },
    "capacityProviderAccountGroup": { … },
    "id": 0,
    "shipmentIdentifiers": [ … ],
    "shipmentStops": [ … ]
  }
}

Updates an LTL shipment

Request

Path
idinteger(int64)required

The project44-generated id of the LTL tracked shipment you wish to update.

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
Bodyapplication/jsonrequired
apiConfigurationobject(LtlTrackedShipmentApiConfiguration)

${LtlTrackedShipment.apiModel.apiConfiguration.value}

capacityProviderAccountGroupobject(CapacityProviderAccountGroup)

The requested capacity provider account group containing the account used for authentication with the capacity provider's API.

idinteger(int64)

${LtlTrackedShipment.apiModel.id.value}

shipmentIdentifiersArray of objects(LtlShipmentIdentifier)[ 1 .. 250 ] items

${LtlTrackedShipment.apiModel.shipmentIdentifiers.value}

shipmentStopsArray of objects(LtlTrackedShipmentStop)

${LtlTrackedShipment.apiModel.shipmentStops.value}

curl -i -X PUT \
  'https://na12.api.project44.com/api/v4/ltl/trackedshipments/{id}?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "apiConfiguration": {
      "fallBackToDefaultAccountGroup": true
    },
    "capacityProviderAccountGroup": {
      "accounts": [
        {
          "code": "string"
        }
      ],
      "code": "string"
    },
    "id": 0,
    "shipmentIdentifiers": [
      {
        "primaryForType": true,
        "source": "CUSTOMER",
        "type": "PRO",
        "value": "string"
      }
    ],
    "shipmentStops": [
      {
        "appointmentWindow": {
          "endDateTime": "2019-08-24T14:15:22Z",
          "localTimeZoneIdentifier": "string",
          "startDateTime": "2019-08-24T14:15:22Z"
        },
        "additionalAppointmentWindows": [
          {
            "appointmentWindow": {
              "endDateTime": "2019-08-24T14:15:22Z",
              "localTimeZoneIdentifier": "string",
              "startDateTime": "2019-08-24T14:15:22Z"
            },
            "appointmentStatus": "PENDING",
            "identifiers": [
              {
                "type": "DOCK",
                "value": "string"
              }
            ],
            "type": "STRATEGIC"
          }
        ],
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "id": 0,
        "involvedParties": [
          {
            "addressInfo": {
              "addressLines": [
                "string"
              ],
              "addressLabel": "string",
              "city": "string",
              "country": "US",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "postalCode": "string",
              "state": "string"
            },
            "contactInfo": {
              "companyName": "string",
              "email": "user@example.com",
              "familyName": "string",
              "givenName": "string",
              "mobilePhoneNumber": "string",
              "phoneNumber": "string"
            },
            "identifyingCodes": {
              "codeListProvider": "WAVE",
              "codeListName": "DID",
              "partyCode": "string"
            },
            "locationIdentifiers": [
              {
                "type": "EXTERNAL",
                "value": "string"
              }
            ],
            "partyType": "SHIPPER",
            "vatNumber": "string"
          }
        ],
        "location": {
          "address": {
            "addressLines": [
              "string"
            ],
            "city": "string",
            "country": "US",
            "postalCode": "string",
            "state": "string"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "stopType": "ORIGIN",
        "stopDescription": "string",
        "stopName": "string",
        "stopNumber": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
      }
    ]
  }'

Responses

OK

Body
infoMessagesArray of objects(Message)

${LtlTrackedShipmentConfirmation.apiModel.infoMessages.value}

shipmentobject(LtlTrackedShipment)
Response
{
  "infoMessages": [
    { … }
  ],
  "shipment": {
    "apiConfiguration": { … },
    "capacityProviderAccountGroup": { … },
    "id": 0,
    "shipmentIdentifiers": [ … ],
    "shipmentStops": [ … ]
  }
}

Delete shipment by ID.

Request

Path
idinteger(int64)required

The project44-generated id of the LTL tracked shipment you wish to be deleted.

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
curl -i -X DELETE \
  'https://na12.api.project44.com/api/v4/ltl/trackedshipments/{id}?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

No Content

Returns the status of an LTL shipment by unique system ID

Request

Path
idinteger(int64)required

The project44-generated id of the tracked or dispatched LTL shipment you wish to query.

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
includeStatusHistoryboolean

Set to "TRUE" if you wish to receive the shipment status history ('statusUpdates') in the response.

Default false
includeMapUrlboolean

Set to "TRUE" if you wish to receive a publicly accessible URL to the shipment details in the response.

Default false
curl -i -X GET \
  'https://na12.api.project44.com/api/v4/ltl/trackedshipments/{id}/statuses?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&includeMapUrl=false&includeStatusHistory=false&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
imageReferencesArray of objects(LtlTrackedShipmentImageReference)

${LtlShipmentStatus.apiModel.imageReferences.value}

infoMessagesArray of objects(Message)

${LtlShipmentStatus.apiModel.infoMessages.value}

latestStatusUpdateobject(LtlShipmentStatusUpdate)

${LtlShipmentStatus.apiModel.statusUpdates.value}

latestStopStatusesArray of objects(LtlShipmentStopStatus)

${LtlShipmentStatus.apiModel.latestStopStatuses.value}

mapUrlstring

${LtlShipmentStatus.apiModel.mapUrl.value}

shipmentobject(LtlTrackedShipment)
statusUpdatesArray of objects(LtlShipmentStatusUpdate)

${LtlShipmentStatus.apiModel.statusUpdates.value}

Response
{
  "imageReferences": [
    { … }
  ],
  "infoMessages": [
    { … }
  ],
  "latestStatusUpdate": {
    "address": { … },
    "exceptionSummaryCode": "APPOINTMENT_ISSUE",
    "exceptionDetailCode": "APPOINTMENT_SET",
    "retrievalDateTime": "2019-08-24T14:15:22Z",
    "statusCode": "IN_TRANSIT",
    "statusReason": { … },
    "stopId": 0,
    "stopType": "ORIGIN",
    "stopNumber": 0,
    "timestamp": { … }
  },
  "latestStopStatuses": [
    { … }
  ],
  "mapUrl": "string",
  "shipment": {
    "apiConfiguration": { … },
    "capacityProviderAccountGroup": { … },
    "id": 0,
    "shipmentIdentifiers": [ … ],
    "shipmentStops": [ … ]
  },
  "statusUpdates": [
    { … }
  ]
}

Returns the status of an LTL shipment by identifier.

Request

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
shipmentIdentifier.typestring(enum)(LtlShipmentIdentifierType)required

The type of identifier for which to search.

Enum"PRO""BILL_OF_LADING""CUSTOMER_REFERENCE""PICKUP""PURCHASE_ORDER""EXTERNAL"
shipmentIdentifier.valuestringrequired

The identifier value for which to search.

shipmentIdentifier.sourcestring(enum)(LtlShipmentIdentifierSource)

The source system that created the identifier.

Enum"CUSTOMER""CAPACITY_PROVIDER"
includeStatusHistoryboolean

Set to "TRUE" if you wish to receive the shipment status history ('statusUpdates') in the response.

Default false
curl -i -X GET \
  'https://na12.api.project44.com/api/v4/ltl/trackedshipments/statuses?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&includeStatusHistory=false&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&shipmentIdentifier.source=CUSTOMER&shipmentIdentifier.type=PRO&shipmentIdentifier.value=string&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
infoMessagesArray of objects(Message)

${LtlShipmentStatusCollection.apiModel.infoMessages.value}

shipmentStatusesArray of objects(LtlShipmentStatus)

${LtlShipmentStatusCollection.apiModel.shipmentStatuses.value}

Response
{
  "infoMessages": [
    { … }
  ],
  "shipmentStatuses": [
    { … }
  ]
}

TL: Tracking

...

Operations

TL: Webhook

...

Operations

Parcel: Tracking

...

Operations

Parcel: Webhook

...

Operations

Rail: Tracking

...

Operations

Ocean: Tracking

...

Operations