ebay-api/lib/api/restful/sell/logistics/index.js

eBay API for Node and Browser

"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const index_js_1 = __importDefault(require("../../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.
 */
class Logistics extends index_js_1.default {
    get basePath() {
        return '/sell/logistics/v1_beta';
    }
    /**
     * The createShippingQuote method returns a shipping quote that contains a list of live &quot;rates.&quot;
     *
     * @param data The ShippingQuoteRequest
     */
    createShippingQuote(data) {
        return this.post(`/shipping_quote`, data);
    }
    /**
     * 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) {
        shippingQuoteId = encodeURIComponent(shippingQuoteId);
        return this.get(`/shipping_quote/${shippingQuoteId}`);
    }
    /**
     * This method creates a &quot;shipment&quot; based on the shippingQuoteId and rateId values supplied in the request.
     *
     * @param data The CreateShipmentFromQuoteRequest
     */
    createFromShippingQuote(data) {
        return this.post(`/shipment/create_from_shipping_quote`, data);
    }
    /**
     * 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) {
        return this.get(`/shipment/${shipmentId}`);
    }
    /**
     * 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) {
        return this.get(`/shipment/${shipmentId}/download_label_file`);
    }
    /**
     * 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) {
        return this.post(`/shipment/${shipmentId}/cancel`);
    }
}
exports.default = Logistics;
Logistics.id = 'Logistics';