ebay-api/lib/api/restful/sell/logistics/index.d.ts

eBay API for Node and Browser

import Restful from '../../index.js';
/**
 * The <b>Logistics API</b> resources offer the following capabilities: <ul><li><b>shipping_quote</b> &ndash; Consolidates into a list a set of live shipping rates, or quotes, from which you can select a rate to ship a package.
 */
export default class Logistics extends Restful {
    static id: string;
    get basePath(): string;
    /**
     * The createShippingQuote method returns a shipping quote that contains a list of live &quot;rates.&quot;
     *
     * @param data The ShippingQuoteRequest
     */
    createShippingQuote(data: any): Promise<any>;
    /**
     * This method retrieves the complete details of the shipping quote associated with the specified shippingQuoteId value.
     *
     * @param shippingQuoteId This path parameter specifies the unique eBay-assigned ID of the shipping quote you want to retrieve.
     */
    getShippingQuote(shippingQuoteId: string): Promise<any>;
    /**
     * This method creates a &quot;shipment&quot; based on the shippingQuoteId and rateId values supplied in the request.
     *
     * @param data The CreateShipmentFromQuoteRequest
     */
    createFromShippingQuote(data: any): Promise<any>;
    /**
     * This method retrieves the shipment details for the specified shipment ID.
     *
     * @param shipmentId This path parameter specifies the unique eBay-assigned ID of the shipment you want to retrieve.
     */
    getShipment(shipmentId: any): Promise<any>;
    /**
     * This method returns the shipping label file that was generated for the shipmentId value specified in the request.
     *
     * @param shipmentId This path parameter specifies the unique eBay-assigned ID of the shipment associated with the shipping label you want to download.
     */
    downloadLabelFile(shipmentId: any): Promise<any>;
    /**
     * This method cancels the shipment associated with the specified shipment ID and the associated shipping label is deleted.
     *
     * @param shipmentId This path parameter specifies the unique eBay-assigned ID of the shipment to be canceled.
     */
    cancelShipment(shipmentId: any): Promise<any>;
}