Skip to content

Shipments

Fulfillment Core API

Track and manage shipments throughout their journey—from label creation to final delivery. Access real-time tracking events, shipping labels, and delivery confirmations.

5 Endpoints

Full shipment lifecycle

Auth

Bearer token required

Base URL

/employee/shipment/

Available endpoints

Endpoint Method Description
List All Shipments GET Retrieve paginated list of all shipments
Get Single Shipment GET Fetch complete details for a specific shipment
Track Shipment GET Get real-time tracking events and delivery status
Void Shipment DELETE Cancel a shipment before first scan

Shipment lifecycle

┌─────────────┐    ┌─────────────┐    ┌─────────────┐    ┌─────────────┐
│   Label     │ ─► │   Origin    │ ─► │  In Transit │ ─► │  Delivered  │
│   Created   │    │   Scanned   │    │   Events    │    │  (POD)      │
└─────────────┘    └─────────────┘    └─────────────┘    └─────────────┘
     (0)               (1-2)             (3-11)             (12)

See Shipment Statuses for complete status codes and scan types.

Common use cases

Customer tracking portal

  1. Use Track Shipment with tracking ID, shipment ID, or booking ID
  2. Display events array as timeline with locations and timestamps
  3. Show humanStatus for current state and eta for delivery estimate

Operations dashboard

  • Use List All Shipments to populate shipment tables
  • Filter by status to identify shipments needing attention
  • Access labelDocuments URLs for reprinting shipping labels

Support workflows

  • Use Get Single Shipment for complete shipment details
  • Check events history for scan exceptions or delays
  • Use acknowledgement_copy for proof of delivery when available

Cancellations

  • Use Void Shipment before first hub scan
  • Voiding revokes labels and reverses any pending charges
  • Cannot void after shipment enters transit

Key concepts

Tracking identifiers

Identifier Format Usage
trackingId 692986D4 Short code on labels, shared with customers
_id 692986d463136da39a6af12f MongoDB ObjectId, internal reference
booking._id 692944f5c489fb616853e1da Original booking that created shipment

Status codes

Shipments progress through numeric status codes (0-12). Key milestones:

  • 0 — Pending (label created)
  • 3 — In Transit
  • 9 — Undergoing Clearance (international)
  • 12 — Delivered

See Shipment Statuses for full mapping.

API authorization

All Shipment endpoints require authorization via API tokens:

Authorization: Bearer {{ your_token }}

See Authentication for token generation.