Skip to content
Bigship SDK

Introduction

The @agamya/bigship-sdk is a TypeScript SDK for the Bigship.direct Unified 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 Bigship Unified Outbound API endpoints
  • Segment Types — Support for hyperlocal, domestic B2B, and domestic B2C shipments
  • Workflow Builder — Fluent create → withCourier → place → finalize API

Requirements

Section titled “Requirements”
  • Node.js >= 20.12.0
  • Bigship.direct API credentials (username, password, access key)
Section titled “Quick Links”

Version Notice

Section titled “Version Notice”

This documentation is for v4.0.0 which uses the Unified Outbound API. For v2.x documentation, see the GitHub releases.

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