Cancellation
Cancel shipments using the cancelShipments method. Pass an array of AWB numbers to cancel one or more shipments at once.
Imports
Section titled “Imports”import { BigshipClient, isSuccessResponse,} from '@agamya/bigship-sdk';Cancel Shipments
Section titled “Cancel Shipments”const result = await client.cancelShipments(['13090318586270']);if (isSuccessResponse(result)) { console.log('Shipment cancelled');}Cancel Multiple Shipments
Section titled “Cancel Multiple Shipments”const result = await client.cancelShipments([ '13090318586270', '13090318586271', '13090318586272',]);Method Signature
Section titled “Method Signature”cancelShipments(awbNumbers: string[]): Promise<ApiResponse<null>>| Parameter | Type | Description |
|---|---|---|
awbNumbers |
string[] |
Array of AWB numbers to cancel |