API Reference

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`apiResponse?`	`readonly`	`BigshipErrorData`	-	`BigshipApiError`.`apiResponse`	packages/sdk/src/errors/BigshipError.ts:33
`cause?`	`public`	`unknown`	-	`BigshipApiError`.`cause`	node_modules/typescript/lib/lib.es2022.error.d.ts:26
`code?`	`readonly`	`string`	-	`BigshipApiError`.`code`	packages/sdk/src/errors/BigshipError.ts:32
`endpoint?`	`readonly`	`string`	-	`BigshipApiError`.`endpoint`	packages/sdk/src/errors/index.ts:32
`message`	`public`	`string`	-	`BigshipApiError`.`message`	node_modules/typescript/lib/lib.es5.d.ts:1077
`name`	`public`	`string`	-	`BigshipApiError`.`name`	node_modules/typescript/lib/lib.es5.d.ts:1076
`requestId?`	`readonly`	`string`	-	`BigshipApiError`.`requestId`	packages/sdk/src/errors/index.ts:31
`responseBody?`	`readonly`	`unknown`	-	`BigshipApiError`.`responseBody`	packages/sdk/src/errors/index.ts:33
`stack?`	`public`	`string`	-	`BigshipApiError`.`stack`	node_modules/typescript/lib/lib.es5.d.ts:1078
`statusCode`	`readonly`	`number`	-	`BigshipApiError`.`statusCode`	packages/sdk/src/errors/BigshipError.ts:31
`traceId?`	`readonly`	`string`	-	`BigshipApiError`.`traceId`	packages/sdk/src/errors/BigshipError.ts:35
`validationErrors?`	`readonly`	`Record`<`string`, `string`[]>	-	`BigshipApiError`.`validationErrors`	packages/sdk/src/errors/BigshipError.ts:34
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	`BigshipApiError`.`stackTraceLimit`	node_modules/@types/node/globals.d.ts:68

Methods

isAuthError()

isAuthError(): boolean;

Defined in: packages/sdk/src/errors/BigshipError.ts:61

Returns

boolean

Inherited from

isRateLimitError()

isRateLimitError(): boolean;

Defined in: packages/sdk/src/errors/BigshipError.ts:57

Returns

boolean

Inherited from

isValidationError()

isValidationError(): boolean;

Defined in: packages/sdk/src/errors/BigshipError.ts:53

Returns

boolean

Inherited from

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

Defined in: node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

Defined in: node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

BigshipClient

Defined in: packages/sdk/src/core/BigshipClient.ts:99

Constructors

Constructor

new BigshipClient(config: BigshipConfig & {
  loggerAdapter?: LoggerAdapter;
}): BigshipClient;

Defined in: packages/sdk/src/core/BigshipClient.ts:107

Parameters

config

BigshipConfig & { loggerAdapter?: LoggerAdapter; }

Returns

BigshipClient

Methods

calculateRate()

calculateRate(payload: {
  boxes: {
     box_dead_weight: number;
     box_height: number;
     box_length: number;
     box_width: number;
     no_of_box: number;
  }[];
  codAmount?: string;
  destPincode: string;
  invoiceValue: number;
  paymentModeId: number;
  riskTypeId: number;
  segment_type: "domestic_b2b" | "domestic_b2c";
  sourcePincode: string;
}, options?: RequestOptions): Promise<{
  data:   | {
     codCharges: number;
     courier_partner_id: number;
     courierCharge: number;
     courierImage: string | null;
     courierName: string;
     courierType: string;
     emailNotificationCharge: number;
     greenTax: number;
     handlingCharge: string;
     lrCost: string | number;
     minimum_weight: string;
     oda: string;
     pickup_Charge: number;
     planName: string;
     restricted_pincode_message: string | null;
     riskType: string;
     riskTypeName: string;
     smsNotificationCharge: number;
     state_Tax: string;
     tat: string;
     toPay: number;
     totalCharge: number;
     warai_Charge: number;
     weight: string | number;
     whatsappNotificationCharge: number;
     zone: string;
   }[]
     | null;
  message: string;
  status: boolean;
  status_code: number;
}>;

Defined in: packages/sdk/src/core/BigshipClient.ts:367

Calculate shipping rates without creating an order.

Parameters

payload

boxes

{ box_dead_weight: number; box_height: number; box_length: number; box_width: number; no_of_box: number; }[] = ...

codAmount?

string = ...

destPincode

string = ...

invoiceValue

number = ...

paymentModeId

number = ...

riskTypeId

number = ...

segment_type

"domestic_b2b" | "domestic_b2c" = ...

sourcePincode

string = ...

options?

Returns

Promise<{ data: | { codCharges: number; courier_partner_id: number; courierCharge: number; courierImage: string | null; courierName: string; courierType: string; emailNotificationCharge: number; greenTax: number; handlingCharge: string; lrCost: string | number; minimum_weight: string; oda: string; pickup_Charge: number; planName: string; restricted_pincode_message: string | null; riskType: string; riskTypeName: string; smsNotificationCharge: number; state_Tax: string; tat: string; toPay: number; totalCharge: number; warai_Charge: number; weight: string | number; whatsappNotificationCharge: number; zone: string; }[] | null; message: string; status: boolean; status_code: number; }>

Throws

When request validation fails

Throws

When API request fails

cancelOrder()

cancelOrder(orderId: string, options?: RequestOptions): Promise<{
  data: unknown[] | null;
  message: string;
  status: boolean;
  status_code: number;
}>;

Defined in: packages/sdk/src/core/BigshipClient.ts:422

Cancel an order by its CustomGlobalOrderId.

Parameters

orderId

string

The CustomGlobalOrderId of the order to cancel

options?

Returns

Promise<{ data: unknown[] | null; message: string; status: boolean; status_code: number; }>

Throws

When request validation fails

Throws

When API request fails

createOrder()

createOrder(payload:
  | {
  additional_comments?: string;
  boxes: {
     dimension_unit: "cm";
     dimensions: {
        breadth?: number;
        height?: number;
        length?: number;
        weight: number;
     }[];
     weight_unit: "kg";
  };
  MasterOrderInvoiceAmount: number;
  MasterOrderPaymentMode: number;
  MasterOrderPickUpLocation: number;
  MasterOrderShippingAddress: string;
  MasterOrderShippingAddress2?: string;
  MasterOrderShippingCity: string;
  MasterOrderShippingCountry: string;
  MasterOrderShippingEmail?: string;
  MasterOrderShippingLandmark?: string;
  MasterOrderShippingLatitude: string;
  MasterOrderShippingLongitude: string;
  MasterOrderShippingMobileNo: string | number;
  MasterOrderShippingName: string;
  MasterOrderShippingState: string;
  MasterOrderShippingZipCode: string;
  OrderInvoiceNo?: string;
  PackageTypeId: number;
  pickup_instructions?: string;
  segment_type: "hyperlocal";
}
  | {
  boxes: {
     dimension_unit: "cm";
     dimensions: {
        breadth: number;
        height: number;
        length: number;
        weight: number;
     }[];
     noOfBoxes: number;
     weight_unit: "kg";
  }[];
  MasterOrderCollectableAmount?: string;
  MasterOrderDate: string;
  MasterOrderInvoiceAmount: number;
  MasterOrderPaymentMode: number;
  MasterOrderPickUpLocation: number;
  MasterOrderReturnLocation: number;
  MasterOrderShippingAddress: string;
  MasterOrderShippingAddress2?: string;
  MasterOrderShippingCity: string;
  MasterOrderShippingCountry: string;
  MasterOrderShippingEmail?: string;
  MasterOrderShippingLandmark?: string;
  MasterOrderShippingMobileNo: string | number;
  MasterOrderShippingName: string;
  MasterOrderShippingState: string;
  MasterOrderShippingZipCode: string;
  OrderInvoiceNo: string;
  ProductName: string;
  segment_type: "domestic_b2b";
  totalNumOfBoxes: number;
}
  | {
  boxes: {
     dimension_unit: "cm";
     dimensions: {
        breadth: number;
        height: number;
        length: number;
        weight: number;
     }[];
     noOfBoxes: number;
     products: {
        amount: string | number;
        categoryId: string;
        collectableAmount: string | number;
        hsn?: string;
        productName: string;
        qty: string | number;
        totalAmount: string | number;
     }[];
     weight_unit: "kg";
  }[];
  MasterOrderDate: string;
  MasterOrderInvoiceAmount: number;
  MasterOrderPaymentMode: number;
  MasterOrderPickUpLocation: number;
  MasterOrderReturnLocation: number;
  MasterOrderShippingAddress: string;
  MasterOrderShippingAddress2?: string;
  MasterOrderShippingCity: string;
  MasterOrderShippingCountry: string;
  MasterOrderShippingEmail?: string;
  MasterOrderShippingLandmark?: string;
  MasterOrderShippingMobileNo: string | number;
  MasterOrderShippingName: string;
  MasterOrderShippingState: string;
  MasterOrderShippingZipCode: string;
  OrderInvoiceNo: string;
  segment_type: "domestic_b2c";
  totalNumOfBoxes: number;
}, options?: RequestOptions): Promise<{
  data:   | {
     CustomGlobalOrderId: string;
   }
     | null;
  message: string;
  status: boolean;
  status_code: number;
}>;

Defined in: packages/sdk/src/core/BigshipClient.ts:382

Create a new order in draft mode. Supports hyperlocal, domestic_b2b, and domestic_b2c segment types.

Parameters

payload

| { additional_comments?: string; boxes: { dimension_unit: "cm"; dimensions: { breadth?: number; height?: number; length?: number; weight: number; }[]; weight_unit: "kg"; }; MasterOrderInvoiceAmount: number; MasterOrderPaymentMode: number; MasterOrderPickUpLocation: number; MasterOrderShippingAddress: string; MasterOrderShippingAddress2?: string; MasterOrderShippingCity: string; MasterOrderShippingCountry: string; MasterOrderShippingEmail?: string; MasterOrderShippingLandmark?: string; MasterOrderShippingLatitude: string; MasterOrderShippingLongitude: string; MasterOrderShippingMobileNo: string | number; MasterOrderShippingName: string; MasterOrderShippingState: string; MasterOrderShippingZipCode: string; OrderInvoiceNo?: string; PackageTypeId: number; pickup_instructions?: string; segment_type: "hyperlocal"; } | { boxes: { dimension_unit: "cm"; dimensions: { breadth: number; height: number; length: number; weight: number; }[]; noOfBoxes: number; weight_unit: "kg"; }[]; MasterOrderCollectableAmount?: string; MasterOrderDate: string; MasterOrderInvoiceAmount: number; MasterOrderPaymentMode: number; MasterOrderPickUpLocation: number; MasterOrderReturnLocation: number; MasterOrderShippingAddress: string; MasterOrderShippingAddress2?: string; MasterOrderShippingCity: string; MasterOrderShippingCountry: string; MasterOrderShippingEmail?: string; MasterOrderShippingLandmark?: string; MasterOrderShippingMobileNo: string | number; MasterOrderShippingName: string; MasterOrderShippingState: string; MasterOrderShippingZipCode: string; OrderInvoiceNo: string; ProductName: string; segment_type: "domestic_b2b"; totalNumOfBoxes: number; } | { boxes: { dimension_unit: "cm"; dimensions: { breadth: number; height: number; length: number; weight: number; }[]; noOfBoxes: number; products: { amount: string | number; categoryId: string; collectableAmount: string | number; hsn?: string; productName: string; qty: string | number; totalAmount: string | number; }[]; weight_unit: "kg"; }[]; MasterOrderDate: string; MasterOrderInvoiceAmount: number; MasterOrderPaymentMode: number; MasterOrderPickUpLocation: number; MasterOrderReturnLocation: number; MasterOrderShippingAddress: string; MasterOrderShippingAddress2?: string; MasterOrderShippingCity: string; MasterOrderShippingCountry: string; MasterOrderShippingEmail?: string; MasterOrderShippingLandmark?: string; MasterOrderShippingMobileNo: string | number; MasterOrderShippingName: string; MasterOrderShippingState: string; MasterOrderShippingZipCode: string; OrderInvoiceNo: string; segment_type: "domestic_b2c"; totalNumOfBoxes: number; }

options?

Returns

Promise<{ data: | { CustomGlobalOrderId: string; } | null; message: string; status: boolean; status_code: number; }>

Throws

When request validation fails

Throws

When API request fails

downloadDocument()

downloadDocument(
   orderId: string,
   documentType: "invoice" | "label" | "ewaybill" | "manifest",
   options?: RequestOptions): Promise<{
  data:   | {
     AttachmentData: string;
     File_extention: string;
   }
     | null;
  message: string;
  status: boolean;
  status_code: number;
}>;

Defined in: packages/sdk/src/core/BigshipClient.ts:464

Download a shipment document (invoice, label, ewaybill, or manifest).

Parameters

orderId

string

The CustomGlobalOrderId of the order

documentType

"invoice" | "label" | "ewaybill" | "manifest"

The type of document to download

options?

Returns

Promise<{ data: | { AttachmentData: string; File_extention: string; } | null; message: string; status: boolean; status_code: number; }>

Throws

When request validation fails

Throws

When API request fails

getOrderDetail()

getOrderDetail(orderId: string, options?: RequestOptions): Promise<{
  data:   | {
     getOrderDetails: {
        AwbNumber: string;
        box_dimensions: {
           breadth: string;
           each_box_weight: string;
           height: string;
           length: string;
           no_of_box: string;
        }[];
        collectableAmount: string;
        consignee: {
           billingAddress: string;
           billingAddress2: string;
           companyEmailId: string | null;
           companyMobile: string;
           companyName: string;
           consigneeBusinessType: string;
           landmark: string;
           orderCity: string;
           orderCountry: string;
           orderPin: string;
           orderState: string;
        };
        consigneeBilling: {
           billingAddress: string;
           billingAddress2: string;
           companyEmailId: string | null;
           companyMobile: string;
           companyName: string;
           consigneeBusinessType: string;
           landmark: string;
           orderCity: string;
           orderCountry: string;
           orderPin: string;
           orderState: string;
        };
        consignor: {
           billingAddress: string;
           billingAddress2: string;
           companyEmailId: string | null;
           companyMobile: string;
           companyName: string;
           consignorBusinessType: string;
           landmark: string;
           orderCity: string;
           orderCountry: string;
           orderPin: string;
           orderState: string;
        };
        consignorType: string;
        created_at: string;
        dimensions: string[];
        InvoiceCurrency: string;
        InvoiceNumber: string;
        InvoiceStatus: string;
        InvoiceStatusId: string;
        MasterCustomInvoiceId: string | null;
        MasterCustomOrderId: string;
        MasterOrderCurrency: string;
        MasterOrderShippingZipCode: string;
        orderDate: string;
        PackageTypeId: string;
        PackageTypeName: string;
        PaymentMode: string;
        pickupDetail: {
           warehouseAddressLandMark: string;
           warehouseAddressLine1: string;
           warehouseAddressLine2: string;
           warehouseAddressPhone: string;
           warehouseCity: string;
           warehouseContactPerson: string;
           warehouseCountry: string;
           warehouseName: string;
           warehousePin: string;
           warehouseState: string;
        };
        product_details: {
           box_details: {
              parameterCategory: string;
              parameterName: string;
              parameterValue: string;
           }[];
           detailsIdentifier: string;
           numberOfProducts: string;
           products: unknown[];
           weight: {
              unit: string;
              value: string;
           };
        }[];
        products_name: string;
        status: string;
        status_id: string;
        totalInvoiceAmount: string;
        totalNoOfBoxes: number | null;
        updated_at: string;
        weight: string;
        weightUnit: string;
     };
     segment_type: string;
   }
     | null;
  message: string;
  status: boolean;
  status_code: number;
}>;

Defined in: packages/sdk/src/core/BigshipClient.ts:450

Get detailed information about an order.

Parameters

orderId

string

The MasterCustomOrderId of the order

options?

Returns

Promise<{ data: | { getOrderDetails: { AwbNumber: string; box_dimensions: { breadth: string; each_box_weight: string; height: string; length: string; no_of_box: string; }[]; collectableAmount: string; consignee: { billingAddress: string; billingAddress2: string; companyEmailId: string | null; companyMobile: string; companyName: string; consigneeBusinessType: string; landmark: string; orderCity: string; orderCountry: string; orderPin: string; orderState: string; }; consigneeBilling: { billingAddress: string; billingAddress2: string; companyEmailId: string | null; companyMobile: string; companyName: string; consigneeBusinessType: string; landmark: string; orderCity: string; orderCountry: string; orderPin: string; orderState: string; }; consignor: { billingAddress: string; billingAddress2: string; companyEmailId: string | null; companyMobile: string; companyName: string; consignorBusinessType: string; landmark: string; orderCity: string; orderCountry: string; orderPin: string; orderState: string; }; consignorType: string; created_at: string; dimensions: string[]; InvoiceCurrency: string; InvoiceNumber: string; InvoiceStatus: string; InvoiceStatusId: string; MasterCustomInvoiceId: string | null; MasterCustomOrderId: string; MasterOrderCurrency: string; MasterOrderShippingZipCode: string; orderDate: string; PackageTypeId: string; PackageTypeName: string; PaymentMode: string; pickupDetail: { warehouseAddressLandMark: string; warehouseAddressLine1: string; warehouseAddressLine2: string; warehouseAddressPhone: string; warehouseCity: string; warehouseContactPerson: string; warehouseCountry: string; warehouseName: string; warehousePin: string; warehouseState: string; }; product_details: { box_details: { parameterCategory: string; parameterName: string; parameterValue: string; }[]; detailsIdentifier: string; numberOfProducts: string; products: unknown[]; weight: { unit: string; value: string; }; }[]; products_name: string; status: string; status_id: string; totalInvoiceAmount: string; totalNoOfBoxes: number | null; updated_at: string; weight: string; weightUnit: string; }; segment_type: string; } | null; message: string; status: boolean; status_code: number; }>

Throws

When request validation fails

Throws

When API request fails

getPackageTypes()

getPackageTypes(options?: RequestOptions): Promise<{
  data:   | {
     Description: string;
     HyperlocalPackageTypeId: number;
     IsEnabled: string;
     PackageType: string;
   }[]
     | null;
  message: string;
  status: boolean;
  status_code: number;
}>;

Defined in: packages/sdk/src/core/BigshipClient.ts:333

Get the list of package types for hyperlocal shipments.

Parameters

options?

Returns

Promise<{ data: | { Description: string; HyperlocalPackageTypeId: number; IsEnabled: string; PackageType: string; }[] | null; message: string; status: boolean; status_code: number; }>

Throws

When API request fails

getPaymentModes()

getPaymentModes(segmentType: "hyperlocal" | "domestic_b2b" | "domestic_b2c", options?: RequestOptions): Promise<{
  data:   | {
     paymentModeId: string;
     paymentModeName: string;
   }[]
     | null;
  message: string;
  status: boolean;
  status_code: number;
}>;

Defined in: packages/sdk/src/core/BigshipClient.ts:344

Get the list of payment modes for a segment type.

Parameters

segmentType

"hyperlocal" | "domestic_b2b" | "domestic_b2c"

The shipment segment type: ‘hyperlocal’, ‘domestic_b2c’, or ‘domestic_b2b’

options?

Returns

Promise<{ data: | { paymentModeId: string; paymentModeName: string; }[] | null; message: string; status: boolean; status_code: number; }>

Throws

When API request fails

getProfile()

getProfile(options?: RequestOptions): Promise<{
  data:   | {
     api_master_client_account: {
        access_key: string;
        access_key_generated_date: string;
        created_date: string;
        is_account_enabled: string;
        updated_date: string;
     };
     countryname: string;
     EmailID: string;
     firstName: string;
     is_outbound_service_enabled: string;
     IsEmailVerifed: string;
     lastName: string;
     mobileNumber: string;
     userWallet: {
        Balance: string | number;
        kycCurrency: string;
     };
   }
     | null;
  message: string;
  status: boolean;
  status_code: number;
}>;

Defined in: packages/sdk/src/core/BigshipClient.ts:279

Get the authenticated user’s profile information.

Parameters

options?

Returns

Promise<{ data: | { api_master_client_account: { access_key: string; access_key_generated_date: string; created_date: string; is_account_enabled: string; updated_date: string; }; countryname: string; EmailID: string; firstName: string; is_outbound_service_enabled: string; IsEmailVerifed: string; lastName: string; mobileNumber: string; userWallet: { Balance: string | number; kycCurrency: string; }; } | null; message: string; status: boolean; status_code: number; }>

Throws

When API request fails

getRiskTypes()

getRiskTypes(options?: RequestOptions): Promise<{
  data:   | {
     riskName: string;
     riskTypeId: number;
     slug: string;
   }[]
     | null;
  message: string;
  status: boolean;
  status_code: number;
}>;

Defined in: packages/sdk/src/core/BigshipClient.ts:354

Get the list of risk types (insurance options).

Parameters

options?

Returns

Promise<{ data: | { riskName: string; riskTypeId: number; slug: string; }[] | null; message: string; status: boolean; status_code: number; }>

Throws

When API request fails

getServiceableCouriers()

getServiceableCouriers(orderId: string, options?: RequestOptions): Promise<{
  data:   | {
     calculatedRates: (
        | {
        base_freight: number;
        capacity: string;
        courierId: number;
        courierImage: string;
        courierName: string;
        currency: string;
        gst_amount: number;
        planName: string;
        total_freight: number;
        vehicle_type: string;
      }
        | {
        base_freight: number;
        charged_weight: number;
        codCharges: number;
        courierId: string;
        courierImage: string | null;
        courierName: string;
        courierType: string;
        destination: string;
        emailNotificationCharge: number;
        greenTax: string;
        handlingCharge: string;
        kycCurrency: string;
        lrCost: string;
        oda: string;
        pickup: string;
        pickup_Charge: string;
        planName: string;
        riskCharge: string;
        riskCharges: {
           chargeValue: string;
           isRisk: boolean;
           name: string;
           typeId: number;
        }[];
        riskTypeName: string;
        smsNotificationCharge: number;
        state_Tax: string | number;
        tat: number;
        toPay: string;
        total: string;
        warai_Charge: number;
        weight_unit: string;
        whatsappNotificationCharge: number;
        zone: string;
     })[];
     segment_type: string;
   }
     | null;
  message: string;
  status: boolean;
  status_code: number;
}>;

Defined in: packages/sdk/src/core/BigshipClient.ts:396

Get serviceable couriers and rate quotations for a draft order. Must be called after createOrder() and before placeOrder().

Parameters

orderId

string

The CustomGlobalOrderId returned from createOrder()

options?

Returns

Promise<{ data: | { calculatedRates: ( | { base_freight: number; capacity: string; courierId: number; courierImage: string; courierName: string; currency: string; gst_amount: number; planName: string; total_freight: number; vehicle_type: string; } | { base_freight: number; charged_weight: number; codCharges: number; courierId: string; courierImage: string | null; courierName: string; courierType: string; destination: string; emailNotificationCharge: number; greenTax: string; handlingCharge: string; kycCurrency: string; lrCost: string; oda: string; pickup: string; pickup_Charge: string; planName: string; riskCharge: string; riskCharges: { chargeValue: string; isRisk: boolean; name: string; typeId: number; }[]; riskTypeName: string; smsNotificationCharge: number; state_Tax: string | number; tat: number; toPay: string; total: string; warai_Charge: number; weight_unit: string; whatsappNotificationCharge: number; zone: string; })[]; segment_type: string; } | null; message: string; status: boolean; status_code: number; }>

Throws

When request validation fails

Throws

When API request fails

getWarehouseList()

getWarehouseList(params: {
  filter_type?:   | "warehouse_name"
     | "warehouse_phone"
     | "warehouse_pin"
     | "warehouse_contact_person";
  filter_value?: string;
  page: string;
  perPage: string;
  segment_type: "hyperlocal" | "local";
  status?: string;
}, options?: RequestOptions): Promise<WarehouseListResponse>;

Defined in: packages/sdk/src/core/BigshipClient.ts:303

Get a list of warehouses with optional filtering.

Parameters

params

filter_type?

| "warehouse_name" | "warehouse_phone" | "warehouse_pin" | "warehouse_contact_person" = ...

filter_value?

string = ...

page

string = ...

perPage

string = ...

segment_type

"hyperlocal" | "local" = ...

status?

string = ...

options?

Returns

Promise<WarehouseListResponse>

Throws

When API request fails

placeOrder()

placeOrder(payload: {
  courierId: number;
  invoiceType?: string;
  MasterCustomOrderId: string;
  riskTypeId?: string;
}, options?: RequestOptions): Promise<{
  data:   | {
     awb_assigned: string | number | null;
     reference_number: string | number;
   }
     | null;
  message: string;
  status: boolean;
  status_code: number;
}>;

Defined in: packages/sdk/src/core/BigshipClient.ts:409

Place/manifest an order with a selected courier. Must be called after getServiceableCouriers().

Parameters

payload

courierId

number = ...

invoiceType?

string = ...

MasterCustomOrderId

string = ...

riskTypeId?

string = ...

options?

Returns

Promise<{ data: | { awb_assigned: string | number | null; reference_number: string | number; } | null; message: string; status: boolean; status_code: number; }>

Throws

When request validation fails

Throws

When API request fails

saveWarehouse()

saveWarehouse(payload: {
  address_type?: "Home" | "Office" | "Shop" | "Factory" | "Hotel" | "Other";
  latitude?: string;
  longitude?: string;
  segment_type: "hyperlocal" | "local";
  warehouseAddressLandMark: string;
  warehouseAddressLine1: string;
  warehouseAddressLine2?: string;
  warehouseAddressPhone: string;
  warehouseCity: string;
  warehouseContactPerson: string;
  warehouseCountry: string;
  warehousePinCode: string;
  warehouseState: string;
}, options?: RequestOptions): Promise<{
  data:   | {
     is_phone_verified: number;
     phone_number: string;
     warehouseId: number;
   }
     | null;
  message: string;
  status: boolean;
  status_code: number;
}>;

Defined in: packages/sdk/src/core/BigshipClient.ts:292

Save a new warehouse/pickup location.

Parameters

payload

address_type?

latitude?

string = ...

longitude?

string = ...

segment_type

"hyperlocal" | "local" = ...

warehouseAddressLandMark

string = ...

warehouseAddressLine1

string = ...

warehouseAddressLine2?

string = ...

warehouseAddressPhone

string = ...

warehouseCity

string = ...

warehouseContactPerson

string = ...

warehouseCountry

string = ...

warehousePinCode

string = ...

warehouseState

string = ...

options?

Returns

Promise<{ data: | { is_phone_verified: number; phone_number: string; warehouseId: number; } | null; message: string; status: boolean; status_code: number; }>

Throws

When request validation fails

Throws

When API request fails

trackOrder()

trackOrder(orderId: string, options?: RequestOptions): Promise<{
  data:   | {
     courier_image: string;
     courier_name: string;
     CustomGlobalOrderId: string;
     drop_coordinate: {
        addressType: string;
        latitude: string;
        longitude: string;
        mapLocationId: string;
     };
     latest_checkpoint_time: string;
     order_place_time: string;
     order_status: string;
     source_coordinate: {
        addressType: string;
        latitude: string;
        longitude: string;
        mapLocationId: string;
     };
     tag: string;
     tracking_current_status: {
        fare_details: {
           amount: string;
           currency: string;
        };
        location: {
           latitude: string | null;
           longitude: string | null;
        };
        partner_details?: {
           contact: {
              primary: {
                 country_code: string;
                 number: string;
              };
              secondary: {
                 country_code: string;
                 number: string;
              };
           };
           name: string;
           vehicle: {
              number: string | null;
              type: string;
           };
        };
        timestamps: {
           order: {
              accepted: string | null;
              ended: string | null;
              started: string | null;
           };
           pickup: string | null;
        };
        tracking_status: string;
     };
     tracking_histories: {
        checkpoint_time: string;
        location: {
           latitude: string | null;
           longitude: string | null;
        };
        message: string;
        order_status: string;
        tag: string;
     }[];
     tracking_number: string;
   }
     | null;
  message: string;
  status: boolean;
  status_code: number;
}>;

Defined in: packages/sdk/src/core/BigshipClient.ts:437

Track an order by its CustomGlobalOrderId.

Parameters

orderId

string

The CustomGlobalOrderId of the order to track

options?

Returns

Promise<{ data: | { courier_image: string; courier_name: string; CustomGlobalOrderId: string; drop_coordinate: { addressType: string; latitude: string; longitude: string; mapLocationId: string; }; latest_checkpoint_time: string; order_place_time: string; order_status: string; source_coordinate: { addressType: string; latitude: string; longitude: string; mapLocationId: string; }; tag: string; tracking_current_status: { fare_details: { amount: string; currency: string; }; location: { latitude: string | null; longitude: string | null; }; partner_details?: { contact: { primary: { country_code: string; number: string; }; secondary: { country_code: string; number: string; }; }; name: string; vehicle: { number: string | null; type: string; }; }; timestamps: { order: { accepted: string | null; ended: string | null; started: string | null; }; pickup: string | null; }; tracking_status: string; }; tracking_histories: { checkpoint_time: string; location: { latitude: string | null; longitude: string | null; }; message: string; order_status: string; tag: string; }[]; tracking_number: string; } | null; message: string; status: boolean; status_code: number; }>

Throws

When request validation fails

Throws

When API request fails

updateWarehouse()

updateWarehouse(payload: {
  address_type?: "Home" | "Office" | "Shop" | "Factory" | "Hotel" | "Other";
  latitude?: string;
  longitude?: string;
  warehouseAddressLandMark: string;
  warehouseAddressLine1: string;
  warehouseAddressLine2?: string;
  warehouseAddressPhone: string;
  warehouseCity: string;
  warehouseContactPerson: string;
  warehouseCountry: string;
  warehouseId: string;
  warehouseName: string;
  warehousePinCode: string;
  warehouseState: string;
}, options?: RequestOptions): Promise<{
  data:   | {
     is_phone_verified: number;
     phone_number: string;
   }
     | null;
  message: string;
  status: boolean;
  status_code: number;
}>;

Defined in: packages/sdk/src/core/BigshipClient.ts:320

Update an existing warehouse/pickup location.

Parameters

payload

address_type?

latitude?

string = ...

longitude?

string = ...

warehouseAddressLandMark

string = ...

warehouseAddressLine1

string = ...

warehouseAddressLine2?

string = ...

warehouseAddressPhone

string = ...

warehouseCity

string = ...

warehouseContactPerson

string = ...

warehouseCountry

string = ...

warehouseId

string = ...

warehouseName

string = ...

warehousePinCode

string = ...

warehouseState

string = ...

options?

BigshipDuplicateInvoiceError

Returns

Promise<{ data: | { is_phone_verified: number; phone_number: string; } | null; message: string; status: boolean; status_code: number; }>

Throws

When request validation fails

Throws

When API request fails

BigshipDuplicateInvoiceError

Defined in: packages/sdk/src/errors/index.ts:69

Error thrown when a duplicate invoice ID is detected

Example

try {
  await client.addSingleOrder(orderData);
} catch (error) {
  if (error instanceof BigshipDuplicateInvoiceError) {
    console.log('Duplicate invoice ID:', error.invoiceId);
    console.log('Please use a different invoice number');
  }
}

Extends

BigshipApiError

Constructors

Constructor

new BigshipDuplicateInvoiceError(invoiceId: string, options?: Omit<BigshipApiErrorOptions, "code">): BigshipDuplicateInvoiceError;

Defined in: packages/sdk/src/errors/index.ts:72

Parameters

invoiceId

string

options?

Omit<BigshipApiErrorOptions, "code"> = {}

Returns

Overrides

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`apiResponse?`	`readonly`	`BigshipErrorData`	-	`BigshipApiError`.`apiResponse`	packages/sdk/src/errors/BigshipError.ts:33
`cause?`	`public`	`unknown`	-	`BigshipApiError`.`cause`	node_modules/typescript/lib/lib.es2022.error.d.ts:26
`code?`	`readonly`	`string`	-	`BigshipApiError`.`code`	packages/sdk/src/errors/BigshipError.ts:32
`endpoint?`	`readonly`	`string`	-	`BigshipApiError`.`endpoint`	packages/sdk/src/errors/index.ts:32
`invoiceId`	`readonly`	`string`	-	-	packages/sdk/src/errors/index.ts:70
`message`	`public`	`string`	-	`BigshipApiError`.`message`	node_modules/typescript/lib/lib.es5.d.ts:1077
`name`	`public`	`string`	-	`BigshipApiError`.`name`	node_modules/typescript/lib/lib.es5.d.ts:1076
`requestId?`	`readonly`	`string`	-	`BigshipApiError`.`requestId`	packages/sdk/src/errors/index.ts:31
`responseBody?`	`readonly`	`unknown`	-	`BigshipApiError`.`responseBody`	packages/sdk/src/errors/index.ts:33
`stack?`	`public`	`string`	-	`BigshipApiError`.`stack`	node_modules/typescript/lib/lib.es5.d.ts:1078
`statusCode`	`readonly`	`number`	-	`BigshipApiError`.`statusCode`	packages/sdk/src/errors/BigshipError.ts:31
`traceId?`	`readonly`	`string`	-	`BigshipApiError`.`traceId`	packages/sdk/src/errors/BigshipError.ts:35
`validationErrors?`	`readonly`	`Record`<`string`, `string`[]>	-	`BigshipApiError`.`validationErrors`	packages/sdk/src/errors/BigshipError.ts:34
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	`BigshipApiError`.`stackTraceLimit`	node_modules/@types/node/globals.d.ts:68

Methods

isAuthError()

isAuthError(): boolean;

Defined in: packages/sdk/src/errors/BigshipError.ts:61

Returns

boolean

Inherited from

isRateLimitError()

isRateLimitError(): boolean;

Defined in: packages/sdk/src/errors/BigshipError.ts:57

Returns

boolean

Inherited from

isValidationError()

isValidationError(): boolean;

Defined in: packages/sdk/src/errors/BigshipError.ts:53

Returns

boolean

Inherited from

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

Defined in: node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

Defined in: node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

BigshipError

Defined in: packages/sdk/src/errors/BigshipError.ts:30

Custom error class for Bigship API errors Provides structured access to error details and helper methods for error type checking

Example

try {
  await client.addSingleOrder(orderData);
} catch (error) {
  if (error instanceof BigshipError) {
    if (error.isValidationError()) {
      console.error('Validation failed:', error.validationErrors);
    }
    if (error.isRateLimitError()) {
      console.error('Rate limited, retry after 60s');
    }
    console.error('Status:', error.statusCode);
    console.error('Trace ID:', error.traceId);
  }
}

Extends

Error

Extended by

BigshipApiError

Constructors

Constructor

new BigshipError(
   message: string,
   statusCode?: number,
   code?: string,
   apiResponse?: BigshipErrorData,
   options?: {
  cause?: Error;
}): BigshipError;

Defined in: packages/sdk/src/errors/BigshipError.ts:37

Parameters

message

string

statusCode?

number

code?

string

apiResponse?

BigshipErrorData

options?

cause?

Error

Returns

BigshipError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`apiResponse?`	`readonly`	`BigshipErrorData`	-	-	packages/sdk/src/errors/BigshipError.ts:33
`cause?`	`public`	`unknown`	-	`Error.cause`	node_modules/typescript/lib/lib.es2022.error.d.ts:26
`code?`	`readonly`	`string`	-	-	packages/sdk/src/errors/BigshipError.ts:32
`message`	`public`	`string`	-	`Error.message`	node_modules/typescript/lib/lib.es5.d.ts:1077
`name`	`public`	`string`	-	`Error.name`	node_modules/typescript/lib/lib.es5.d.ts:1076
`stack?`	`public`	`string`	-	`Error.stack`	node_modules/typescript/lib/lib.es5.d.ts:1078
`statusCode`	`readonly`	`number`	-	-	packages/sdk/src/errors/BigshipError.ts:31
`traceId?`	`readonly`	`string`	-	-	packages/sdk/src/errors/BigshipError.ts:35
`validationErrors?`	`readonly`	`Record`<`string`, `string`[]>	-	-	packages/sdk/src/errors/BigshipError.ts:34
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	`Error.stackTraceLimit`	node_modules/@types/node/globals.d.ts:68

Methods

isAuthError()

isAuthError(): boolean;

Defined in: packages/sdk/src/errors/BigshipError.ts:61

Returns

boolean

isRateLimitError()

isRateLimitError(): boolean;

Defined in: packages/sdk/src/errors/BigshipError.ts:57

Returns

boolean

isValidationError()

isValidationError(): boolean;

Defined in: packages/sdk/src/errors/BigshipError.ts:53

Returns

boolean

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

Defined in: node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

Defined in: node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

Error.prepareStackTrace

BigshipNetworkError

Defined in: packages/sdk/src/errors/index.ts:169

Error thrown when network request fails Uses statusCode -1 since this is not an HTTP error. Check error instanceof BigshipNetworkError rather than comparing statusCode.

Extends

BigshipApiError

Constructors

Constructor

new BigshipNetworkError(message: string, options?: Omit<BigshipApiErrorOptions, "code">): BigshipNetworkError;

Defined in: packages/sdk/src/errors/index.ts:170

Parameters

message

string

options?

Omit<BigshipApiErrorOptions, "code"> = {}

Returns

BigshipNetworkError

Overrides

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`apiResponse?`	`readonly`	`BigshipErrorData`	-	`BigshipApiError`.`apiResponse`	packages/sdk/src/errors/BigshipError.ts:33
`cause?`	`public`	`unknown`	-	`BigshipApiError`.`cause`	node_modules/typescript/lib/lib.es2022.error.d.ts:26
`code?`	`readonly`	`string`	-	`BigshipApiError`.`code`	packages/sdk/src/errors/BigshipError.ts:32
`endpoint?`	`readonly`	`string`	-	`BigshipApiError`.`endpoint`	packages/sdk/src/errors/index.ts:32
`message`	`public`	`string`	-	`BigshipApiError`.`message`	node_modules/typescript/lib/lib.es5.d.ts:1077
`name`	`public`	`string`	-	`BigshipApiError`.`name`	node_modules/typescript/lib/lib.es5.d.ts:1076
`requestId?`	`readonly`	`string`	-	`BigshipApiError`.`requestId`	packages/sdk/src/errors/index.ts:31
`responseBody?`	`readonly`	`unknown`	-	`BigshipApiError`.`responseBody`	packages/sdk/src/errors/index.ts:33
`stack?`	`public`	`string`	-	`BigshipApiError`.`stack`	node_modules/typescript/lib/lib.es5.d.ts:1078
`statusCode`	`readonly`	`number`	-	`BigshipApiError`.`statusCode`	packages/sdk/src/errors/BigshipError.ts:31
`traceId?`	`readonly`	`string`	-	`BigshipApiError`.`traceId`	packages/sdk/src/errors/BigshipError.ts:35
`validationErrors?`	`readonly`	`Record`<`string`, `string`[]>	-	`BigshipApiError`.`validationErrors`	packages/sdk/src/errors/BigshipError.ts:34
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	`BigshipApiError`.`stackTraceLimit`	node_modules/@types/node/globals.d.ts:68

Methods

isAuthError()

isAuthError(): boolean;

Defined in: packages/sdk/src/errors/BigshipError.ts:61

Returns

boolean

Inherited from

isRateLimitError()

isRateLimitError(): boolean;

Defined in: packages/sdk/src/errors/BigshipError.ts:57

Returns

boolean

Inherited from

isValidationError()

isValidationError(): boolean;

Defined in: packages/sdk/src/errors/BigshipError.ts:53

Returns

boolean

Inherited from

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

Defined in: node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

Defined in: node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

BigshipValidationError

Defined in: packages/sdk/src/errors/index.ts:111

Error thrown when request validation fails

Example

try {
  await client.addSingleOrder(orderData);
} catch (error) {
  if (error instanceof BigshipValidationError) {
    console.error('Validation errors:', error.validationErrors);
    // { invoice_id: ['Invalid format'], pincode: ['Invalid pincode'] }
  }
}

Extends

BigshipApiError

Constructors

Constructor

new BigshipValidationError(
   message: string,
   validationErrors: Record<string, string[]>,
   options?: Omit<BigshipApiErrorOptions, "code" | "apiResponse">): BigshipValidationError;

Defined in: packages/sdk/src/errors/index.ts:114

Parameters

message

string

validationErrors

Record<string, string[]>

options?

Omit<BigshipApiErrorOptions, "code" | "apiResponse"> = {}

Returns

BigshipValidationError

Overrides

Properties

Property	Modifier	Type	Description	Overrides	Inherited from	Defined in
`apiResponse?`	`readonly`	`BigshipErrorData`	-	-	`BigshipApiError`.`apiResponse`	packages/sdk/src/errors/BigshipError.ts:33
`cause?`	`public`	`unknown`	-	-	`BigshipApiError`.`cause`	node_modules/typescript/lib/lib.es2022.error.d.ts:26
`code?`	`readonly`	`string`	-	-	`BigshipApiError`.`code`	packages/sdk/src/errors/BigshipError.ts:32
`endpoint?`	`readonly`	`string`	-	-	`BigshipApiError`.`endpoint`	packages/sdk/src/errors/index.ts:32
`message`	`public`	`string`	-	-	`BigshipApiError`.`message`	node_modules/typescript/lib/lib.es5.d.ts:1077
`name`	`public`	`string`	-	-	`BigshipApiError`.`name`	node_modules/typescript/lib/lib.es5.d.ts:1076
`requestId?`	`readonly`	`string`	-	-	`BigshipApiError`.`requestId`	packages/sdk/src/errors/index.ts:31
`responseBody?`	`readonly`	`unknown`	-	-	`BigshipApiError`.`responseBody`	packages/sdk/src/errors/index.ts:33
`stack?`	`public`	`string`	-	-	`BigshipApiError`.`stack`	node_modules/typescript/lib/lib.es5.d.ts:1078
`statusCode`	`readonly`	`number`	-	-	`BigshipApiError`.`statusCode`	packages/sdk/src/errors/BigshipError.ts:31
`traceId?`	`readonly`	`string`	-	-	`BigshipApiError`.`traceId`	packages/sdk/src/errors/BigshipError.ts:35
`validationErrors`	`readonly`	`Record`<`string`, `string`[]>	-	`BigshipApiError`.`validationErrors`	-	packages/sdk/src/errors/index.ts:112
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	-	`BigshipApiError`.`stackTraceLimit`	node_modules/@types/node/globals.d.ts:68

Methods

isAuthError()

isAuthError(): boolean;

Defined in: packages/sdk/src/errors/BigshipError.ts:61

Returns

boolean

Inherited from

isRateLimitError()

isRateLimitError(): boolean;

Defined in: packages/sdk/src/errors/BigshipError.ts:57

Returns

boolean

Inherited from

isValidationError()

isValidationError(): boolean;

Defined in: packages/sdk/src/errors/BigshipError.ts:53

Returns

boolean

Inherited from

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

Defined in: node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

Defined in: node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from