canonical: https://jentic.com/apis/ordavia.com/ordavia # Ordavia API The Ordavia API exposes the order, product, and webhook surface that Ordavia uses to power its Zapier integration. It targets e-commerce operators who want to push order events, status changes, and low-stock alerts from Ordavia into other tools without using Zapier itself. The API is Bearer-authenticated and intentionally narrow - six endpoints covering authentication test, order and product triggers, and webhook subscribe and unsubscribe. ## For AI agents Subscribe to Ordavia order, status, and low-stock webhooks and verify Bearer authentication via the Zapier-shaped REST surface. ## Scope Does not handle order creation, fulfillment, or product catalog management - use for Ordavia auth verification and webhook subscription only. ## Capabilities - Verify Bearer authentication against the Ordavia API - Subscribe a webhook for new orders created in Ordavia - Subscribe a webhook for order status changes - Subscribe a webhook for low-stock alerts on products - Register a webhook subscription against a target URL - Unsubscribe a previously registered webhook ## Use cases ### New Order Forwarding to Internal Tools Forward new Ordavia orders into an internal fulfillment tool or messaging channel by subscribing a webhook to the new-orders trigger. The integration registers a target URL through `/api/zapier/webhooks/subscribe` and Ordavia delivers a JSON payload for each new order, removing the need to poll for changes. Example prompt: POST `/api/zapier/webhooks/subscribe` with the orders/new event and a target URL ### Order Status Change Workflow Drive downstream workflows whenever an Ordavia order changes status - shipped, delivered, cancelled - by subscribing to the status-changed trigger. The webhook payload identifies the order and the new status so the downstream system can update the customer record without a separate API lookup. Example prompt: POST `/api/zapier/webhooks/subscribe` with the orders/status-changed event and handle each status update downstream ### Low-Stock Alerting Outside Ordavia Send low-stock alerts from Ordavia into a Slack channel, an inventory dashboard, or a procurement tool by subscribing to the low-stock products trigger. The webhook fires whenever a product crosses the configured threshold, so the operations team can act without watching the Ordavia UI. Example prompt: POST `/api/zapier/webhooks/subscribe` with the products/low-stock event and forward alerts to a Slack channel ### Agent-Driven Ordavia Webhook Setup via Jentic An AI assistant for e-commerce operators can verify their Ordavia token and register the right webhooks in one workflow. Through Jentic the agent maps natural-language intents like 'send me low-stock alerts from Ordavia' to the matching subscribe endpoint without holding the Bearer token in the model context. Example prompt: Search Jentic for 'subscribe to Ordavia order events', load POST `/api/zapier/webhooks/subscribe`, and execute ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/api/zapier/auth/test` | Verify Bearer authentication | | GET | `/api/zapier/triggers/orders/new` | Trigger for new orders | | GET | `/api/zapier/triggers/orders/status-changed` | Trigger for order status changes | | GET | `/api/zapier/triggers/products/low-stock` | Trigger for low-stock products | | POST | `/api/zapier/webhooks/subscribe` | Subscribe a webhook | | POST | `/api/zapier/webhooks/unsubscribe` | Unsubscribe a webhook | ## Key resources - **Authentication** — Token verification endpoint - **Orders** — Order-related triggers (new, status changed) - **Products** — Product-related triggers (low stock) - **Webhooks** — Subscribe and unsubscribe webhook subscriptions ## Why Jentic - **Setup:** Wiring the Ordavia API by hand means setting up its bearer auth and building the Zapier-style webhook subscribe and unsubscribe flow yourself. Through Jentic you install once, import Ordavia from the API Directory, store the token once, and your agent calls it. - **Permission scoping:** You choose which Ordavia operations the agent may call, so you can limit it to the operations it needs, such as testing auth and reading order and low-stock triggers, while webhook subscribe and unsubscribe stay out of the allowed set unless you add them. - **Credential handling:** Your Ordavia bearer token 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 'subscribe to Ordavia order events' or 'verify my Ordavia token', and Jentic returns the matching trigger or webhook operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Shopify Admin API** — Full e-commerce platform with deep order, product, and inventory APIs rather than a Zapier-shaped trigger surface - **ShipStation API** — Shipping and fulfillment platform commonly paired with Ordavia for label generation and tracking - **Zapier NLA API** — General workflow automation often used as the consumer of Ordavia's trigger surface ## FAQ ### What authentication does the Ordavia API use? HTTP Bearer authentication. Use GET `/api/zapier/auth/test` to confirm the token is valid before subscribing webhooks. Through Jentic the Bearer token is stored encrypted in the vault and the agent only sees a scoped session, never the raw token. ### What events can I subscribe webhooks to? Three triggers are available: orders/new for newly created orders, orders/status-changed for status transitions, and products/low-stock for products dipping below their threshold. Subscribe by POSTing to `/api/zapier/webhooks/subscribe` with the event name and target URL. ### How do I unsubscribe a webhook I no longer need? POST `/api/zapier/webhooks/unsubscribe` with the subscription you want removed. Once unsubscribed, Ordavia stops delivering events to that target URL - useful when retiring a downstream integration without removing the credential. ### Why do the paths sit under `/api/zapier`? The current REST surface mirrors Ordavia's Zapier integration shape - auth test, triggers, and subscribe/unsubscribe - so consumers can reuse the same trigger semantics outside Zapier. There is no separate non-Zapier path in this version of the spec. ### How do I subscribe to new Ordavia orders through Jentic? Install the SDK with pip install jentic, then search for 'subscribe to new Ordavia orders'. Jentic returns the POST `/api/zapier/webhooks/subscribe` operation; load it, supply the orders/new event and the target URL, and execute. Run it through Jentic One, the self-hosted execution layer. ### Can I limit what my agent is allowed to do with the Ordavia API? Yes. Because you run Jentic One yourself, your own rules decide which Ordavia operations and credentials the agent may use, so you choose exactly which of the six endpoints it can call. You might allow only read operations such as the auth test, the new-order trigger, the status-changed trigger, and the low-stock trigger, while keeping the webhook subscribe and unsubscribe operations out of the allowed set unless you explicitly add them. Your Ordavia bearer token is injected at execution time and never enters the agent's prompt or context.