shipstation-node/dist/v2/resources/Labels.d.ts

Unofficial Node.js wrapper for the ShipStation API

import type BaseAPI from '../../BaseAPI';
import { BaseResource } from '../../BaseResource';
import type { CreateReturnLabelOptions, GetLabelByIdOptions, Label, LabelTrackingInfo, ListLabelsOptions, ListLabelsResponse, PurchaseLabelOptions, PurchaseLabelWithIdOptions, VoidLabelResponse } from '../types';
/**
 * [Official Documentation](https://docs.shipstation.com/openapi/labels)
 *
 * Purchase and print shipping labels for any carrier active on your account. The labels endpoint also supports creating
 * return labels, voiding labels, and getting label details like tracking.
 */
export declare class Labels extends BaseResource {
    constructor(shipstation: BaseAPI);
    /**
     * [Official Documentation](https://docs.shipstation.com/openapi/labels/list_labels)
     *
     * This method returns a list of labels that you've created. You can optionally filter the results as well as control
     * their sort order and the number of results returned at a time.
     *
     * By default all labels are returned 25 at a time, starting with the most recently created ones. You can combine
     * multiple filter options to narrow-down the results. For example, if you only want your UPS labels for your east coast
     * warehouse you could query by both `warehouse_id` and `carrier_id`.
     *
     * @param options Options for the list request
     *
     * @returns A `labels` array containing a page of results (as determined by the `page_size` query parameter). It also
     * includes other useful information, such as the total number of labels that match the query criteria, the number of
     * pages of results, and the URLs of the first, last, next, and previous pages of results.
     */
    list(options: ListLabelsOptions): Promise<ListLabelsResponse>;
    /**
     * [Official Documentation](https://docs.shipstation.com/openapi/labels/get_label_by_id)
     *
     * Retrieve a specific label by its label id.
     *
     * @param labelId The ID of the label to get [1-25] characters `^se(-[a-z0-9]+)+$`
     * @example "se-28529731"
     *
     * @param options Options for the get request
     *
     * @returns The label specified by the label id.
     */
    getById(labelId: string, options?: GetLabelByIdOptions): Promise<Label>;
    /**
     * [Official Documentation](https://docs.shipstation.com/openapi/labels/get_tracking_log_from_label)
     *
     * Retrieve the label's tracking details.
     *
     * @param labelId The ID of the label to get [1-25] characters `^se(-[a-z0-9]+)+$`
     * @example "se-28529731"
     *
     * @returns The label specified by the tracking number.
     */
    getTrackingInfo(labelId: string): Promise<LabelTrackingInfo>;
    /**
     * [Official Documentation](https://docs.shipstation.com/openapi/labels/void_label)
     *
     * Void a specific label using its label id. For labels that are paid for at time of label creation, this will also
     * request a refund from the carrier.
     *
     * @param labelId The ID of the label to void [1-25] characters `^se(-[a-z0-9]+)+$`
     * @example "se-28529731"
     *
     * @returns The status of the void operation.
     */
    void(labelId: string): Promise<VoidLabelResponse>;
    /**
     * [Official Documentation](https://docs.shipstation.com/openapi/labels/create_label)
     *
     * Purchase and print a label for shipment.
     *
     * @param data The data for the purchase request
     *
     * @returns The newly purchased label.
     */
    purchase(data: PurchaseLabelOptions): Promise<Label>;
    /**
     * [Official Documentation](https://docs.shipstation.com/openapi/labels/create_label_from_rate)
     *
     * When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id`
     * property that can be used to generate a label without having to refill in the shipment information repeatedly.
     *
     * @param rateId Rate ID [1-25] characters `^se(-[a-z0-9]+)+$`
     * @example "se-28529731"
     *
     * @param options Options for the purchase request
     *
     * @returns The newly purchased label.
     */
    purchaseWithRateId(rateId: string, options?: PurchaseLabelWithIdOptions): Promise<Label>;
    /**
     * [Official Documentation](https://docs.shipstation.com/openapi/labels/create_label_from_shipment)
     *
     * Purchase a label using a shipment ID that has already been created with the desired address and package info.
     *
     * @param shipmentId Shipment ID [1-25] characters `^se(-[a-z0-9]+)+$`
     * @example "se-28529731"
     *
     * @param options Options for the purchase request
     *
     * @returns The newly purchased label.
     */
    purchaseWithShipmentId(shipmentId: string, options?: PurchaseLabelWithIdOptions): Promise<Label>;
    /**
     * [Official Documentation](https://docs.shipstation.com/openapi/labels/create_return_label)
     *
     * Create a return label for a previously created outbound label. The return label will automatically swap the ship to
     * and ship from addresses from the original label.
     *
     * @param labelId Label ID [1-25] characters `^se(-[a-z0-9]+)+$`
     * @example "se-28529731"
     *
     * @param options Options for the purchase request
     *
     * @returns The newly purchased label.
     */
    createReturnLabel(labelId: string, options?: CreateReturnLabelOptions): Promise<Label>;
}