Connect your CS-Cart store to EcomCentral using HTTP Basic authentication with your admin email and auto-generated API key.
https://your-store.com/api/
| Key | Required | Description | Example |
|---|---|---|---|
base_url |
Required | The full URL of your CS-Cart store (with or without /api — EcomCentral appends it automatically) |
https://store.example.com |
email |
Required | Administrator email address used to log in to the CS-Cart admin panel | admin@example.com |
api_key |
Required | Auto-generated API key from Profile → API Access in the admin panel | a1b2c3d4e5f6… |
baseUrl, store_url, or url for the store URL;
user or login for the email; apiKey or key for the API key.
| Operation | Method | Endpoint |
|---|---|---|
| Test connection | GET | /api/orders?page=1&items_per_page=1 |
| List orders | GET | /api/orders?page=P&items_per_page=N |
| Order detail | GET | /api/orders/{id} |
| List products | GET | /api/products?page=P&items_per_page=N |
| Product detail | GET | /api/products/{id} |
| Update stock | PUT | /api/products/{id} with { "amount": "N" } |
| Create shipment | POST | /api/shipments with order_id, shipping_id, products map, tracking_number, carrier |
https://store/api/:object for lists and https://store/api/:object/:id for single resources.
All responses are JSON; write operations require Content-Type: application/json.
| Code | Label | Meaning |
|---|---|---|
| O | Open | Order has been placed and is awaiting processing |
| P | Processed | Payment has been received and the order is being fulfilled |
| C | Complete | Order has been fully shipped and delivered |
| F | Failed | Payment or order processing failed |
| D | Declined | Order was declined (e.g. by fraud check or manually) |
| B | Backordered | One or more items are out of stock; order is waiting |
| I | Cancelled | Order has been cancelled |
| Y | Awaiting Call | Order requires a call-back before it can be processed |
| Feature | Supported | Notes |
|---|---|---|
| View orders (paginated) | ✅ | Order ID, date (UNIX timestamp), status code, total |
| View order detail | ✅ | Customer info, shipping & billing addresses, line items, shipping method, tracking |
| Add tracking / create shipment | ✅ | Tracking number + carrier; EcomCentral automatically derives shipping_id and products map from the order |
| View products (paginated) | ✅ | Product ID, SKU (product_code), name, price, stock (amount) |
| View product detail | ✅ | Full product data including description, image, category, and current stock |
| Update stock quantity | ✅ | By product_id via PUT /api/products/{id} with { "amount": "N" } |
| Test connection | ✅ | Returns total order count from the orders list endpoint |
shipping_id and a
products map (cart item ID → quantity) when creating a shipment.
EcomCentral handles this automatically by fetching the full order before posting the shipment —
you only need to supply the tracking number and optional carrier name.
The email or API key is incorrect, or the key was regenerated after saving the connection. Go to Profile → API Access in your CS-Cart admin panel, regenerate the key if necessary, and update the connection in EcomCentral.
The admin account does not have sufficient privileges to access the API, or the store URL is incorrect. Ensure the account used is a root administrator (not a restricted admin group).
Verify that the base_url is correct and that your CS-Cart store has a valid SSL certificate.
EcomCentral connects over HTTPS with peer verification enabled.
CS-Cart requires a shipping_id linked to the order's selected shipping method.
This is resolved automatically from the order's shipping array.
If the order was created without a shipping method (e.g. downloadable products or manual orders),
the shipment API call cannot proceed.
The order's products map returned no items with a quantity greater than zero.
This can happen with refunded or voided orders. Verify the order in the CS-Cart admin panel
before retrying.