Interface InventoryListParams

Parameters for listing inventory items

interface InventoryListParams {
    created_on_max?: string;
    created_on_min?: string;
    fields?: string[];
    limit?: number;
    location_id?: number;
    page?: number;
    product_id?: number;
    sku?: string;
    tracked?: boolean;
    updated_on_max?: string;
    updated_on_min?: string;
    variant_id?: number;
}

Hierarchy (view full)

Properties

created_on_max? created_on_min? fields? limit? location_id? page? product_id? sku? tracked? updated_on_max? updated_on_min? variant_id?

Properties

Optional created_on_max

created_on_max?: string

Filter by created date (end). ISO 8601 format: '2025-01-01T00:00:00Z'

Optional created_on_min

created_on_min?: string

Filter by created date (start). ISO 8601 format: '2025-01-01T00:00:00Z'

Optional fields

fields?: string[]

Fields to include in the response. Use comma-separated values: 'id,name,created_on'

Optional limit

limit?: number

Number of items per page. Maximum value varies by endpoint.

Optional location_id

location_id?: number

Filter by location ID

Optional page

page?: number

Page number (1-based).

Optional product_id

product_id?: number

Filter by product ID

Optional sku

sku?: string

Filter by SKU

Optional tracked

tracked?: boolean

Filter by tracking status

Optional updated_on_max

updated_on_max?: string

Filter by update date range end

Optional updated_on_min

updated_on_min?: string

Filter by update date range start

Optional variant_id

variant_id?: number

Filter by variant ID

Settings

Member Visibility

Theme

On This Page

created_on_maxcreated_on_minfieldslimitlocation_idpageproduct_idskutrackedupdated_on_maxupdated_on_minvariant_id