shopify-admin-api/dist/types/services/locations.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 { Location } from '../interfaces';
import { BaseService } from '../infrastructure';
/**
 * A service for manipulating a shops Locations API.
 */
export declare class Locations extends BaseService {
    constructor(shopDomain: string, accessToken: string);
    /**
     * Gets a location with the given id.
     * @param id Id of the location being retrieved.
     * @param options Options for filtering the result.
     */
    get(id: number, options?: Options.FieldOptions): Promise<Location>;
    /**
     * Lists up to 250 locations.
     * @param options Options for filtering the results.
     */
    list(options?: Options.FieldOptions): Promise<Location[]>;
    /**
     * Counts the amount of locations.
     */
    count(): Promise<number>;
    /**
     * Lists all the inventory levels on a location.
     */
    inventoryLevels(locationId: number): Promise<Location>;
}
export default Locations;