canonical: https://jentic.com/apis/swaggerhub.ferguson-api/api-inventory # Ferguson Api API Inventory API Inventory Ferguson's API Inventory Product for exchanging inventory data with 3rd party companies.   A simple `GET` URI endpoint that has the product **id** as a query path parameter and **locationId** & **regionCode** as query string parameters:
Click to see returned response
If there aren't any products available at that location, the API backend . The API exposes 1 endpoints secured with oauth2 authentication. ## For AI agents Programmatically getinventory. Covers 1 operations with oauth2 authentication. ## Scope Does not handle payments, communications, or crm - use for e-commerce only. ## Capabilities - getInventory - Manage e commerce data programmatically - Integrate API Inventory into automated workflows - Query and filter API Inventory records by parameters - Monitor API Inventory operational status and events ## Use cases ### E-Commerce Operations Use the API Inventory to perform e commerce operations programmatically. The API provides 1 endpoints covering core functionality including getinventory. Example prompt: Call GET /v1/inventories/{id} to getinventory ### Data Retrieval and Monitoring Query API Inventory resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed. Example prompt: Poll the primary API Inventory endpoint, compare response to last known state, and alert if changed ### AI Agent Integration via Jentic AI agents discover and call API Inventory endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle oauth2 tokens manually. Example prompt: Search Jentic for 'getinventory', load the operation schema, and execute with Jentic-managed credentials ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /v1/inventories/{id} | getInventory | ## Key resources - **Product Inventory** — Operations related to Product Inventory ## Why Jentic - **Setup:** Wiring the API Inventory endpoint by hand means running the OAuth 2.0 client credentials exchange against Ferguson's token URL, refreshing the token before it expires, and attaching it to each request yourself. Through Jentic you install once, import API Inventory from the API Directory, store the client credentials once, and your agent calls it. - **Permission scoping:** API Inventory puts the inventory id in the URL path (/v1/inventories/{id}), so a rule can pin your agent to reading a single inventory record and nothing else. You choose the operations it may call, so this read-only lookup is all it can do unless you add more. - **Credential handling:** Your Ferguson client credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'check stock for this inventory id', and Jentic returns the matching API Inventory operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Shopify** — Alternative e commerce API - **Stripe** — Alternative e commerce API ## FAQ ### What authentication does the API Inventory use? The API Inventory uses OAuth 2.0 for authorization. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context. ### Can I getinventory with the API Inventory? Yes. Use the GET /v1/inventories/{id} endpoint. The API returns structured JSON responses that agents can parse and act on directly. ### What are the rate limits for the API Inventory? Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer. ### How do I getinventory through Jentic? Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'getinventory'. Jentic returns the matching API Inventory operation with its input schema. Load the schema and execute the call - credentials are injected automatically. ### How many endpoints does the API Inventory have? The API Inventory exposes 1 endpoints covering product inventory operations. ### Can I limit what my agent is allowed to do with the API Inventory? Yes. API Inventory exposes a single read operation, GET /v1/inventories/{id}, so in your self-hosted Jentic One instance you decide which operations and credentials the agent may use. You can allow only this lookup, keeping the agent read-only and unable to do anything beyond fetching inventory records. Because the inventory id sits in the URL path, your own rules can pin the agent to a single inventory record and block every other call.