| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| REST API | rest | https://app.ecwid.com/api/v3 | link | — | — | — |
| Storefront (JS) API | rest | https://app.ecwid.com/script.js | link | — | — | — |
| Webhooks | rest | https://app.ecwid.com/ | link | — | — | — |
| Payment API (PaymentUrl Requests) | rest | https://app.ecwid.com/ | link | — | — | — |
| Shipping API (ShippingUrl Requests) | rest | https://app.ecwid.com/ | link | — | — | — |
Actions (42)
Categories · 14
- Assign products to the categoryPOST /api/v3/{storeId}/categories/{categoryId}/assignProducts
Assign one or more products to a category.
documented - Create categoryPOST /api/v3/{storeId}/categories
Create a new product category.
documented - Delete categoryDELETE /api/v3/{storeId}/categories/{categoryId}
Delete a category.
documented - Delete category imageDELETE /api/v3/{storeId}/categories/{categoryId}/image
Delete the category image.
documented - Get categoryGET /api/v3/{storeId}/categories/{categoryId}
Fetch details for a specific category.
documented - Get category imageGET /api/v3/{storeId}/categories/{categoryId}/image
Retrieve category image details.
documented - Get order of categoriesGET /api/v3/{storeId}/categories/sort?parentCategory={categoryId}
Retrieve current order of categories under a parent category.
documented - Get order of productsGET /api/v3/{storeId}/products/sort?parentCategory={categoryId}
Get the order of products within a category.
documented - Search categoriesGET /api/v3/{storeId}/categories
List categories with optional filters and translations.
documented - Update categoryPUT /api/v3/{storeId}/categories/{categoryId}
Update a category’s details.
documented - Update order of categoriesPUT /api/v3/{storeId}/categories/sort?parentCategory={categoryId}
Update the order of categories under a parent category.
documented - Update order of productsPUT /api/v3/{storeId}/products/sort?parentCategory={categoryId}
Update the order of products within a category.
documented - Upload category imagePOST /api/v3/{storeId}/categories/{categoryId}/image
Upload an image for a category.
documented - Upload category image (async)POST /api/v3/{storeId}/categories/{categoryId}/image/async
Asynchronously upload an image for a category.
documented
Products · 6
- Create productPOST /api/v3/{storeId}/products
Create a new product in the catalog.
documented - Delete all productsDELETE /api/v3/{storeId}/products
Delete all products in the catalog for the store (bulk remove).
documented - Delete productDELETE /api/v3/{storeId}/products/{productId}
Remove a product from the catalog.
documented - Get productGET /api/v3/{storeId}/products/{productId}
Fetch full details for a single product by internal productId.
documented - Search productsGET /api/v3/{storeId}/products
Query products in the store catalog with optional filters.
documented - Update productPUT /api/v3/{storeId}/products/{productId}
Update an existing product’s data (name, price, stock, attributes, shipping, etc.).
documented
Product Files · 5
- Delete all product filesDELETE /api/v3/{storeId}/products/{productId}/files
Delete all files attached to a product.
documented - Delete product fileDELETE /api/v3/{storeId}/products/{productId}/files/{fileId}
Delete a file attached to a product.
documented - Download product fileGET /api/v3/{storeId}/products/{productId}/files/{fileId}
Download a product file.
documented - List product filesGET /api/v3/{storeId}/products/{productId}/files
List files attached to a product.
documented - Upload product filePOST /api/v3/{storeId}/products/{productId}/files
Upload a file associated with a product.
documented
Store Profile · 5
- Delete store logo imageDELETE /api/v3/{storeId}/profile/{logo}
Delete one of the store logos (e.g., main logo, invoice logo, or email logo).
documented - Get store profileGET /api/v3/{storeId}/profile
Get basic information about a store: settings, location, contact info, and storefront configuration.
documented - Get store reportsGET /api/v3/{storeId}/reports/{reportType}
Retrieve store stats/data for a given report type (e.g., allOrders, topOfProductsByViews, etc.) to drive admin dashboards.
documented - Update store profilePUT /api/v3/{storeId}/profile
Update main store settings such as location, language, and related storefront configuration.
documented - Upload store logo imagePUT /api/v3/{storeId}/profile/{logo}?externalUrl={externalUrl}
Update one of the store logo images by providing an external image URL (externalUrl) or image data; logo types include logo, invoicelogo, emaillogo.
documented
Customers · 3
- Search customer groupsGET /api/v3/{storeId}/customerGroups
List customer groups available in the store.
documented - Search customersGET /api/v3/{storeId}/customers
Search and list store customers with various filters.
documented - Update customerPUT /api/v3/{storeId}/customers/{customerId}
Update a customer’s details.
documented
Discounts · 3
- Create promotionPOST /api/v3/{storeId}/discounts/promotions
Create a new promotion for discounts.
documented - Search discount couponsGET /api/v3/{storeId}/discounts/discount-coupons
List discount coupons available in the store.
documented - Search promotionsGET /api/v3/{storeId}/discounts/promotions
List promotions available in the store.
documented
Webhook Automations · 3
- List webhook eventsGET /webhook-events
View available webhook event types (e.g., order.created) and associated API references.
documented - Register webhookPOST /webhook-registrations
Register a webhook URL for a given set of events.
documented - Test webhook registrationPOST /webhook-registrations/{id}/test
Test a webhook registration with a sample payload.
documented
Product Images & Videos · 2
- Upload main product imagePOST /api/v3/{storeId}/products/{productId}/image
Upload the main image for a product (can specify externalUrl or binary image data).
documented - Upload main product image (async)POST /api/v3/{storeId}/products/{productId}/image/async
Asynchronously upload the main image for a product (async path).
documented