shipstation-node
Version:
Unofficial Node.js wrapper for the ShipStation API
21 lines (20 loc) • 933 B
TypeScript
import type ShipStation from '../../BaseAPI';
import { BaseResource } from '../../BaseResource';
import type { ListFulfillmentsOptions, ListFulfillmentsResponse } from '../types';
export declare class Fulfillments extends BaseResource {
constructor(shipstation: ShipStation);
/**
* [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.
*/
list(params?: ListFulfillmentsOptions): Promise<ListFulfillmentsResponse>;
}