{"@context": "https://schema.org", "@type": "WebAPI", "name": "ecwid API", "description": "ecwid, an HTTP API described by an OpenAPI document.", "provider": {"@type": "Organization", "name": "cloud-elements.com"}, "documentation": "https://api.cloud-elements.com/elements/api-v2/elements/52/docs?version=-1"}
Index / APIs / cloud-elements.com

ecwid API

ecwid, an HTTP API described by an OpenAPI document.

Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.

Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.

base URLs: https://api.cloud-elements.com/elements/api-v2

find it by capability: POST /search {"query":{"text":"..."}} returns these operations with their invocation detail. Connect any agent client.

ecwid vapi-v2

ecwid, an HTTP API described by an OpenAPI document.

methodpathwhat the vendor says it does
POST/bulk/downloadCreate a new bulk download job (asynchronous) bulk
GET/bulk/jobsFetch all the bulk jobs for an instance bulk
POST/bulk/queryCreate an asynchronous bulk query job. bulk
PUT/bulk/{id}/cancelCancel an asynchronous bulk query job. bulk
GET/bulk/{id}/errorsRetrieve the errors of a bulk job. bulk
GET/bulk/{id}/statusRetrieve the status of a bulk job. bulk
GET/bulk/{id}/{objectName}Retrieve the results of an asynchronous bulk query. bulk
POST/bulk/{objectName}Upload a file of objects to be bulk uploaded to the provider. bulk
GET/customersFind customers in the eCommerce system, using the provided CEQL search expression. If no search expression is
POST/customersCreate a new customer in eCommerce system.With the exception of the 'id' field, the required fields indicated
GET/customers/{id}Retrieve a customer associated with a given ID from the eCommerce system. Specifying a customer with an ID tha
PATCH/customers/{id}Update an customer associated with a given ID in the eCommerce system.The update API uses the PATCH HTTP verb,
DELETE/customers/{id}Delete a customer associated with a given ID from your eCommerce system. Specifying a customer associated with
GET/customers/{id}/ordersFind orders in the customer associated with a given ID. If the customer does not exist, an error response will
GET/objectsGet a list of all the available objects. objects
GET/objects/{objectName}/docsGet swagger docs for an object. objects
GET/objects/{objectName}/metadataGet a list of all the field for an object. objects
GET/ordersFind orders in the eCommerce system, using the provided CEQL search expression. If no search expression is pro
POST/ordersCreate an order in the eCommerce system.With the exception of the 'id' field, the required fields indicated in
GET/orders/{id}Retrieve an order associated with a given ID from the eCommerce system. Specifying an order with an ID that do
PATCH/orders/{id}Update an order associated with a given ID in the eCommerce system. The update API uses the PATCH HTTP verb, s
DELETE/orders/{id}Delete an order associated with a given ID from your eCommerce system. Specifying an order associated with a g
GET/orders/{orderId}/paymentsRetrieve the payments in the eCommerce system for the specified order orders
GET/orders/{orderId}/refundsRetrieve the refunds in the eCommerce system for the specified order orders
GET/pingPing the Element to confirm that the Hub Element has a heartbeat. If the Element does not have a heartbeat, a
GET/productsFind products in the eCommerce system, using the provided CEQL search expression. The search expression in CEQ
POST/productsCreate a new product in eCommerce system.With the exception of the 'id' field, the required fields indicated i
GET/products/{id}Retrieve a product associated with a given ID from the eCommerce system. Specifying a product with an ID that
PATCH/products/{id}Update a product associated with a given ID in the eCommerce system. The update API uses the PATCH HTTP verb,
DELETE/products/{id}Delete a product associated with a given ID from your eCommerce system. Specifying a product associated with a
GET/{objectName}Search for {objectName} objectName
POST/{objectName}Create an {objectName} objectName
GET/{objectName}/{objectId}Retrieve an {objectName} objectName
PUT/{objectName}/{objectId}Update an {objectName} objectName
PATCH/{objectName}/{objectId}Update an {objectName} objectName
DELETE/{objectName}/{objectId}Delete an {objectName} objectName
GET/{objectName}/{objectId}/{childObjectName}Search for {childObjectName} objectName
POST/{objectName}/{objectId}/{childObjectName}Create an {objectName} objectName
GET/{objectName}/{objectId}/{childObjectName}/{childObjectId}Retrieve an {childObjectName} objectName
PUT/{objectName}/{objectId}/{childObjectName}/{childObjectId}Update an {childObjectName} objectName

and 2 more operation(s) in this specification, all searchable.

specification origin: https://api.cloud-elements.com/elements/api-v2/elements/52/docs?version=-1

nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.