ghl_product_inventory_list
Retrieve a paginated list of inventory items with search and pagination parameters to fetch details for multiple products in a location.
Instructions
List Inventory The "List Inventory API allows the user to retrieve a paginated list of inventory items. Use this endpoint to fetch details for multiple items in the inventory based on the provided query parameters. Endpoint: GET /products/inventory (Version header: v3; source: v3/products-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: products/prices.readonly Pagination params: limit, offset — pass them to page through full result sets.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"altId": "<altId>",
"altType": "<altType>"
},
"name": "ghl_product_inventory_list"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| altId | Yes | Location Id or Agency Id | |
| limit | No | The maximum number of items to be included in a single page of results | |
| offset | No | The starting index of the page, indicating the position from which the results should be retrieved. | |
| search | No | Search string for Variant Search | |
| altType | Yes |