ecwid
API version: api-v2
Auth
ApiKey Authorization in header
Base URL
https://api.cloud-elements.com/elements/api-v2
Setup
- Set your API key in the appropriate header
- GET /bulk/jobs -- verify access
- POST /bulk/download -- create first download
Endpoints
42 endpoints across 7 groups. See references/api-spec.lap for full details.
bulk
| Method |
Path |
Description |
| POST |
/bulk/download |
Create a new bulk download job (asynchronous) |
| GET |
/bulk/jobs |
Fetch all the bulk jobs for an instance |
| POST |
/bulk/query |
Create an asynchronous bulk query job. |
| PUT |
/bulk/{id}/cancel |
Cancel an asynchronous bulk query job. |
| GET |
/bulk/{id}/errors |
Retrieve the errors of a bulk job. |
| GET |
/bulk/{id}/status |
Retrieve the status of a bulk job. |
| GET |
/bulk/{id}/{objectName} |
Retrieve the results of an asynchronous bulk query. |
| POST |
/bulk/{objectName} |
Upload a file of objects to be bulk uploaded to the provider. |
customers
| Method |
Path |
Description |
| POST |
/customers |
Create a new customer in eCommerce system.With the exception of the 'id' field, the required fields indicated in the 'Customer' model are those required to create a new customer |
| GET |
/customers |
Find customers in the eCommerce system, using the provided CEQL search expression. If no search expression is provided, all records will be retrieved |
| PATCH |
/customers/{id} |
Update an customer associated with a given ID in the eCommerce system.The update API uses the PATCH HTTP verb, so only those fields provided in the customer object will be updated, and those fields not provided will be left alone. Updating a customer with a specified ID that does not exist will result in an error response |
| GET |
/customers/{id} |
Retrieve a customer associated with a given ID from the eCommerce system. Specifying a customer with an ID that does not exist will result in an error response |
| DELETE |
/customers/{id} |
Delete a customer associated with a given ID from your eCommerce system. Specifying a customer associated with a given ID that does not exist will result in an error message |
| GET |
/customers/{id}/orders |
Find orders in the customer associated with a given ID. If the customer does not exist, an error response will be returned. If no orders are found in the given customer then an empty array will be returned |
objects
| Method |
Path |
Description |
| GET |
/objects |
Get a list of all the available objects. |
| GET |
/objects/{objectName}/docs |
Get swagger docs for an object. |
| GET |
/objects/{objectName}/metadata |
Get a list of all the fields for an object. |
orders
| Method |
Path |
Description |
| POST |
/orders |
Create an order in the eCommerce system.With the exception of the 'id' field, the required fields indicated in the 'Order' model are those required to create a new order.The paymentStatus can only be AWAITING_PAYMENT or INCOMPLETE.The fulfillmentStatus can only be AWAITING_PROCESSING |
| GET |
/orders |
Find orders in the eCommerce system, using the provided CEQL search expression. If no search expression is provided, all records will be retrieved |
| PATCH |
/orders/{id} |
Update an order associated with a given ID in the eCommerce system. The update API uses the PATCH HTTP verb, so only those fields provided in the order object will be updated, and those fields not provided will be left alone. Updating an order with a specified ID that does not exist will result in an error response |
| GET |
/orders/{id} |
Retrieve an order associated with a given ID from the eCommerce system. Specifying an order with an ID that does not exist will result in an error response |
| DELETE |
/orders/{id} |
Delete an order associated with a given ID from your eCommerce system. Specifying an order associated with a given ID that does not exist will result in an error message |
| GET |
/orders/{orderId}/payments |
Retrieve the payments in the eCommerce system for the specified order |
| GET |
/orders/{orderId}/refunds |
Retrieve the refunds in the eCommerce system for the specified order |
ping
| Method |
Path |
Description |
| GET |
/ping |
Ping the element to confirm that the hub element has a heartbeat. If the element does not have a heartbeat, an error message will be returned. |
products
| Method |
Path |
Description |
| POST |
/products |
Create a new product in eCommerce system.With the exception of the 'id' field, the required fields indicated in the 'Product' model are those required to create a new product |
| GET |
/products |
Find products in the eCommerce system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. If no search expression is provided, all records will be retrieved |
| PATCH |
/products/{id} |
Update a product associated with a given ID in the eCommerce system. The update API uses the PATCH HTTP verb, so only those fields provided in the product object will be updated, and those fields not provided will be left alone. Updating a product with a specified ID that does not exist will result in an error response. Update supports the following fields: sku, quantity, trackQuantity, quantityDelta, warningLimit, name, price, weight, tangible, enabled, fixedShippingRateOnly, fixedShippingRate, description, wholesalePrices, compareAtPrice, productClassId |
| GET |
/products/{id} |
Retrieve a product associated with a given ID from the eCommerce system. Specifying a product with an ID that does not exist will result in an error response |
| DELETE |
/products/{id} |
Delete a product associated with a given ID from your eCommerce system. Specifying a product associated with a given ID that does not exist will result in an error message |
{objectName}
| Method |
Path |
Description |
| GET |
/{objectName} |
Search for {objectName} |
| POST |
/{objectName} |
Create an {objectName} |
| DELETE |
/{objectName}/{objectId} |
Delete an {objectName} |
| GET |
/{objectName}/{objectId} |
Retrieve an {objectName} |
| PATCH |
/{objectName}/{objectId} |
Update an {objectName} |
| PUT |
/{objectName}/{objectId} |
Update an {objectName} |
| GET |
/{objectName}/{objectId}/{childObjectName} |
Search for {childObjectName} |
| POST |
/{objectName}/{objectId}/{childObjectName} |
Create an {objectName} |
| DELETE |
/{objectName}/{objectId}/{childObjectName}/{childObjectId} |
Delete an {childObjectName} |
| GET |
/{objectName}/{objectId}/{childObjectName}/{childObjectId} |
Retrieve an {childObjectName} |
| PATCH |
/{objectName}/{objectId}/{childObjectName}/{childObjectId} |
Update an {childObjectName} |
| PUT |
/{objectName}/{objectId}/{childObjectName}/{childObjectId} |
Update an {childObjectName} |
Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Create a download?" -> POST /bulk/download
- "List all jobs?" -> GET /bulk/jobs
- "Create a query?" -> POST /bulk/query
- "List all errors?" -> GET /bulk/{id}/errors
- "List all status?" -> GET /bulk/{id}/status
- "Get bulk details?" -> GET /bulk/{id}/{objectName}
- "Create a customer?" -> POST /customers
- "List all customers?" -> GET /customers
- "Partially update a customer?" -> PATCH /customers/{id}
- "Get customer details?" -> GET /customers/{id}
- "Delete a customer?" -> DELETE /customers/{id}
- "List all orders?" -> GET /customers/{id}/orders
- "List all objects?" -> GET /objects
- "List all docs?" -> GET /objects/{objectName}/docs
- "List all metadata?" -> GET /objects/{objectName}/metadata
- "Create a order?" -> POST /orders
- "List all orders?" -> GET /orders
- "Partially update a order?" -> PATCH /orders/{id}
- "Get order details?" -> GET /orders/{id}
- "Delete a order?" -> DELETE /orders/{id}
- "List all payments?" -> GET /orders/{orderId}/payments
- "List all refunds?" -> GET /orders/{orderId}/refunds
- "List all ping?" -> GET /ping
- "Create a product?" -> POST /products
- "List all products?" -> GET /products
- "Partially update a product?" -> PATCH /products/{id}
- "Get product details?" -> GET /products/{id}
- "Delete a product?" -> DELETE /products/{id}
- "How to authenticate?" -> See Auth section
Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints typically return the created/updated object
References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
Generated from the official API spec by LAP
1---2name: ecwid3description: ecwid API skill. Use when working with ecwid for bulk, customers, objects. Covers 42 endpoints.4---5
6# ecwid
7API version: api-v2
8
9## Auth
10ApiKey Authorization in header
11
12## Base URL
13https://api.cloud-elements.com/elements/api-v2
14
15## Setup
161. Set your API key in the appropriate header
172. GET /bulk/jobs -- verify access
183. POST /bulk/download -- create first download
19
20## Endpoints
21
2242 endpoints across 7 groups. See references/api-spec.lap for full details.
23
24### bulk
25| Method | Path | Description |
26|--------|------|-------------|
27| POST | /bulk/download | Create a new bulk download job (asynchronous) |
28| GET | /bulk/jobs | Fetch all the bulk jobs for an instance |
29| POST | /bulk/query | Create an asynchronous bulk query job. |
30| PUT | /bulk/{id}/cancel | Cancel an asynchronous bulk query job. |
31| GET | /bulk/{id}/errors | Retrieve the errors of a bulk job. |
32| GET | /bulk/{id}/status | Retrieve the status of a bulk job. |
33| GET | /bulk/{id}/{objectName} | Retrieve the results of an asynchronous bulk query. |
34| POST | /bulk/{objectName} | Upload a file of objects to be bulk uploaded to the provider. |
35
36### customers
37| Method | Path | Description |
38|--------|------|-------------|
39| POST | /customers | Create a new customer in eCommerce system.With the exception of the 'id' field, the required fields indicated in the 'Customer' model are those required to create a new customer |
40| GET | /customers | Find customers in the eCommerce system, using the provided CEQL search expression. If no search expression is provided, all records will be retrieved |
41| PATCH | /customers/{id} | Update an customer associated with a given ID in the eCommerce system.The update API uses the PATCH HTTP verb, so only those fields provided in the customer object will be updated, and those fields not provided will be left alone. Updating a customer with a specified ID that does not exist will result in an error response |
42| GET | /customers/{id} | Retrieve a customer associated with a given ID from the eCommerce system. Specifying a customer with an ID that does not exist will result in an error response |
43| DELETE | /customers/{id} | Delete a customer associated with a given ID from your eCommerce system. Specifying a customer associated with a given ID that does not exist will result in an error message |
44| GET | /customers/{id}/orders | Find orders in the customer associated with a given ID. If the customer does not exist, an error response will be returned. If no orders are found in the given customer then an empty array will be returned |
45
46### objects
47| Method | Path | Description |
48|--------|------|-------------|
49| GET | /objects | Get a list of all the available objects. |
50| GET | /objects/{objectName}/docs | Get swagger docs for an object. |
51| GET | /objects/{objectName}/metadata | Get a list of all the fields for an object. |
52
53### orders
54| Method | Path | Description |
55|--------|------|-------------|
56| POST | /orders | Create an order in the eCommerce system.With the exception of the 'id' field, the required fields indicated in the 'Order' model are those required to create a new order.The paymentStatus can only be AWAITING_PAYMENT or INCOMPLETE.The fulfillmentStatus can only be AWAITING_PROCESSING |
57| GET | /orders | Find orders in the eCommerce system, using the provided CEQL search expression. If no search expression is provided, all records will be retrieved |
58| PATCH | /orders/{id} | Update an order associated with a given ID in the eCommerce system. The update API uses the PATCH HTTP verb, so only those fields provided in the order object will be updated, and those fields not provided will be left alone. Updating an order with a specified ID that does not exist will result in an error response</strong> |
59| GET | /orders/{id} | Retrieve an order associated with a given ID from the eCommerce system. Specifying an order with an ID that does not exist will result in an error response |
60| DELETE | /orders/{id} | Delete an order associated with a given ID from your eCommerce system. Specifying an order associated with a given ID that does not exist will result in an error message |
61| GET | /orders/{orderId}/payments | Retrieve the payments in the eCommerce system for the specified order |
62| GET | /orders/{orderId}/refunds | Retrieve the refunds in the eCommerce system for the specified order |
63
64### ping
65| Method | Path | Description |
66|--------|------|-------------|
67| GET | /ping | Ping the element to confirm that the hub element has a heartbeat. If the element does not have a heartbeat, an error message will be returned. |
68
69### products
70| Method | Path | Description |
71|--------|------|-------------|
72| POST | /products | Create a new product in eCommerce system.With the exception of the 'id' field, the required fields indicated in the 'Product' model are those required to create a new product |
73| GET | /products | Find products in the eCommerce system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. If no search expression is provided, all records will be retrieved |
74| PATCH | /products/{id} | Update a product associated with a given ID in the eCommerce system. The update API uses the PATCH HTTP verb, so only those fields provided in the product object will be updated, and those fields not provided will be left alone. Updating a product with a specified ID that does not exist will result in an error response. <p><strong>Update supports the following fields: sku, quantity, trackQuantity, quantityDelta, warningLimit, name, price, weight, tangible, enabled, fixedShippingRateOnly, fixedShippingRate, description, wholesalePrices, compareAtPrice, productClassId</strong> |
75| GET | /products/{id} | Retrieve a product associated with a given ID from the eCommerce system. Specifying a product with an ID that does not exist will result in an error response |
76| DELETE | /products/{id} | Delete a product associated with a given ID from your eCommerce system. Specifying a product associated with a given ID that does not exist will result in an error message |
77
78### {objectName}
79| Method | Path | Description |
80|--------|------|-------------|
81| GET | /{objectName} | Search for {objectName} |
82| POST | /{objectName} | Create an {objectName} |
83| DELETE | /{objectName}/{objectId} | Delete an {objectName} |
84| GET | /{objectName}/{objectId} | Retrieve an {objectName} |
85| PATCH | /{objectName}/{objectId} | Update an {objectName} |
86| PUT | /{objectName}/{objectId} | Update an {objectName} |
87| GET | /{objectName}/{objectId}/{childObjectName} | Search for {childObjectName} |
88| POST | /{objectName}/{objectId}/{childObjectName} | Create an {objectName} |
89| DELETE | /{objectName}/{objectId}/{childObjectName}/{childObjectId} | Delete an {childObjectName} |
90| GET | /{objectName}/{objectId}/{childObjectName}/{childObjectId} | Retrieve an {childObjectName} |
91| PATCH | /{objectName}/{objectId}/{childObjectName}/{childObjectId} | Update an {childObjectName} |
92| PUT | /{objectName}/{objectId}/{childObjectName}/{childObjectId} | Update an {childObjectName} |
93
94## Common Questions
95
96Match user requests to endpoints in references/api-spec.lap. Key patterns:
97- "Create a download?" -> POST /bulk/download
98- "List all jobs?" -> GET /bulk/jobs
99- "Create a query?" -> POST /bulk/query
100- "List all errors?" -> GET /bulk/{id}/errors
101- "List all status?" -> GET /bulk/{id}/status
102- "Get bulk details?" -> GET /bulk/{id}/{objectName}
103- "Create a customer?" -> POST /customers
104- "List all customers?" -> GET /customers
105- "Partially update a customer?" -> PATCH /customers/{id}
106- "Get customer details?" -> GET /customers/{id}
107- "Delete a customer?" -> DELETE /customers/{id}
108- "List all orders?" -> GET /customers/{id}/orders
109- "List all objects?" -> GET /objects
110- "List all docs?" -> GET /objects/{objectName}/docs
111- "List all metadata?" -> GET /objects/{objectName}/metadata
112- "Create a order?" -> POST /orders
113- "List all orders?" -> GET /orders
114- "Partially update a order?" -> PATCH /orders/{id}
115- "Get order details?" -> GET /orders/{id}
116- "Delete a order?" -> DELETE /orders/{id}
117- "List all payments?" -> GET /orders/{orderId}/payments
118- "List all refunds?" -> GET /orders/{orderId}/refunds
119- "List all ping?" -> GET /ping
120- "Create a product?" -> POST /products
121- "List all products?" -> GET /products
122- "Partially update a product?" -> PATCH /products/{id}
123- "Get product details?" -> GET /products/{id}
124- "Delete a product?" -> DELETE /products/{id}
125- "How to authenticate?" -> See Auth section
126
127## Response Tips
128- Check response schemas in references/api-spec.lap for field details
129- Create/update endpoints typically return the created/updated object
130
131## References
132- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
133
134> Generated from the official API spec by [LAP](https://lap.sh)
Lap-Platform