multivendor-rapidshyp
v0.0.1
Published
Framework-agnostic RapidShyp shipping API client with payload helpers
Maintainers
Readme
multivendor-rapidshyp
Framework-agnostic RapidShyp shipping API client with payload helpers for B2C wrapper, return wrapper, and pickup registration.
Install
npm install multivendor-rapidshypUsage
import {
RapidShypClient,
toB2cWrapperPayload,
sanitizeRapidShypOrderItems,
} from 'multivendor-rapidshyp';
const client = new RapidShypClient({
apiKey: process.env.RAPIDSHYP_API_KEY!,
});
const rates = await client.checkServiceability({
Pickup_pincode: '380001',
Delivery_pincode: '400001',
cod: false,
total_order_value: 999,
weight: 0.5,
});
const payload = toB2cWrapperPayload({
orderId: 'ORD_123',
orderDate: '2026-06-12',
// ...
});
payload.orderItems = sanitizeRapidShypOrderItems(payload.orderItems);
const { data } = await client.b2cWrapper(payload);API
| RapidShypClient method | RapidShyp endpoint |
|--------------------------|------------------|
| checkServiceability | serviceabilty_check |
| createOrder | create_order |
| returnWrapper | return_wrapper |
| b2cWrapper | wrapper |
| getOrderInfo | get_order_info |
| assignAwb | assign_awb |
| generateLabel | generate_label |
| trackOrder | track_order |
| cancelOrder | cancel_order |
| createPickupLocation | create/pickup_location |
Payload helpers: toReturnWrapperPayload, toB2cWrapperPayload, pickup validation, item text sanitization, response parsers.
License
MIT
