canonical: https://jentic.com/apis/swaggerhub.alfah/supplier-order-service-api # Alfah Supplier Order Service API The service goal is order and order information exchange between two systems using standard HTTP(s) technology and the REST approach. The orders producer is ALFAH GmbH as the reseller company (Reseller). The orders consumer is a supplier company (Supplier). When new order is produced by Reseller, the order becomes available for Supplier via the service. The duty of Supplier is checking for new ord. The API exposes 3 endpoints secured with apiKey authentication. ## For AI agents Programmatically get all orders or orders by status id(s), get order by id. Covers 3 operations with apiKey authentication. ## Scope Does not handle payments, communications, or crm - use for e-commerce only. ## Capabilities - Get all orders or orders by status id(s) - Update order for changing its status or for adding shipment info - Integrate Supplier Order Service API into automated workflows - Query and filter Supplier Order Service API records by parameters - Monitor Supplier Order Service API operational status and events ## Use cases ### E-Commerce Operations Use the Supplier Order Service API to perform e commerce operations programmatically. The API provides 3 endpoints covering core functionality including get all orders or orders by status id(s), get order by id, update order for changing its status or for adding shipment info. Example prompt: Call GET /orders to get all orders or orders by status id(s) ### Automated Orders Management Automate orders operations by combining multiple Supplier Order Service API endpoints. Agents can get order by id and then update order for changing its status or for adding shipment info in a single workflow. Example prompt: Call GET `/orders/{order-id}` to get order by id, then verify the result ### AI Agent Integration via Jentic AI agents discover and call Supplier Order Service API 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 apiKey tokens manually. Example prompt: Search Jentic for 'get all orders or orders by status id(s)', load the operation schema, and execute with Jentic-managed credentials ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/orders` | Get all orders or orders by status id(s) | | GET | `/orders/{order-id}` | Get order by id | | PUT | `/orders/{order-id}` | Update order for changing its status or for adding shipment info | ## Key resources - **Orders** — Operations for orders ## Why Jentic - **Setup:** Wiring the Supplier Order Service API by hand means setting up its API key in the Authentication header and calling order list, read, and update operations yourself against the alfah gateway host. Through Jentic you install once, import the Supplier Order Service API from the API Directory, store the API key once, and your agent calls it. - **Permission scoping:** The Supplier Order Service API puts the order id in the URL path (`/orders/{order-id}`), so a rule can pin your agent to one order: it can read that order and nothing else. You choose the operations it may call, so the update operation is not included unless you add it. - **Credential handling:** Your Supplier Order Service API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'get all orders' or 'get orders by status id', and Jentic returns the matching Supplier Order Service API 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 Supplier Order Service API use? The Supplier Order Service API uses an API key passed in the `Authentication` header. 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 get all orders or orders by status id(s) with the Supplier Order Service API? Yes. Use the GET /orders endpoint. The API returns structured JSON responses that agents can parse and act on directly. ### What are the rate limits for the Supplier Order Service API? 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 get all orders or orders by status id(s) through Jentic? Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get all orders or orders by status id(s)'. Jentic returns the matching Supplier Order Service API operation with its input schema. Load the schema and execute the call - credentials are injected automatically. ### How many endpoints does the Supplier Order Service API have? The Supplier Order Service API exposes 3 endpoints covering orders operations. ### Can I limit what my agent is allowed to do with the Supplier Order Service API? Yes. Because you run Jentic One yourself, your own rules decide which of the three operations the agent may call, so you can grant read access through GET /orders and GET `/orders/{order-id}` while withholding the PUT `/orders/{order-id}` update. Since the order id sits in the URL path, a rule can pin the agent to a single order and let it read that one and nothing else. The stored API key is injected only when an operation you allowed is invoked.