canonical: https://jentic.com/apis/dfshop.com/dfshop # DfShop API Jentic publishes the only available OpenAPI specification for DfShop API, keeping it validated and agent-ready. The DfShop API manages an online store's product catalog, inventory, and orders. It lists and retrieves products, exports the catalog as CSV, generates a Google Shopping feed, reports inventory levels per product, and lists, creates, retrieves, and updates orders. ## For AI agents Manage a DfShop store's product catalog, inventory levels, and orders: list and retrieve products, export catalog feeds, check stock, and create or update orders. ## Scope Does not handle payment processing, shipping label generation, or customer accounts. Use for managing a DfShop store's products, inventory, and orders only. ## Capabilities - List the products in a DfShop store and retrieve a single product by id - Export the product catalog as a CSV file - Generate a Google Shopping feed from the catalog - Check inventory levels across the catalog or for a specific product - List orders and retrieve a single order by id - Create a new order and update an existing order ## Use cases ### Agent-Managed Order Processing An AI agent running a store's back office can list new orders, retrieve a specific order's details, and update its status through the DfShop API. Paired with the product and inventory reads, the agent can confirm stock before accepting an order and keep order records current. Example prompt: List recent orders, retrieve one order by its id, and update it to a fulfilled state ### Product Catalog and Google Feed Sync Merchandising tools can pull the full product catalog as JSON or CSV and generate a Google Shopping feed directly from the DfShop API. This keeps external channels and spreadsheets in sync with the store's current products without manual exports. Example prompt: Export the product catalog as CSV and generate the Google Shopping feed for the store ### Inventory Availability Checks Order and fulfillment logic can query inventory levels for the whole catalog or a single product before promising availability. The DfShop API returns inventory data per product so an agent can avoid overselling an out-of-stock item. Example prompt: Check the inventory data for a specific product id and report whether it is in stock ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/v1/products` | List all products | | GET | `/v1/products/{product_id}` | Retrieve a product | | GET | `/v1/inventory` | List inventory data | | GET | `/v1/inventory/{product_id}` | Get inventory data for a specific product | | GET | `/v1/orders` | List all orders | | POST | `/v1/orders` | Create an order | | GET | `/v1/orders/{order_id}` | Retrieve an order | | PUT | `/v1/orders/{order_id}` | Update an order | ## Key resources - **Products** — List and retrieve products, export the catalog as CSV, and generate a Google Shopping feed - **Inventory** — List inventory data for the catalog or retrieve stock for a specific product - **Orders** — List, create, retrieve, and update orders ## AI readiness This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use. - **Score:** 59 / 100 - **Maturity:** Foundational - **Dimensions:** - Foundational Compliance: 99 / 100 - Developer Experience & Jentic Compatibility: 72 / 100 - AI-Readiness & Agent Experience: 44 / 100 - Agent Usability: 94 / 100 - Security: 33 / 100 - AI Discoverability: 64 / 100 - **View full report:** https://jentic.com/apis/dfshop.com/dfshop/scorecard - **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/ - **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview ### Score it yourself Every API in the directory is allowlisted, so you can re-score it with no key required. - **Score your own API:** https://jentic.com/scorecard.md - **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md ```sh npx @jentic/api-scorecard-cli score ``` ## Why Jentic - **Setup:** Wiring the DfShop API by hand means managing its API token, deciding whether to send it as the X-DfApi-Token header or the token query parameter, and handling product, inventory, and order calls separately. Through Jentic you install once, import the DfShop API from the API Directory, store the token once, and your agent calls it. - **Permission scoping:** DfShop puts the product and order ids in the URL path, such as `/v1/orders/{order_id}`, so a rule can scope your agent to specific orders or products. You choose which operations it may call, so read-only operations like listing products and inventory can be allowed while order creation and updates stay out unless you add them. - **Credential handling:** Your DfShop API 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 'list products in my shop' or 'create an order', and Jentic returns the matching DfShop operation with its input schema so the agent calls the right endpoint without reading the reference docs. ## Related APIs - **Shopify** — Shopify is a full e-commerce platform API, while the DfShop API covers a focused products, inventory, and orders surface. - **Ecwid** — Ecwid is another hosted store API with product and order management comparable to the DfShop API. - **ShipStation** — ShipStation handles shipping and fulfillment for orders the DfShop API creates and lists. ## FAQ ### Why is there no official OpenAPI spec for DfShop API? DfShop does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call DfShop API via structured tooling. It is validated against the live API and kept up to date. To run it on your own infrastructure, install Jentic One from its GitHub repo. ### What authentication does the DfShop API use? The DfShop API authenticates with an API key, which you can send either in the `X-DfApi-Token` header or as a `token` query parameter, per its OpenAPI spec. Through Jentic the key is stored encrypted by your own Jentic One instance and injected at call time, so it never enters the agent's prompt or logs. ### Can I create and update orders with the DfShop API? Yes. The DfShop API lists orders, retrieves a single order by its id, creates a new order, and updates an existing one. You can read product and inventory data alongside orders to confirm availability before an order is placed. ### What are the rate limits for the DfShop API? The OpenAPI spec does not specify rate limits for the DfShop API. Check the provider's documentation at https://dfshop.com for the current limits that apply to your token. ### Can I limit what my agent is allowed to do with the DfShop API? Yes. Order and product ids travel in the URL path, so a rule can scope your agent to specific orders or products. Write a rule that allows only the read operations, such as listing products and checking inventory, and leave order creation and updates out unless the agent needs them, and every call it makes is logged. ### How do I process orders with the DfShop API through Jentic? Search Jentic for 'create an order in my shop' and it returns the DfShop create-order operation with its input schema. Import the DfShop API from the Jentic API Directory, store your API token once, and your agent can list, create, and update orders without hand-wiring the token on each request. ### Is there a DfShop API MCP server? You don't need an MCP server to give your agent the DfShop API. Jentic connects it directly from the API Directory: import it, store your token once, and your agent calls the product, inventory, and order operations. Nothing extra loads into the agent's context until an operation is actually used.