Create a Shipment

Use the workflows below to create a Less than Truckload (LTL) shipment to add the shipment to project44's network and send tracking information about the shipment.

Create an LTL Shipment

Create an LTL shipment to be tracked in project44's network. This step is necessary before tracking of an LTL shipment can start.

Requirements

Have the following information:

Shipment Identifiers. This includes
- One PRO, BILL_OF_LADING, CUSTOMER_REFERENCE, PICKUP, PURCHASE_ORDER, or EXTERNAL
- AND one CAPACITY_PROVIDER_ACCOUNT_CODE
- (Optional) one CAPACITY_PROVIDER_ACCOUNT_GROUP
Origin and Destination Stop Information

Workflow

Complete these steps:

Prepare a POST request to /api/v4/shipments/tracking.
Add the required information to the request schema. For example,

{
  "identifiers": [
    {
      "type": "BILL_OF_LADING",
      "value": "string"
    },
    {
      "type": "CAPACITY_PROVIDER_ACCOUNT_CODE",
      "value": "string"
    }
  ],
  "routeInfo": {
    "stops": [
      {
        "id": "string",
        "type": "ORIGIN",
        "location": {}
      },
      {
        "id": "string",
        "type": "DESTINATION",
        "location": {}
      }
    ]
  }
}

This an example of a potential request. For the full request schema and descriptions for all fields and objects, please see our API Reference Documentation.

Send the request.

Fields and Objects

Element	Description	Type	Notes
`identifiers`	A list of the shipment's identifying information.	`array` of identifiers
`identifiers.type`	The type of shipment identifier.	`string`	Valid values include one `PRO`, `BILL_OF_LADING`, `CUSTOMER_REFERENCE`, `PICKUP`, `PURCHASE_ORDER`, or `EXTERNAL` AND one `CAPACITY_PROVIDER_ACCOUNT_CODE`. `CAPACITY_PROVIDER_ACCOUNT_GROUP` is an optional identifier.
`identifiers.value`	The value of the shipment identifier.	`string`
`routeInfo.stop`	An array of stop information.	`array` of `strings` and/or `integers`	Include stop information for the Origian and Destination. For more information on fields within this array, see the API Reference Documentation.

Expected System Response

You have successfully submitted the request when you receive a 200 OK response. Here is a sample of the minimum response schema:

{
  "id": "string",
  "identifiers": [
    {
      "type": "BILL_OF_LADING",
      "value": "string"
    },
    {
      "type": "CAPACITY_PROVIDER_ACCOUNT_CODE",
      "value": "string"
    }
  ],
  "routeInfo": {
    "stops": [
      {
        "id": "string",
        "type": "ORIGIN",
        "location": {}
      },
      {
        "id": "string",
        "type": "DESTINATION",
        "location": {}
      }
    ]
  }
}

This is an example of what could be returned in the response. Null fields will not show up in the response. Please refer to the API Reference Documentation for more information on required and potential null fields.

A unique project44 ID (id) is returned in the response after shipment creation. Store this Shipment ID to use in future API calls.

Fields and Objects

Element	Description	Type	Notes
`id`	The shipment's master shipment ID.	`string`	The `id` will always be populated in the `POST` response.
`identifiers`	A list of the shipment's identifying information.	`array` of identifiers
`identifiers.type`	The type of shipment identifier.	`string`	Valid values include one `PRO`, `BILL_OF_LADING`, `CUSTOMER_REFERENCE`, `PICKUP`, `PURCHASE_ORDER`, or `EXTERNAL` AND one `CAPACITY_PROVIDER_ACCOUNT_CODE`. `CAPACITY_PROVIDER_ACCOUNT_GROUP` is an optional identifier.
`identifiers.value`	The value of the shipment identifier.	`string`
`routeInfo.stop`	An array of stop information.	`array` of `strings` and/or `integers`	Include stop information for the Origian and Destination. For more information on fields within this array, see the API Reference Documentation.

Errors

If there was a problem with your request, you will receive one of the following error codes:

400 Invalid request
401 Invalid or missing credentials
403 User not authorized to perform this operation

See Error Response Codes in the Appendix for more information on the meaning of these error codes.