Hierarchy

  • ShipmentsAPI

Constructors

Properties

client: AxiosInstance

Methods

  • The cancel method by shipmentId Marks a shipment cancelled, if it is no longer needed or being used by your organization. Any label associated with the shipment needs to be voided first An example use case would be if a batch label creation job is going to run at a set time and only queries pending shipments. Marking a shipment as cancelled would remove it from this process https://shipengine.github.io/shipengine-openapi/#operation/cancel_shipments

    Parameters

    • shipmentId: string

    Returns Promise<AxiosResponse<any, any>>

Generated using TypeDoc