This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of up to 100 products, given the provided filtering, sorting, and cursor paging.
Pass supported values to the fields
array in the request to include those fields in the response.
To learn about working with Query endpoints, see API Query Language, and Sorting and Paging.
Note: To retrieve a non-visible product (visible: false
), your app must have the required SCOPE.STORES.PRODUCT_READ_ADMIN
permission scope.
PROPERTY | SUPPORTED FILTERS & SORTING |
---|---|
_id | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() |
_createdDate | eq() ,ne() ,exists() ,in() ,hasSome() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |
_updatedDate | eq() ,ne() ,exists() ,in() ,hasSome() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |
slug | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() |
visible | eq() ,ne() ,exists() ,in() ,hasSome() ,ascending() ,descending() |
options.id | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() |
handle | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() |