inventora-shopify-admin-api/dist/services/inventory_items.d.ts

Shopify Admin API is a NodeJS library built to help developers easily authenticate and make calls against the Shopify API. It was inspired by and borrows heavily from ShopifySharp.

import * as Options from '../options';
import { BaseService } from '../infrastructure';
import { InventoryItem } from '../interfaces';
/**
 * A service for manipulating Shopify's InventoryItems API.
 */
export declare class InventoryItems extends BaseService {
    constructor(shopDomain: string, accessToken: string);
    /**
     * Gets a inventory item with the given id.
     * @param id Id of the inventory item being retrieved.
     * @param options Options for filtering the result.
     */
    get(id: number, options?: Options.FieldOptions): Promise<Location>;
    /**
     * Gets a list of up to 250 of the shop's inventory items.
     * @param options Options for filtering the result.
     */
    list(options: Options.InventoryItemListOptions): Promise<InventoryItem[]>;
    /**
     * Updates an inventory item with the given id.
     * @param id The inventory items's id.
     * @param inventoryItem The updated inventory item.
     */
    update(id: number, inventoryItem: Partial<InventoryItem>): Promise<InventoryItem>;
}
export default InventoryItems;