Cloud Elements Ecwid (Cloud Elements)
Community OpenAPI document · agent-readyE CommerceStorefrontnone42 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Manage Ecwid products, customers, orders, and bulk imports through the Cloud Elements unified e-commerce API surface.
Use for: List all products in the Ecwid store, Create a new product with price and inventory, Find all orders for a specific customer, Get the customer record for a given customer ID
Not supported: Does not handle payments, tax calculation, or shipping label generation - use for Ecwid catalog, customer, order, and bulk data operations only.
The Cloud Elements Ecwid connector exposes the Ecwid storefront through a normalised Cloud Elements API surface. It lets developers manage products, customers, and orders, run bulk imports and exports, and work with arbitrary objects through a generic objects endpoint. The connector is part of the Cloud Elements unified API platform, so the same patterns apply to other connected commerce systems and integration teams can swap underlying storefronts without rewriting their callers.
Install Jentic One Beta
Connect the Ecwid (Cloud Elements) to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Ecwid (Cloud Elements), 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%2Fcloud-elements.com%2Fcloud-elements" | sh2
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%2Fcloud-elements.com%2Fcloud-elements" | sh
jentic register # connects your agent to your Jentic One instanceJentic 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 Ecwid (Cloud Elements) API.
List, create, and update products in an Ecwid store
Read and update customer records and their associated orders
Process orders including line items and order status changes
Run bulk imports and exports of catalog and order data
Inspect available object types and their metadata for the connected Ecwid store
Health-check the connector with a ping endpoint before making bulk calls
Use Cases
Patterns agents use Ecwid (Cloud Elements) API for, with concrete tasks.
★ Catalog Synchronisation
Keep the Ecwid product catalog in sync with an external PIM, ERP, or marketplace by reading and updating products through the Cloud Elements connector. The /products and /bulk endpoints support both single-record updates and bulk imports, which is useful for stores running thousands of SKUs and frequent price or stock changes. Integration with a unified Cloud Elements account typically takes 1-2 days because the same patterns work across multiple commerce backends.
Run a bulk import of 500 products from a CSV staged in cloud storage and poll the bulk job until status is complete.
Order Processing
Pull new orders from Ecwid into a fulfilment, accounting, or analytics system, then write back status updates as the order progresses. The /orders endpoint exposes list and update operations, and /customers/{id}/orders gives a per-customer view useful for support and CX flows. The connector pattern lets the same code support Ecwid plus any other Cloud Elements commerce connector for multi-store operators.
List all orders created in the last 24 hours and update each one with a tracking number once the warehouse confirms shipment.
Customer Data Export
Export the customer base for marketing automation, CRM enrichment, or churn analysis. The /customers and /bulk/{objectName} endpoints support both paginated reads and bulk export jobs. Bulk jobs return a job identifier that can be polled or cancelled, which suits exports of tens of thousands of customer records without timing out the request thread.
Start a bulk export of all customers, poll /bulk/{id}/status until complete, then download the resulting file.
AI Agent Storefront Operations
Let an AI agent manage the Ecwid store on behalf of a merchant - answering questions about orders, updating product details, and triggering bulk operations. Through Jentic the agent searches by intent, loads the operation schema for the right endpoint, and executes calls with merchant credentials kept out of the model context. This pattern fits merchant-support copilots and admin chat assistants in small-to-mid e-commerce teams.
Search Jentic for 'list ecwid products', load the operation schema, and return the first 20 products with their prices.
Key Endpoints
42 endpoints — the cloud elements ecwid connector exposes the ecwid storefront through a normalised cloud elements api surface.
METHOD
PATH
DESCRIPTION
GET
/products
List products in the Ecwid store
GET
/customers
List customers
GET
/customers/{id}/orders
List orders for a customer
GET
/orders
List orders
POST
/bulk/query
Start a bulk export job
GET
/bulk/{id}/status
Check bulk job status
POST
/bulk/{id}/cancel
Cancel a running bulk job
GET
/objects/{objectName}/metadata
Get object metadata
GET
/products
List products in the Ecwid store
GET
/customers
List customers
GET
/customers/{id}/orders
List orders for a customer
GET
/orders
List orders
POST
/bulk/query
Start a bulk export job
GET
/bulk/{id}/status
Check bulk job status
POST
/bulk/{id}/cancel
Cancel a running bulk job
GET
/objects/{objectName}/metadata
Get object metadata
Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring Ecwid through Cloud Elements by hand means carrying its User, Organization, and Element auth headers, mapping its catalog, order, and bulk endpoints, and handling retries yourself against api.cloud-elements.com/elements/api-v2. Through Jentic you install once, import the Ecwid connector from the API Directory, store the credentials once, and your agent calls it.
Permission scoping
The Cloud Elements Ecwid connector puts the customer id in the URL path (/customers/{id}/orders), so a rule can pin your agent to one customer: it can read that customer's orders and nothing else. You choose the operations it may call, so bulk query cancellation is not included unless you add it.
Credential isolation
Your Cloud Elements User, Organization, and Element credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'list Ecwid orders', and Jentic returns the matching Cloud Elements Ecwid operation with its input schema, so the agent calls the right endpoint without browsing the connector reference.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Ecwid (Cloud Elements) API through Jentic.
What authentication does the Ecwid (Cloud Elements) connector use?
The OpenAPI spec does not declare an explicit security scheme on the endpoints. Cloud Elements connectors are typically called with a Cloud Elements User, Organization, and Element credential set passed as Authorization headers. Through Jentic, those credentials are stored encrypted in the vault and only injected at execution time.
Can I run bulk imports and exports against Ecwid through this API?
Yes. The /bulk/query, /bulk/jobs, /bulk/download, and /bulk/{id}/status endpoints handle bulk imports, exports, and job monitoring. /bulk/{id}/cancel stops a running job. Use this for catalog sync and customer exports involving thousands of records.
How do I manage orders through the Ecwid (Cloud Elements) API?
Use the /orders endpoint to list and create orders, and /customers/{id}/orders to fetch a customer's order history. Through Jentic, search 'list ecwid orders', load the operation schema, then execute with the desired filters.
What are the rate limits for the Ecwid (Cloud Elements) connector?
The spec does not declare explicit rate limits. Cloud Elements typically applies rate limits at the platform level rather than per-endpoint. Check the Cloud Elements console for the current quota on your account before running large bulk jobs.
How do I inspect what object types are available on this connector?
Call GET /objects to list the object types the connector exposes, and GET /objects/{objectName}/metadata to inspect the schema of a specific object. This is useful when building generic integrations that work across multiple Cloud Elements connectors.
How do I list products through Jentic?
Search Jentic with 'list ecwid products', load the operation schema for GET /products, then execute. Install with pip install jentic and use the async client.search, client.load, client.execute pattern.
Can I limit what my agent is allowed to do with the Ecwid (Cloud Elements) API?
Yes. Because you run Jentic One yourself, your own rules decide which Cloud Elements Ecwid operations and credentials the agent may use. You can grant read-only calls like GET /products, GET /orders, and GET /customers/{id}/orders while withholding bulk operations such as POST /bulk/query or POST /bulk/{id}/cancel. Since the customer id sits in the path of /customers/{id}/orders, a rule can pin the agent to a single customer's orders and nothing else.
GET STARTED