Ecwid (Cloud Elements)

Name: Ecwid (Cloud Elements) API
Brand: Ecwid (Cloud Elements)
Availability: InStock

★ Only Publicly Available OpenAPI DocumentE CommerceStorefrontnone42 EndpointsREST

For Agents

Manage Ecwid products, customers, orders, and bulk imports through the Cloud Elements unified e-commerce API surface.

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.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | 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 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

GET STARTED

Start building with Ecwid (Cloud Elements) API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Ecwid (Cloud Elements), keeping it validated and agent-ready.

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.

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

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Cloud Elements credentials (User, Organization, Element auth) are stored encrypted in the Jentic vault. Agents receive scoped access at call time only — raw credentials never enter the agent's context.

Intent-based discovery

Agents search by intent (e.g., 'list ecwid orders') and Jentic returns the matching Cloud Elements Ecwid operation with its input schema, removing the need to read the connector reference.

Time to first call

Direct Cloud Elements integration: 2-3 days for auth, connector configuration, and bulk job handling. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Ecwid native API

Direct Ecwid REST API without the Cloud Elements abstraction

Choose the native Ecwid API when you only need Ecwid and want full feature coverage rather than the unified Cloud Elements surface.

Alternative

Shopify Admin API

Larger storefront platform with broader catalog and checkout coverage

Choose Shopify when the merchant operates on Shopify rather than Ecwid, or needs deeper checkout, fulfilment, and discount features.

Alternative

Magento (Adobe Commerce) API

Self-hosted enterprise commerce platform with extensive catalog APIs

Choose Magento for larger merchants running self-hosted commerce stacks rather than Ecwid's hosted storefront.

Complementary

Squarespace Commerce API

Commerce API for Squarespace-hosted stores

Use alongside the Ecwid connector when a multi-brand operator runs both Ecwid and Squarespace storefronts and wants unified product/order flows.

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.