canonical: https://jentic.com/apis/apideck.com/apideck-ecommerce # Apideck Ecommerce API Apideck Ecommerce is a unified API that maps a single schema for orders, products, customers, and stores onto downstream e-commerce platforms such as Shopify, WooCommerce, BigCommerce, and Squarespace Commerce. The 10.14.0 spec is intentionally narrow with 7 operations focused on the highest-leverage objects, so a SaaS app can read orders, look up products, and pull customer records through one integration regardless of which storefront the merchant runs. ## For AI agents Read orders, products, customers, and store metadata across Shopify, WooCommerce, BigCommerce, and other storefronts through one unified schema. ## Scope Does not handle storefront theme editing, checkout creation, or shipping label generation - use for read-side aggregation of orders, products, and customers across storefronts only. ## Capabilities - List and read orders with line items, totals, customer reference, and fulfilment status - List and read products with variants, prices, images, and stock indicators - List and read customer records with consistent contact and address fields - Read store metadata (name, domain, currency, timezone) for the connected storefront - Use cursor-based pagination identically across every supported storefront connector ## Use cases ### Order Ingestion for Analytics Pull orders from a merchant's storefront into a reporting or analytics platform without writing a Shopify, WooCommerce, BigCommerce, and Squarespace adapter. /ecommerce/orders returns a unified order payload with line items, totals, currency, and customer reference, so a single integration covers every supported storefront. Common pattern for FP&A and ad-attribution tools that onboard merchants regardless of platform. Example prompt: GET /ecommerce/orders with cursor pagination and store each order's id, total, currency, and created_at in the analytics warehouse ### Product Catalogue Lookup Look up product details by id across multiple storefronts to enrich a quote, ad, or recommendation. /ecommerce/products returns the unified product payload with variants, prices, images, and stock, so a recommendation engine or affiliate tool gets the same shape regardless of whether the merchant runs Shopify or WooCommerce. Example prompt: GET /ecommerce/products/{id} to fetch the variant prices and stock for a SKU referenced in a recommendation ### Customer Profile Aggregation Aggregate buyer profiles from every storefront a merchant runs into a single dataset for marketing, analytics, or support. /ecommerce/customers returns a unified customer payload, so an ESP or CDP can ingest one record format and segment across the merchant's storefronts. Example prompt: GET /ecommerce/customers to list buyers from each connected storefront and upsert them into the CDP by email ### AI Agent Storefront Reader Give an AI agent a tool to answer questions about a merchant's orders, products, and customers without per-platform adapters. Through Jentic, the agent searches for an intent like 'list recent e-commerce orders' and gets the matching Apideck operation with its input schema. The agent works against Shopify, WooCommerce, or BigCommerce equally. Example prompt: Search Jentic for 'list e-commerce orders', load the /ecommerce/orders schema, and execute with a created_at filter for the last 24 hours ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /ecommerce/orders | List orders on the connected storefront | | GET | /ecommerce/orders/{id} | Read a single order with line items and totals | | GET | /ecommerce/products | List products on the connected storefront | | GET | /ecommerce/products/{id} | Read a single product with variants and stock | | GET | /ecommerce/customers | List buyer profiles on the connected storefront | | GET | /ecommerce/customers/{id} | Read a single customer by id | | GET | /ecommerce/store | Read connected store metadata | ## Key resources - **Orders** — List and read orders with line items, totals, and customer references - **Products** — List and read products with variants, prices, and stock - **Customers** — List and read buyer profiles from the connected storefront - **Stores** — Read connected store metadata (name, domain, currency, timezone) ## Why Jentic - **Setup:** Wiring the Apideck Ecommerce API by hand means setting up its API key plus consumer and service headers, learning the unified order and product shapes, and normalising across storefronts yourself. Through Jentic you install once, import Apideck Ecommerce from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** The Apideck Ecommerce API puts the order, product, and customer id in the URL path (/ecommerce/orders/{id}, /ecommerce/products/{id}), so a rule can pin your agent to reads on one order or product and nothing else. This surface is read-side aggregation, so no storefront writes run regardless of the operations you allow. - **Credential handling:** Your Apideck 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 'read an order' or 'list products across storefronts', and Jentic returns the matching Apideck Ecommerce operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Shopify Admin API** — Native Shopify Admin API for merchants running only on Shopify - **Magento Commerce API** — Native Magento REST API for merchants on Adobe Commerce or open-source Magento - **API2Cart Unified API** — Competing unified e-commerce API across 40+ shopping cart platforms - **Apideck Accounting API** — Apideck Accounting to push orders into the merchant's ledger ## FAQ ### What authentication does the Apideck Ecommerce API use? Apideck requires Authorization with a bearer API key, x-apideck-app-id with your Unify application id, and x-apideck-consumer-id with the end-customer reference stored in Apideck Vault. Through Jentic all three values are stored encrypted in the vault and injected at execution time. ### Which storefronts does the Apideck Ecommerce API cover? Apideck Unify routes Ecommerce calls to connectors including Shopify, WooCommerce, BigCommerce, Squarespace Commerce, Wix Stores, and Magento. Use the x-apideck-service-id header to pin the call to a specific connector when a consumer has more than one connected. ### Can I list orders from a connected storefront with this API? Yes. GET /ecommerce/orders returns the unified order payload with line items, totals, currency, and customer_id. Pagination uses Apideck's cursor model: pass the meta.cursors.next value back as the cursor query parameter to get the next page. ### What are the rate limits for the Apideck Ecommerce API? Apideck enforces limits at both the Unify layer and the underlying connector. Shopify has its own bucket and WooCommerce host-side limits depend on the merchant's hosting, so a /ecommerce/orders call respects the downstream connector's behaviour. Expect ConnectorRateLimitError or HTTP 429 - retry with exponential backoff. ### How do I read a single product through Jentic? Search Jentic for 'fetch e-commerce product by id', load the /ecommerce/products/{id} schema, and execute with the product id. The response returns the unified product object with variants, prices, and stock as Apideck normalised them across connectors. ### Is the Apideck Ecommerce API free? Apideck Unify offers a free tier with capped requests; production use is billed per consumer connection. See https://www.apideck.com/pricing for current tiers. ### Can I limit what my agent is allowed to do with the Apideck Ecommerce API? Yes. Because you run Jentic One yourself, your own rules decide which of the seven Apideck Ecommerce operations your agent may call and which credentials it may use. Since the API puts the order, product, and customer id in the URL path (/ecommerce/orders/{id}, /ecommerce/products/{id}), you can pin the agent to reads on a single order or product and block the list endpoints. This surface is read-side aggregation only, so no storefront writes run no matter which operations you allow.