shipstation-node/dist/v1/resources/Fulfillments.js

Unofficial Node.js wrapper for the ShipStation API

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Fulfillments = void 0;
const BaseResource_1 = require("../../BaseResource");
class Fulfillments extends BaseResource_1.BaseResource {
    constructor(shipstation) {
        super(shipstation, 'fulfillments');
    }
    /**
     * [Official Documentation](https://www.shipstation.com/docs/api/fulfillments/list-fulfillments/)
     *
     * The List Fulfillments API call obtains a list of fulfillments that match the specified criteria.
     *
     * NOTE: Orders that have been
     * [marked as shipped](https://www.shipstation.com/docs/api/orders/mark-as-shipped/) either through the UI or the API
     * will appear in the response as they are considered fulfillments.
     *
     * @param params The parameters for the request.
     *
     * @returns A list of fulfillments.
     */
    async list(params) {
        return this.shipstation.request({
            url: this.baseUrl,
            method: 'GET',
            params
        });
    }
}
exports.Fulfillments = Fulfillments;