Skip to main content

BigShip Playground

Connected to api.bigship.direct

Ship the API.
Skip the postman.

Type a call. See the typed response.
Every @agamya/bigship-sdk method, every error class, every lifecycle hook — exercised in your browser before you touch your codebase.

22
SDK methods
16
API endpoints
0
hand-written HTTP calls
createOrder.ts — live request
POST /api/createOrder
Request
import { BigshipClient } from '@agamya/bigship-sdk';

const client = new BigshipClient({
  baseURL: 'https://api.bigship.direct',
  userName: process.env.BIGSHIP_USER_NAME!,
  password: process.env.BIGSHIP_PASSWORD!,
  accessKey: process.env.BIGSHIP_ACCESS_KEY!,
});

const order = await client.createOrder({
  referenceNo: 'INV-2026-04812',
  orderType: 'B2C',
  customer: { name: 'Priya Shah', phone: '98xxxxxx21' },
  pickup: { warehouseId: 1042 },
  delivery: { pincode: '560001', city: 'Bengaluru' },
  items: [{ name: 'Wool scarf', qty: 1, value: 1899 }],
});
Response200 OK · 187ms
{
  "status": true,
  "data": {
    "orderId": 884_211_039,
    "awbNumber": "BSID26-04812",
    "courierPartner": "Delhivery Surface",
    "estimatedDelivery": "2026-09-13",
    "walletBalanceAfter": 12_845.50
  },
  "requestId": "req_01HZX4M0F3Q8YKJ2VBNT6"
}
onRequest → onResponse → onRetryRun it yourself
Zero to first shipmentnpm install @agamya/bigship-sdk — open the BigShip SDK method index
Walkthrough

Two minutes from npm install to first AWB.

Watch a full B2C flow: credential gate, create order, manifest, finalize, track — every step a real API call against api.bigship.direct.

What's inside

One playground, every surface of the SDK.

The same surface ships the method index, the error catalog, generated code snippets, and live hook observability — no tab-switching, no separate tools.