Product Tools
Two tools answer questions about the catalog: finding a product, and reading one in full.
| Tool | What it answers |
|---|---|
search_products | Products you don’t have in hand. |
get_product | One product in full. |
Finding a Product
search_products matches the beginning of a SKU and any part of a name, and matches a UPC in full. It also filters by type, brand, supplier, and whether a product has been archived. Every result carries its price and how many are in stock and available, so a browsing question is answered without a second call.
- “Which products do we buy from Acme?”
- “What do we carry under the Northwind brand?”
- “Find everything with sunrise in the name.”
- “How many active products do we have?”
Reading One
get_product answers what a product is: SKU and UPC, name and description, type and brand, what it sells for and what it costs, weight and measurements, how many are in stock, available, allocated, and already ordered, who it is bought from, and, when it is a bundle, which products it is made of.
- “What’s available to sell in SKU ABC-100 versus what’s already allocated?”
- “What’s in the Starter Kit bundle?”
- “What do we pay for ABC-100, and who do we buy it from?”
Stock Now Against Stock Over Time
These two tools answer what a product has in stock right now. For a stock position across a warehouse, a date in the past, or a trend, use the inventory tools in Analytics.
Use this page’s tools when the subject of the question is a product. Use the analytics tools when the subject is the position itself.
Related Records
A product includes its supplier id. Use it to find everything else bought from that supplier. To see who changed a price or why a stock level moved, use the product id with get_timeline. To find the orders a product was sold on, search by its SKU with search_orders.