shipstation-node
Version:
Unofficial Node.js wrapper for the ShipStation API
24 lines (23 loc) • 936 B
TypeScript
import type BaseAPI from '../../BaseAPI';
import { BaseResource } from '../../BaseResource';
import type { CarrierCode } from '../types';
/**
* [Official Documentation](https://docs.shipstation.com/openapi/tracking)
*
* Use the tracking endpoint to stop receiving tracking updates (more dedicated tracking endpoint methods coming soon).
*/
export declare class Tracking extends BaseResource {
constructor(shipstation: BaseAPI);
/**
* [Official Documentation](https://docs.shipstation.com/openapi/tracking/stop_tracking)
*
* Unsubscribe from tracking updates for a package.
*
* @param carrierCode A shipping carrier, such as fedex, dhl_express, stamps_com, etc.
* @example "stamps_com"
*
* @param trackingNumber The tracking number associated with a shipment
* @example "9405511899223197428490"
*/
stop(carrierCode: CarrierCode, trackingNumber: string): Promise<void>;
}