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
  • New Shipment
  • Shipment status list¶
  • Shipment status diagram
  • Multi-containers / Multi-shipments
  1. General Overview
  2. Objects and IDs

Shipments

PreviousShipments Requests (Bookings)NextTracking Points

Last updated 2 years ago

New Shipment

Shippers: You can’t create one shipment directly. You must first create a booking (Shipment request) via the API or the Platform. Then confirm it through the Platform (Only).

Carriers: Under certain circumstances, carriers have the ability to create a shipment on behalf of their client (shippers) through the API via the endpoint Create shipment by carrier. If you would like to do so, please ask your Shiptify sales representative.

Shipment status list¶

The following statuses are triggered by the last known tracking points.

Status (EN)
Status (FR)

Planned

Planifié

In transit

En transit

Delivered

Livré

Canceled

Annulé

Shipment status diagram

Multi-containers / Multi-shipments

Usually, one booking generates only one shipment. But you may need to book several shipments in a row for specific cases.

This is what we call Multi-containers or Multi-shipments. When such a booking gets confirmed, several shipments will be created in Shiptify. Each of them will have their own data or documentation attached but they can also benefit from common actions.