Cancellation
Cancel shipments using the cancelOrder method. Pass the order ID to cancel an order (only before rider is assigned).
Imports
Section titled “Imports”import { BigshipClient, isSuccessResponse,} from '@agamya/bigship-sdk';Cancel Order
Section titled “Cancel Order”const result = await client.cancelOrder('311276742');if (isSuccessResponse(result)) { console.log('Order cancelled');}Method Signature
Section titled “Method Signature”cancelOrder(orderId: string): Promise<ApiResponse<null>>| Parameter | Type | Description |
|---|---|---|
orderId |
string |
Order ID to cancel |