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

Unofficial Node.js wrapper for the ShipStation API

import type BaseAPI from '../../BaseAPI';
import { BaseResource } from '../../BaseResource';
import type { EstimateRatesOptions, EstimateRatesResponse, GetRatesOptions, GetRatesResponse, Rate } from '../types';
/**
 * [Official Documentation](https://docs.shipstation.com/openapi/rates)
 *
 * Quickly compare rates using the Rates endpoint. You can see and compare rates for the carriers connected to your
 * account (as long as they support sending rates).
 */
export declare class Rates extends BaseResource {
    constructor(shipstation: BaseAPI);
    /**
     * [Official Documentation](https://docs.shipstation.com/openapi/rates/get_rate_by_id)
     *
     * Retrieve a previously queried rate by its ID
     *
     * @param rateId Rate ID [1-25] characters `^se(-[a-z0-9]+)+$`
     * @example "se-28529731"
     *
     * @returns The rate specified by the ID
     */
    getById(rateId: string): Promise<Rate>;
    /**
     * [Official Documentation](https://docs.shipstation.com/openapi/rates/calculate_rates)
     *
     * It's not uncommon that you want to give your customer the choice between whether they want to ship the fastest,
     * cheapest, or the most trusted route. Most companies don't solely ship things using a single shipping option; so we
     * provide functionality to show you all your options!
     *
     * @param options The options for the request
     *
     * @returns
     */
    get(options: GetRatesOptions): Promise<GetRatesResponse>;
    /**
     * [Official Documentation](https://docs.shipstation.com/openapi/rates/estimate_rates)
     *
     * Get Rate Estimates
     *
     * @param options The options for the request
     *
     * @returns A list of rate estimates
     */
    estimate(options: EstimateRatesOptions): Promise<EstimateRatesResponse>;
}