Interface CollectionListParams

Parameters for listing collections

interface CollectionListParams {
    collection_type?: CollectionType;
    created_on_max?: string;
    created_on_min?: string;
    fields?: string[];
    handle?: string;
    limit?: number;
    page?: number;
    product_id?: number;
    published?: boolean;
    title?: string;
    updated_on_max?: string;
    updated_on_min?: string;
}

Hierarchy (view full)

Properties

collection_type? created_on_max? created_on_min? fields? handle? limit? page? product_id? published? title? updated_on_max? updated_on_min?

Properties

Optional collection_type

collection_type?: CollectionType

Filter by collection type

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 handle

handle?: string

Filter by handle

Optional limit

limit?: number

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

Optional page

page?: number

Page number (1-based).

Optional product_id

product_id?: number

Filter by product ID

Optional published

published?: boolean

Filter by published status

Optional title

title?: string

Filter by title

Optional updated_on_max

updated_on_max?: string

Filter by updated date range end

Optional updated_on_min

updated_on_min?: string

Filter by updated date range start

Settings

Member Visibility

Theme

On This Page

collection_typecreated_on_maxcreated_on_minfieldshandlelimitpageproduct_idpublishedtitleupdated_on_maxupdated_on_min