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

Unofficial Node.js wrapper for the ShipStation API

import type BaseAPI from '../../BaseAPI';
import { BaseResource } from '../../BaseResource';
import type { ListWarehousesResponse, Warehouse } from '../types';
/**
 * [Official Documentation](https://docs.shipstation.com/openapi/warehouses)
 *
 * Get warehouse details like warehouse ID and related addresses using the warehouses endpoint.
 */
export declare class Warehouses extends BaseResource {
    constructor(shipstation: BaseAPI);
    /**
     * [Official Documentation](https://docs.shipstation.com/openapi/warehouses/get_warehouse_by_id)
     *
     * Retrieve warehouse data based on the warehouse ID
     *
     * @param warehouseId [1-25] characters `^se(-[a-z0-9]+)+$`
     *
     * @returns Warehouse details
     */
    getById(warehouseId: string): Promise<Warehouse>;
    /**
     * [Official Documentation](https://docs.shipstation.com/openapi/warehouses/list_warehouses)
     *
     * Retrieve a list of warehouses associated with this account.
     *
     * @returns A list of warehouses
     */
    list(): Promise<ListWarehousesResponse>;
}