Last updated

Get Booking Information

Get either a single or a paginated selection of filtered bookings.

Get an Ocean Booking

Fetch a single Ocean booking.

Requirements

At a minimum, have the following information

  • Booking ID

Workflow

Complete these steps:

  1. Prepare a GET request to /services/booking/v1/shipments/{shipmentId}. Please, connect with your project44 Technical Contact for the Booking API Reference Documentation.
  2. Enter the Booking ID.
  3. Send the request.

Expected System Responses

The request is successfully submitted and confirmed when a 200 response is received.

JSON
{
  "identifiers": [
    {
      "type": "AIR_WAYBILL",
      "value": "string"
    }
  ],
  "routeInfo": {
    "stops": [
      {
        "id": "257296aa-4e11-4168-b6a7-981b8b94815b",
        "type": "PICKUP",
        "arrivalAppointmentWindow": {
          "startTime": "10:15:22",
          "endTime": "11:15:22"
        },
        "contacts": [
          {
            "companyName": "string"
          }
        ],
        "location": {
          "identifiers": [
            {
              "type": "string",
              "value": "string"
            }
          ],
          "address": {
            "addressLines": [
              "string"
            ]
          },
          "geoCoordinates": {
            "latitude": -90,
            "longitude": -180
          }
        }
      },
      {
        "id": "5f1765b9-dde0-424e-963b-bb3b4e1d1d56",
        "type": "DELIVERY",
        "arrivalAppointmentWindow": {
          "startTime": "14:15:22",
          "endTime": "15:15:22"
        },
        "contacts": [
          {
            "companyName": "string"
          }
        ],
        "location": {
          "identifiers": [
            {
              "type": "string",
              "value": "string"
            }
          ],
          "address": {
            "addressLines": [
              "string"
            ]
          },
          "geoCoordinates": {
            "latitude": -90,
            "longitude": -180
          }
        }
      }
    ],
    "routeSegments": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "fromStopId": "257296aa-4e11-4168-b6a7-981b8b94815b",
        "toStopId": "5f1765b9-dde0-424e-963b-bb3b4e1d1d56"
      }
    ]
  },
  "bookings": [
    {
      "shipmentId": "47efd5a2-af91-4417-950a-7f546cd1b5cf",
      "capacityProviderIdentifier": {
        "type": "SCAC",
        "value": "string"
      },
      "carrierContacts": [
        {
          "companyName": "string"
        }
      ],
      "totalRate": {
        "currency": "USD",
        "amount": 0
      },
      "rateIdentifiers": [
        {
          "source": "SYSTEM",
          "type": "SPOT_QUOTE"
        }
      ],
      "expirationDateTime": "2019-08-24T14:15:22",
      "routeSegmentIds": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "shipmentDetails": [
        {
          "pickupStopId": "257296aa-4e11-4168-b6a7-981b8b94815b",
          "deliveryStopId": "5f1765b9-dde0-424e-963b-bb3b4e1d1d56",
          "items": [
            {
              "description": "string",
              "unitQuantity": 0,
              "unitType": "BAG"
            }
          ],
          "identifiers": [
            {
              "type": "BILL_OF_LADING",
              "value": "string"
            }
          ],
          "loadId": "9fa4c9ea-0db7-4bb2-8f50-086d18a90403"
        }
      ],
      "shipperContactInfo": {
        "companyName": "string"
      },
      "shippingDetails": {
        "loadPreference": "FULL",
        "trailerType": "FLATBED",
        "trailerLength": {
          "value": 0,
          "unit": "FT"
        },
        "trailerVolume": {
          "value": 0,
          "unit": "CUBIC_FT"
        },
        "flatbedType": "CONESTOGA"
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "BOOKED",
      "shipmentIdentifiers": [
        {
          "type": "BILL_OF_LADING",
          "value": "string"
        }
      ],
      "routeSegments": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "fromStop": {
            "id": "257296aa-4e11-4168-b6a7-981b8b94815b",
            "type": "PICKUP",
            "arrivalAppointmentWindow": {
              "startTime": "10:15:22",
              "endTime": "11:15:22"
            }
          },
          "toStop": {
            "id": "5f1765b9-dde0-424e-963b-bb3b4e1d1d56",
            "type": "DELIVERY",
            "arrivalAppointmentWindow": {
              "startTime": "14:15:22",
              "endTime": "15:15:22"
            }
          }
        }
      ],
      "carrierResponseMethod": "EMAIL",
      "bookingSourceMethod": "API",
      "transportationMode": "TRUCKLOAD",
      "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
      "carrierProvidedIdentifiers": [
        {
          "type": "string",
          "value": "string"
        }
      ]
    }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

This is an example of what could be returned in the response. Please, refer to the Booking API Reference Documentation from your project44 Technical Contact for more information on the fields and data that can be returned in this response.

Errors

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

  • 400 Bad Request
  • 404 Not Found

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

Fields and Objects

The table below describes only the minimum relevant fields of the API Request to get an Ocean booking. For more information on all fields, please, connect with your project44 Technical Contact for the Booking API Reference Documentation.

FieldDescription
bookingIdThe project44-generated shipment identifier (id).

Get a Batch of Ocean Bookings

Fetch a paginated batch selection of filtered bookings.

Requirements

At a minimum, have at least one of the following pieces of information to filter shipments by

  • Attribute Name
  • Attribute Value
  • Booking Status

In addition, include pagination information

  • Page number
  • Page size

Workflow

Complete these steps:

  1. Prepare a GET request to /services/booking/v1/bookings. Please, connect with your project44 Technical Contact for the Booking API Reference Documentation.
  2. Enter all required information.
  3. Send the request.

Expected System Responses

The request is successfully submitted and confirmed when a 200 response is received.

JSON
{
  "paginationInfo": {
    "pageSize": 0,
    "pageNumber": 0,
    "total": 0
  },
  "results": [
    {
      "shipmentId": "47efd5a2-af91-4417-950a-7f546cd1b5cf",
      "attributes": [
        {
          "name": "string",
          "values": [
            "string"
          ]
        }
      ],
      "capacityProviderIdentifier": {
        "type": "SCAC",
        "value": "string"
      },
      "carrierContacts": [
        {
          "companyName": "string",
          "givenName": "string",
          "familyName": "string",
          "phoneNumber": "string",
          "mobilePhoneNumber": "string",
          "email": "user@example.com"
        }
      ],
      "totalRate": {
        "currency": "USD",
        "amount": 0
      },
      "rateIdentifiers": [
        {
          "source": "SYSTEM",
          "type": "SPOT_QUOTE",
          "value": "string"
        }
      ],
      "expirationDateTime": "2019-08-24T14:15:22Z",
      "routeSegmentIds": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "notes": "string",
      "shipmentDetails": [
        {
          "pickupStopId": "eff50f2a-8964-41f9-b45d-0a4f6f94e159",
          "deliveryStopId": "2ca57692-0523-4424-a638-167e5e26f7d3",
          "handlingUnits": {
            "details": [
              {
                "monetaryValue": null,
                "quantity": null,
                "handlingUnitType": null,
                "stackable": null,
                "dimensions": null,
                "weight": null
              }
            ]
          },
          "items": [
            {
              "description": "string",
              "identifiers": [
                null
              ],
              "unitQuantity": 0,
              "unitType": "BAG"
            }
          ],
          "description": "string",
          "identifiers": [
            {
              "type": "AIR_WAYBILL",
              "value": "string"
            }
          ],
          "accessorials": [
            {
              "code": "REFRIGERATED",
              "details": {
                "min": null,
                "max": null,
                "unit": null
              }
            }
          ],
          "loadId": "9fa4c9ea-0db7-4bb2-8f50-086d18a90403"
        }
      ],
      "apiConfiguration": {
        "bookingWebhookName": "string"
      },
      "shipperContactInfo": {
        "companyName": "string",
        "givenName": "string",
        "familyName": "string",
        "phoneNumber": "string",
        "mobilePhoneNumber": "string",
        "email": "user@example.com"
      },
      "shippingDetails": {
        "loadPreference": "FULL",
        "trailerType": "FLATBED",
        "trailerLength": {
          "value": 0,
          "unit": "FT"
        },
        "trailerVolume": {
          "value": 0,
          "unit": "CUBIC_FT"
        },
        "flatbedType": "CONESTOGA",
        "accessorials": [
          {
            "code": "REFRIGERATED",
            "details": {
              "min": 0,
              "max": 0,
              "unit": "CELSIUS"
            }
          }
        ]
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "PROCESSING",
      "shipmentIdentifiers": [
        {
          "type": "AIR_WAYBILL",
          "value": "string"
        }
      ],
      "routeSegments": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "fromStop": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "type": "PICKUP",
            "arrivalDate": "2019-08-24",
            "arrivalAppointmentWindow": {
              "startTime": "14:15:22Z",
              "endTime": "14:15:22Z"
            },
            "contacts": [
              {
                "companyName": null,
                "givenName": null,
                "familyName": null,
                "phoneNumber": null,
                "mobilePhoneNumber": null,
                "email": null
              }
            ],
            "accessorials": [
              {
                "code": null,
                "details": null
              }
            ],
            "location": {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "name": "string",
              "identifiers": [
                null
              ],
              "address": {
                "addressLines": [],
                "postalCode": null,
                "city": null,
                "state": null,
                "country": null
              },
              "geoCoordinates": {
                "latitude": null,
                "longitude": null
              }
            }
          },
          "toStop": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "type": "PICKUP",
            "arrivalDate": "2019-08-24",
            "arrivalAppointmentWindow": {
              "startTime": "14:15:22Z",
              "endTime": "14:15:22Z"
            },
            "contacts": [
              {
                "companyName": null,
                "givenName": null,
                "familyName": null,
                "phoneNumber": null,
                "mobilePhoneNumber": null,
                "email": null
              }
            ],
            "accessorials": [
              {
                "code": null,
                "details": null
              }
            ],
            "location": {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "name": "string",
              "identifiers": [
                null
              ],
              "address": {
                "addressLines": [],
                "postalCode": null,
                "city": null,
                "state": null,
                "country": null
              },
              "geoCoordinates": {
                "latitude": null,
                "longitude": null
              }
            }
          }
        }
      ],
      "rejectionReason": "COST_NOT_AGREED",
      "carrierResponseMethod": "EMAIL",
      "automatedFailureReason": "ERROR_CREDENTIALS",
      "bookingSourceMethod": "API",
      "carrierRejectionNotes": "string",
      "transportationMode": "OCEAN",
      "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
      "carrierProvidedIdentifiers": [
        {
          "type": "AIR_WAYBILL",
          "value": "string"
        }
      ]
    }
  ]
}

This is an example of what could be returned in the response. Please, refer to the Booking API Reference Documentation from your project44 Technical Contact for more information on the fields and data that can be returned in this response.

Errors

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

  • 400 Bad Request
  • 404 Not Found

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

Fields and Objects

The table below describes only the minimum relevant fields of the API Request to get a batch of Ocean bookings. For more information on all fields, please, connect with your project44 Technical Contact for the Booking API Reference Documentation.

FieldDescription
attribute.nameThe name of the custom booking attribute to search against.
attribute.valuesThe values of the custom booking attribute to search for; this filter is non-partial.
statusList of booking statuses to filter against. Valid values include PROCESSING, UNDER_REVIEW, BOOKED, REJECTED, CANCELLED, and EXPIRED.
pageNumberThe number of pages returned, must be greater than 0. Default is 1.
pageSizeDefault is 10.