Jentic OSThe workplace. An in-house AI platform for every employeeJentic OneSafe access. Agents reach your systems without holding keysJentic AIRThe foundation. Gets your existing platforms ready for AI
Pricing

GET STARTED

API DirectoryBrowse 10,000+ APIs ready for AI agent integrationDocumentationGuides and API reference

TOOLS

API ScoringCheck your AI readiness using our scorecardArazzo UIVisualize Arazzo workflows as interactive documentationArazzo EditorBuild and edit multi-step API workflows visually

COMMUNITY

GitHubOpen source projects and examplesOpen StandardsBuilt on open specs. Never locked in.
All ResourcesEverything in one placeBlogLatest articles and insightsTech Talk NewsletterAPIs, AI agents, architecture and strategyWebinarsLive sessions and on-demand recordingsReports & WhitepapersOriginal research on enterprise AI
About UsOur mission and teamCareersJoin our teamContactGet in touch
Try it now
Jentic OSJentic OneJentic AIR
Pricing
API DirectoryDocumentationAPI ScoringArazzo UIArazzo EditorGitHubOpen Standards
All ResourcesBlogTech Talk NewsletterWebinarsReports & Whitepapers
About UsCareersContact
Try it now
JenticJentic
Products
  • Jentic OS
  • Jentic One
  • Jentic AIR
For Developers
  • API Directory
  • Documentation
  • GitHub
Company
  • About Jentic
  • Careers
  • Contact Us
  • Trust Centre
ISO/IEC 27001:2022 certification badge issued by Prescient SecurityISO/IEC 27001:2022 certification badge issued by Prescient Security

Information Security Management System

Certified to ISO/IEC 27001:2022 by Prescient Security

AICPA SOC for Service Organizations logoAICPA SOC for Service Organizations logo

SOC 2® Type 1 report

Audited by Prescient Assurance

Terms & Conditions•Privacy Policy•
© 2026 Jentic Technology Ltd. All rights reserved.
2 Grattan Court East, Dublin, D02 VX86, Ireland
Switch to light modeSwitch to dark mode
APIs / E Commerce / Apideck / Ecommerce API
Ecommerce API logo

Apideck Ecommerce API

Browse all Apideck APIs
63
AI ReadinessAI-Aware (B-)63/100
See full scorecard
Official vendor OpenAPI document · agent-readyE CommerceStorefrontapiKey7 EndpointsREST

For Agents

Read orders, products, customers, and store metadata across Shopify, WooCommerce, BigCommerce, and other storefronts through one unified schema.

Use for: List recent orders from the connected storefront, Find an order by id and read its line items, List products in the connected storefront with current prices, Get a single product by id with variants and stock

Not supported: 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.

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.

Jentic One on GithubView OpenAPI Document

Install Jentic One Beta

Connect the Ecommerce API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Ecommerce API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

1

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fapideck.com%2Fapideck-ecommerce" | sh
2

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fapideck.com%2Fapideck-ecommerce" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Ecommerce API.

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

Patterns agents use Ecommerce API for, with concrete tasks.

★ 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.

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.

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.

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.

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

7 endpoints — 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.

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

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

Jentic AI Readiness Score

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.

E

Ecommerce API

- AI-Aware (B-)
63/100
52
Foundational Compliance
86
Developer Experience & Jentic Compatibility
57
AI-Readiness & Agent Experience
94
Agent Usability
50
Security
50
AI Discoverability
Powered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
52

Foundational Compliance

Base layer of spec validity and structural soundness.

Grade: C-Signals: 4
96%

Lint Results

Aggregated quality score from linter diagnostics, weighted by severity.

100%

Resolution Completeness

Percentage of `$ref` references that resolve successfully.

0%

Specification Validity

Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).

14%

Structural Integrity

Structural correctness score based on schema issues using logarithmic dampening.

86

Developer Experience & Jentic Compatibility

Clarity, completeness, and ingestion readiness for developers and tooling.

Grade: ASignals: 4
69%

Example Density

How richly the API is illustrated with examples.

100%

Example Validity

Percentage of examples that conform to their schemas.

75%

Response Coverage

Percentage of operations with complete response definitions (success, client error, server error).

100%

Tooling Readiness

Health of API ingestion, bundling, and resolution within Jentic pipelines.

57

AI-Readiness & Agent Experience

Semantic breadth, depth, and agent comprehension for AI systems.

Grade: CSignals: 4
76%

Description Coverage

Coverage of descriptions across API elements.

0%

Error Standardization

Coverage of RFC 9457 Problem Details for error responses.

100%

OperationId Quality

Coverage, uniqueness, and casing consistency of operationIds for AI inference.

50%

Summary Coverage

Coverage of summaries across operations/tags/info.

94

Agent Usability

Functional utility, complexity comfort, and AI orchestration readiness.

Grade: A+Signals: 1
94%

Complexity Comfort

Agent comfort level based on API operational and structural complexity.

50

Security

Trust, risk posture, and security compliance.

Grade: C-Signals: 1
50%

Authentication Strength

Average quality of security schemes based on authentication method strength (weakest link for OAuth2).

50

AI Discoverability

Findability, semantic richness, and reasoning readiness.

Grade: C-Signals: 1
50%

Descriptive Richness

Clarity and depth of descriptions across API elements.

View full reportHow the score is calculatedMore about the dimensions

Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

Score your own APIScoring CLI agent skill
npx @jentic/api-scorecard-cli score <openapi-url>

Why Jentic?

What agents get from Jentic-routed access to this vendor.

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 isolation

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.

Intent-based discovery

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

Alternatives and complements available in the Jentic catalogue.

Alternative

Shopify Admin API

→

Native Shopify Admin API for merchants running only on Shopify

Choose Shopify directly when the agent only operates on Shopify and needs Shopify-specific features (Functions, Markets, Hydrogen) the unified API does not surface

Alternative

Magento Commerce API

→

Native Magento REST API for merchants on Adobe Commerce or open-source Magento

Choose Magento directly when the agent only operates on Magento and needs catalog rules or native promotions the unified API does not expose

Alternative

API2Cart Unified API

→

Competing unified e-commerce API across 40+ shopping cart platforms

Choose API2Cart for broader cart platform coverage (40+ vs ~6) and richer product/order operations; choose Apideck Ecommerce when the same vendor already serves the customer's CRM, accounting, or ATS via Apideck

Complementary

Apideck Accounting API

→

Apideck Accounting to push orders into the merchant's ledger

Pair with Apideck Accounting when an order should create an invoice on the merchant's connected accounting platform without two separate integrations

FAQs

Specific to using Ecommerce API through Jentic.

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.

GET STARTED

Start building with Ecommerce API

Explore with Jentic One
View OpenAPI Document