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
  • Booking prerequisites
  • Booking status list
  • Booking status diagram
  1. General Overview
  2. Objects and IDs

Shipments Requests (Bookings)

A booking (or shipment request) object in Shiptity is the essential first step of any shipment between Shipper and Carriers. By the end of the booking workflow, many operational and financial parameters of a future shipment will be already set.

Booking prerequisites

To be finalized, a booking shall have the following parameters defined :

  • name of the shipment request

  • packing list (content type and quantity)

  • pickup address

  • delivery address

  • pickup date and time

  • delivery date and time (only necessary for the booking’s confirmation)

  • chosen carrier

  • booking confirmation from the carrier or auto-confirmation from the shipper

Booking status list

Status (EN)
Status (FR)
Description (EN)
Description (FR)

Draft

Pré dossier

Pending Draft

En cours de constitution

Ready to book

PrĂŞt Ă  booker

Ready to send to carriers

PrĂŞt Ă  envoyer aux transporteurs

Quotation

Cotation

Quotation pending

Cotation en cours

Booked

Booké

Confirmed by shipper

Confirmé auprès du transporteur

Confirmed

Confirmé

Confirmed by Carrier

Confirmé par le transporteur

Declined

Décliné

Declined by Carrier

Refusé par le transporteur

Canceled

Annulé

Booking status diagram

PreviousObjects and IDsNextShipments

Last updated 1 year ago