Search the store's products
readProductsThe products on sale in the store, as Kooga last synced them: search words in the title, brand or category, keep only what is discounted or in stock, and sort by discount, price or stock. Each product has id (Kooga's, for updateListing) and storeId (the store's own, for draftCampaign's productIds and the productKey readTopProducts gives). discountPct is how far the price is under the full price. next gives more. For what sells best, readTopProducts.
Only for a workspace with a store connected: listWorkspaces says which are stores.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | discount puts the deepest discount first; lowest_stock the fewest left | title |
| limit | No | ||
| query | No | Words that each have to appear in the title, brand or category | |
| cursor | No | For the next page: the `next` value the previous page returned. Leave it out for the first page. | |
| onSale | No | Only products priced under their full price | |
| inStock | No | Only products in stock (true) or out of stock (false) | |
| category | No | Part of the category name, such as boots | |
| workspaceId | No | The workspace, as listWorkspaces gives it (its id or slug). Leave it out when this connection reaches one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next | Yes | ||
| total | Yes | How many products match, across every page | |
| products | Yes |