Skip to main content
GET
Search Product Lists

Filtering

This endpoint accepts filter and sort query parameters. See Filtering, sorting, and search for paging and for the shared search_with, custom_field, and json_contains filters.

Examples

Operators

The not_has operator applies to related attributes, which this endpoint does not have.

Filter attributes

Each attribute above is also a valid sort key, for example ?sort=-custom_date for descending order.

Search attributes

filter[search] runs one partial match term across name, description, profile.id, profile.first_name, profile.last_name, shares.handle, tags.handle, definition.name, definition.handle, items.variant.sku, items.variant.title, items.variant.barcode, items.variant.description, items.variant.external_id, items.product.name, items.product.title, items.product.description, items.product.tags.handle. A record matches when any one of those attributes contains the term.

Custom field filters

ProductList records carry custom fields, so this endpoint also accepts filter[custom_field][namespace:handle].

Query Parameters

page[size]
string

Response

Array of ProductList

data
ProductList · object[]
required