Skip to content
Bigship SDK

Introduction

The @agamya/bigship-sdk is a TypeScript SDK for the Bigship.in External Outbound API. It provides type-safe access to shipping, orders, rates, tracking, and more.

Features

Section titled “Features”
  • Type-Safe — Zod schemas for runtime validation, full TypeScript inference
  • Auto-Authentication — Login once, token cached automatically
  • Retry with Backoff — Exponential backoff with full jitter, configurable
  • Event Hooks — onBeforeRequest, onResponse, onError, onRetry
  • Pluggable Logger — Bring your own Winston, pino, or console logger
  • Full API Coverage — All 16 Bigship API endpoints
  • Convenience Methods — manifestAndGetAWB, getShipmentDetails, createAndFinalizeShipment
  • Workflow Builder — Fluent create → withCourier → manifest → finalize API

Requirements

Section titled “Requirements”
  • Node.js >= 18
  • Bigship.in API credentials (user name, password, access key)
Section titled “Quick Links”

Disclaimer: Community project based on publicly available Bigship API documentation. Not officially affiliated with Bigship.in.