Aidelly AI Ecommerce API
E-commerce store connections (Shopify, WooCommerce, Etsy, Wix) and product browsing. Public API preview — route handlers ship in a follow-up release; in-app behavior already lives at /api/ecommerce/*.
E-commerce store connections (Shopify, WooCommerce, Etsy, Wix) and product browsing. Public API preview — route handlers ship in a follow-up release; in-app behavior already lives at /api/ecommerce/*.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/aidelly-ai:aidelly-ai-ecommerce-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Aidelly Public Ecommerce API
version: 1.1.0
x-versioning-policy: https://www.aidelly.ai/developers/api/deprecation
description: 'Customer-facing API for publishing and scheduling social posts through Aidelly.
All responses use `{ success, data | error, request_id }`.
This API is optimized for single-user project integrations and AI agents:
- deterministic error codes
- required idempotency on writes
- plan-aware rate-limit headers on authenticated responses'
servers:
- url: https://app.aidelly.ai/api/public/v1
security:
- bearerAuth: []
tags:
- name: Ecommerce
description: 'E-commerce store connections (Shopify, WooCommerce, Etsy, Wix) and
product browsing. Public API preview — route handlers ship in a
follow-up release; in-app behavior already lives at /api/ecommerce/*.'
paths:
/ecommerce/stores:
get:
tags:
- Ecommerce
summary: List connected e-commerce stores for the workspace
description: 'Public API preview. Returns Shopify, WooCommerce, Etsy, and Wix
connections scoped to the current workspace. Route handler ships in
a follow-up release; today this is available at /api/ecommerce/stores.'
operationId: listEcommerceStores
parameters:
- $ref: '#/components/parameters/WorkspaceId'
responses:
'200':
description: List of connected stores
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
data:
type: object
properties:
stores:
type: array
items:
$ref: '#/components/schemas/EcommerceStore'
request_id:
type: string
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'429':
$ref: '#/components/responses/RateLimitedResponse'
x-tool-name: aidelly_list_ecommerce_stores
x-scope: ecommerce:read
x-tool-description: List the Shopify, WooCommerce, Etsy, and Wix stores connected to the workspace. Read-only.
security:
- bearerAuth: []
post:
tags:
- Ecommerce
summary: Connect a new e-commerce store
description: 'Public API preview. Verifies credentials against the provider,
persists the connection, and kicks off the initial product sync.
Credentials are discriminated on `provider` — current Shopify apps
use a Client ID + Client secret, legacy Shopify apps may use an access
token, WooCommerce needs consumer key+secret, and Etsy/Wix use OAuth
tokens.'
operationId: connectEcommerceStore
parameters:
- $ref: '#/components/parameters/WorkspaceId'
- $ref: '#/components/parameters/IdempotencyKey'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectEcommerceStoreRequest'
responses:
'201':
description: Store connected; initial sync queued
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
data:
$ref: '#/components/schemas/EcommerceStore'
request_id:
type: string
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'429':
$ref: '#/components/responses/RateLimitedResponse'
x-tool-name: aidelly_connect_ecommerce_store
x-scope: ecommerce:write
x-tool-description: 'Connect a Shopify, WooCommerce, Etsy, or Wix store to the workspace. Verifies the supplied store credentials, then starts an initial product sync. Retry-safe: a repeat call with the same idempotency_key returns the original result.'
security:
- bearerAuth: []
/ecommerce/stores/{id}:
get:
tags:
- Ecommerce
summary: Get one connected e-commerce store
operationId: getEcommerceStore
parameters:
- $ref: '#/components/parameters/WorkspaceId'
- in: path
name: id
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Store detail
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
data:
$ref: '#/components/schemas/EcommerceStore'
request_id:
type: string
'404':
$ref: '#/components/responses/NotFoundResponse'
x-tool-name: aidelly_get_ecommerce_store
x-scope: ecommerce:read
x-tool-description: Read one connected e-commerce store by id. Read-only.
security:
- bearerAuth: []
description: Read one connected e-commerce store by id. Read-only.
delete:
tags:
- Ecommerce
summary: Disconnect an e-commerce store
description: 'Public API preview. Revokes the stored credential and stops future
syncs. Already-imported products stay available so previously
scheduled posts don''t break.'
operationId: disconnectEcommerceStore
parameters:
- $ref: '#/components/parameters/WorkspaceId'
- $ref: '#/components/parameters/IdempotencyKey'
- in: path
name: id
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Disconnected
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/EnvelopeBase'
- type: object
properties:
success:
const: true
data:
$ref: '#/components/schemas/EcommerceStoreDeleteResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
x-tool-name: aidelly_disconnect_ecommerce_store
x-scope: ecommerce:write
x-tool-description: 'Disconnect a connected store: deletes the stored connection and its credential, stops future syncs, and removes the products imported from it. Irreversible; reconnecting the store re-imports its catalog. Retry-safe: a repeat call with the same idempotency_key returns the original result.'
security:
- bearerAuth: []
/ecommerce/stores/{id}/sync:
post:
tags:
- Ecommerce
summary: Re-sync products for a connected store
description: 'Public API preview. Incremental sync — Aidelly only fetches what
changed since the last sync. Large catalogs stream in the
background without blocking the response.'
operationId: syncEcommerceStore
parameters:
- $ref: '#/components/parameters/WorkspaceId'
- $ref: '#/components/parameters/IdempotencyKey'
- in: path
name: id
required: true
schema:
type: string
format: uuid
responses:
'202':
description: Sync queued
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
data:
type: object
properties:
sync_job_id:
type: string
format: uuid
request_id:
type: string
x-tool-name: aidelly_sync_ecommerce_store
x-scope: ecommerce:write
x-tool-description: 'Re-sync a connected store''s product catalog: fetches the store''s products and upserts them into the workspace. Retry-safe: a repeat call with the same idempotency_key returns the original result.'
security:
- bearerAuth: []
/ecommerce/products:
get:
tags:
- Ecommerce
summary: List products across connected stores
description: 'Public API preview. Returns active products from the workspace''s
connected stores. Filter by store id, search by title or SKU.'
operationId: listEcommerceProducts
parameters:
- $ref: '#/components/parameters/WorkspaceId'
- in: query
name: store_id
schema:
type: string
format: uuid
- in: query
name: q
schema:
type: string
description: Title / SKU substring search.
- in: query
name: limit
schema:
type: integer
minimum: 1
maximum: 100
default: 50
- in: query
name: cursor
description: Opaque cursor from a previous response's `next_cursor`. Treat it as opaque; its encoding is not part of the contract. Omit to start at the first page. When both `cursor` and offset-style parameters are sent, the cursor wins.
schema:
type: string
maxLength: 512
responses:
'200':
description: Product list
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
data:
type: object
properties:
products:
type: array
items:
$ref: '#/components/schemas/EcommerceProduct'
has_more:
type: boolean
description: Whether another page exists after this one.
next_cursor:
type:
- string
- 'null'
description: Opaque cursor for the next page; null on the last page.
request_id:
type: string
x-tool-name: aidelly_list_ecommerce_products
x-scope: ecommerce:read
x-tool-description: List products across the workspace's connected stores, filtered by store or searched by title or SKU. Read-only.
security:
- bearerAuth: []
components:
headers:
XRateLimitLimit:
description: Maximum requests allowed in the current window.
schema:
type: integer
example: 120
XRateLimitPlan:
description: Resolved plan tier for rate limiting.
schema:
type: string
enum:
- launch
- scale
- agency
- fallback
example: scale
XRateLimitResetEpoch:
description: Unix epoch seconds for current window reset.
schema:
type: integer
example: 1771353600
RateLimitLimit:
description: RFC 9333 maximum requests allowed in the current window.
schema:
type: integer
minimum: 0
example: 120
XRateLimitWindowSeconds:
description: Rate limit window duration in seconds.
schema:
type: integer
example: 60
RateLimitPolicy:
description: Quota policy extension using limit and window parameters.
schema:
type: string
example: 120;w=60
RateLimitRemaining:
description: RFC 9333 requests remaining in the current window.
schema:
type: integer
minimum: 0
example: 118
XRateLimitReset:
description: ISO timestamp for current window reset.
schema:
type: string
format: date-time
example: 2026-02-17 18:40:00+00:00
XRateLimitRemaining:
description: Remaining requests available in the current window.
schema:
type: integer
example: 118
RateLimitReset:
description: RFC 9333 seconds until the current window resets.
schema:
type: integer
minimum: 1
example: 42
RetryAfter:
description: Seconds to wait before retrying after a `429`.
schema:
type: integer
minimum: 1
example: 17
schemas:
EcommerceProduct:
type: object
required:
- id
- store_id
- provider
- title
- product_url
properties:
id:
type: string
format: uuid
store_id:
type: string
format: uuid
provider:
$ref: '#/components/schemas/EcommerceProvider'
external_id:
type: string
title:
type: string
description:
type: string
nullable: true
primary_image_url:
type: string
format: uri
nullable: true
product_url:
type: string
format: uri
price:
type: string
nullable: true
description: Decimal as string.
currency:
type: string
nullable: true
description: ISO-4217.
sku:
type: string
nullable: true
updated_at:
type: string
format: date-time
EnvelopeBase:
type: object
required:
- success
- request_id
properties:
success:
type: boolean
request_id:
type: string
format: uuid
ConnectEcommerceStoreRequest:
type: object
required:
- provider
- shopDomain
- credentials
properties:
provider:
$ref: '#/components/schemas/EcommerceProvider'
shopDomain:
type: string
credentials:
oneOf:
- type: object
required:
- clientId
- clientSecret
properties:
clientId:
type: string
clientSecret:
type: string
format: password
description: Current Shopify Dev Dashboard app credentials.
- type: object
required:
- accessToken
properties:
accessToken:
type: string
description: Legacy Shopify, Etsy, or Wix credentials.
- type: object
required:
- consumerKey
- consumerSecret
properties:
consumerKey:
type: string
consumerSecret:
type: string
description: WooCommerce REST API credentials.
EcommerceStore:
type: object
required:
- id
- provider
- shop_domain
- status
properties:
id:
type: string
format: uuid
provider:
$ref: '#/components/schemas/EcommerceProvider'
shop_domain:
type: string
status:
type: string
enum:
- active
- syncing
- errored
- disconnected
product_count:
type: integer
minimum: 0
last_synced_at:
type: string
format: date-time
nullable: true
created_at:
type: string
format: date-time
EcommerceProvider:
type: string
enum:
- shopify
- woocommerce
- etsy
- wix
EcommerceStoreDeleteResponse:
type: object
properties:
id:
type: string
format: uuid
PlanLimitErrorDetails:
type: object
additionalProperties: false
required:
- limit_key
- plan_tier
- current_usage
- limit
- reset_at
- recommended_plan
- upgrade_url
properties:
limit_key:
type: string
example: automations.active
plan_tier:
type: string
example: launch
current_usage:
type: integer
nullable: true
example: 5
limit:
type: integer
nullable: true
example: 5
reset_at:
type: string
format: date-time
nullable: true
example: 2026-03-31 23:59:59+00:00
recommended_plan:
type: string
nullable: true
example: scale
upgrade_url:
type: string
format: uri
example: https://app.aidelly.ai/account/billing
ErrorEnvelope:
allOf:
- $ref: '#/components/schemas/EnvelopeBase'
- type: object
required:
- error
properties:
success:
const: false
error:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
details:
description: Machine-readable error details object. Plan/feature gates use PlanLimitErrorDetails.
oneOf:
- $ref: '#/components/schemas/PlanLimitErrorDetails'
- type: object
additionalProperties: true
responses:
NotFoundResponse:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
success: false
error:
code: PUBLIC_API_POST_NOT_FOUND
message: Post not found.
request_id: e2f4f215-183a-47f7-bd4f-29a9380d9528
UnauthorizedResponse:
description: API key missing, invalid, or expired
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
success: false
error:
code: PUBLIC_API_AUTH_REQUIRED
message: A Bearer API key is required.
request_id: e2f4f215-183a-47f7-bd4f-29a9380d9528
BadRequestResponse:
description: Request validation failed (body, missing Idempotency-Key, or invalid Idempotency-Key)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
examples:
bodyInvalid:
value:
success: false
error:
code: PUBLIC_API_BODY_INVALID
message: Invalid request body.
request_id: e2f4f215-183a-47f7-bd4f-29a9380d9528
idempotencyKeyInvalid:
value:
success: false
error:
code: PUBLIC_API_IDEMPOTENCY_KEY_INVALID
message: 'Idempotency-Key must be 1-255 printable ASCII characters with no spaces (letters, digits, and punctuation such as - _ : . are allowed).'
request_id: e2f4f215-183a-47f7-bd4f-29a9380d9528
RateLimitedResponse:
description: API key exceeded allowed request throughput
headers:
RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
RateLimit-Policy:
$ref: '#/components/headers/RateLimitPolicy'
X-RateLimit-Limit:
$ref: '#/components/headers/XRateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/XRateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/XRateLimitReset'
X-RateLimit-Reset-Epoch:
$ref: '#/components/headers/XRateLimitResetEpoch'
X-RateLimit-Window-Seconds:
$ref: '#/components/headers/XRateLimitWindowSeconds'
X-RateLimit-Plan:
$ref: '#/components/headers/XRateLimitPlan'
Retry-After:
$ref: '#/components/headers/RetryAfter'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
success: false
error:
code: PUBLIC_API_RATE_LIMITED
message: Rate limit exceeded.
request_id: e2f4f215-183a-47f7-bd4f-29a9380d9528
parameters:
WorkspaceId:
in: header
name: x-aidelly-workspace-id
required: false
schema:
type: string
format: uuid
description: 'Workspace to operate in: the `id` of a workspace returned by aidelly_list_workspaces. Optional for read operations; required when creating content.'
description: Optional workspace scope override for workspace-compatible API keys.
IdempotencyKey:
in: header
name: Idempotency-Key
required: true
schema:
type: string
minLength: 1
maxLength: 255
pattern: ^[\x21-\x7E]{1,255}$
example: order-123:create-post:v1
description: 'Required on all write endpoints. 1-255 printable ASCII characters (0x21-0x7E): letters, digits, and punctuation such as `-`, `_`, `.`, and `:` are allowed; spaces, control characters, and non-ASCII are not. Leading and trailing whitespace is trimmed. An invalid key returns 400 `PUBLIC_API_IDEMPOTENCY_KEY_INVALID`; a missing key returns 400 `PUBLIC_API_IDEMPOTENCY_REQUIRED`. Keys are scoped to the API key, method, and path.'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: API Key
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.aidelly.ai/api/mcp/oauth/authorize
tokenUrl: https://app.aidelly.ai/api/mcp/oauth/token
refreshUrl: https://app.aidelly.ai/api/mcp/oauth/token
scopes:
posts:write: Create and modify posts
posts:read: Read access to posts
photos:write: Create and modify photos
media:write: Create and modify media
connections:read: Read access to connections
webhooks:manage: Manage webhooks
approvals:read: Read access to approvals
approvals:write: Create and modify approvals
inbox:read: Read access to inbox
inbox:write: Create and modify inbox
automations:read: Read access to automations
automations:write: Create and modify automations
queues:read: Read access to queues
queues:write: Create and modify queues
destination-presets:read: Read access to destination-presets
destination-presets:write: Create and modify destination-presets
calendar:read: Read access to calendar
calendar:write: Create and modify calendar
analytics:read: Read access to analytics
analytics:write: Create and modify analytics
brand:read: Read access to brand
brand:write: Create and modify brand
workspaces:read: Read access to workspaces
workspaces:write: Create and modify workspaces
team:read: Read access to team
team:write: Create and modify team
repurpose:read: Read access to repurpose
repurpose:write: Create and modify repurpose
ideas:read: Read access to ideas
ideas:write: Create and modify ideas
links:read: Read access to links
links:write: Create and modify links
connect_links:read: Read access to connect_links
connect_links:write: Create and modify connect_links
bio:read: Read access to bio
bio:write: Create and modify bio
image_editor:read: Read access to image_editor
image_editor:write: Create and modify image_editor
viral_trends:read: Read access to viral_trends
creators:read: Read access to creators
creators:write: Create and modify creators
competitors:read: Read access to competitors
competitors:write: Create and modify competitors
reports:read: Read access to reports
reports:write: Create and modify reports
tasks:read: Read access to tasks
tasks:write: Create and modify tasks
white-label:read: Read access to white-label
white-label:write: Create and modify white-label
drafts:read: Read access to drafts
drafts:write: Create and modify drafts
activity:read: Read access to activity
credits:read: Read access to credits
comments:read: Read access to comments
comments:write: Create and modify comments
prompts:read: Read access to prompts
prompts:write: Create and modify prompts
externalDocs:
description: Aidelly developer documentation and API lifecycle policy
url: https://www.aidelly.ai/docs