Documentation
API Documentation
API Documentation
  • General Overview
    • Introduction
      • Before you start
      • Environments
      • Integration
    • Objects and IDs
      • Shipments Requests (Bookings)
      • Shipments
      • Tracking Points
      • Addresses
    • 📖Glossary
  • I am a shipper
    • Webhooks
      • Set up my webhooks
      • Payloads for Shipper
    • Documents
      • Download Documents
      • Upload Documents
  • I am a carrier
    • Bookings
      • Set up my webhooks
      • Payloads for Carrier
    • Trackings
    • Documents
      • Download Documents
      • Upload Documents
  • Full API
    • Swagger API Endpoints
Powered by GitBook
On this page
  • #SR ID : Shipment Request
  • #QR ID : Quote Request
  • #SH ID : Shipment
  • #TP ID : Tracking Point
  • Tree Structure
  1. General Overview

Objects and IDs

PreviousIntegrationNextShipments Requests (Bookings)

Last updated 1 year ago

#SR ID : Shipment Request

A shipper generates 1 Shipment Request. This last, as known as booking, is identified with an #SR ID.

#QR ID : Quote Request

If there is a process of quotation, the platform generates as many quote requests as there are carriers in the quotation. So 1 #SR ID can be linked to 0 #QR ID (No quotation process involved) or to n #QR IDs (Depending on the number of carriers that are involved in the quotation).

#SH ID : Shipment

If 1 Shipment Request (#SR ID) gets confirmed by carrier, it generates at least 1 shipment identified with its #SH ID.

For some reasons, the Shipment Request (#SR ID) does not always get confirmed. In such a case, there is 0 shipment (#SH ID) created.

In a Multi-containers or Multi-shipments request, 1 Shipment Request (#SR ID) generates more than 1 and up to n shipments (#SH IDs).

#TP ID : Tracking Point

1 Shipment (#SH ID) generates at least 2 Tracking Points (#TP ID): Pickup TP and Delivery TP. But there can be many other TPs.

Tree Structure