ghl_product_list
Retrieve a paginated list of products for a location, with optional filters by name, category, or store availability.
Instructions
Lists products for a location. (Generated tool name was originally 'ghl_product_list_invoices' — an evident copy-paste artifact unrelated to this operation; corrected here.) List Products The "List Products" API allows to retrieve a paginated list of products. Customize your results by filtering products based on name or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve product information. Endpoint: GET /products/ (Version header: v3; source: v3/products-v3.json) OAuth scopes: products.readonly Pagination params: limit, offset — pass them to page through full result sets.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of items to be included in a single page of results | |
| expand | No | Name of an entity whose data has to be fetched along with product. Possible entities are tax, stripe and paypal. If not mentioned, only ID will be returned in case of taxes | |
| offset | No | The starting index of the page, indicating the position from which the results should be retrieved. | |
| search | No | The name of the product for searching. | |
| storeId | No | fetch and project products based on the storeId | |
| sortOrder | No | The order of sort which should be applied for the date | |
| locationId | Yes | LocationId is the id of the sub-account | |
| productIds | No | List of product ids to be fetched. | |
| collectionIds | No | Filter by product category Ids. Supports comma separated values | |
| collectionSlug | No | The slug value of the collection by which the collection would be searched | |
| includedInStore | No | Separate products by which are included in the store and which are not | |
| availableInStore | No | If the product is included in the online store |