Cloud Elements

ecwid

ecwid endpoints from Cloud Elements

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

ecwid endpoints from Cloud Elements

Endpoints 42

ping

  • GETPing 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./ping

objects

  • GETGet a list of all the available objects./objects
  • GETGet swagger docs for an object./objects/:objectName/docs?discovery=true&resolveReferences=true&basic=true&version=-1
  • GETGet a list of all the field for an object./objects/:objectName/metadata

objectName

  • GETSearch for {objectName}/:objectName?where=string&pageSize=0&nextPage=string&fields=string
  • POSTCreate an {objectName}/:objectName
  • GETRetrieve an {objectName}/:objectName/:objectId
  • PUTUpdate an {objectName}/:objectName/:objectId
  • DELETEDelete an {objectName}/:objectName/:objectId
  • PATCHUpdate an {objectName}/:objectName/:objectId
  • GETSearch for {childObjectName}/:objectName/:objectId/:childObjectName?where=string&pageSize=0&nextPage=string&fields=string
  • POSTCreate an {objectName}/:objectName/:objectId/:childObjectName
  • GETRetrieve an {childObjectName}/:objectName/:objectId/:childObjectName/:childObjectId
  • PUTUpdate an {childObjectName}/:objectName/:objectId/:childObjectName/:childObjectId
  • DELETEDelete an {childObjectName}/:objectName/:objectId/:childObjectName/:childObjectId
  • PATCHUpdate an {childObjectName}/:objectName/:objectId/:childObjectName/:childObjectId

orders

  • GETFind orders in the eCommerce system, using the provided CEQL search expression. If no search expression is provided, all records will be retrieved/orders?where=string&pageSize=0&nextPage=string&fields=string
  • POSTCreate 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/orders
  • GETRetrieve 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/orders/:id
  • DELETEDelete 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/orders/:id
  • PATCHUpdate 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>/orders/:id?action=string
  • GETRetrieve the payments in the eCommerce system for the specified order/orders/:orderId/payments?pageSize=0&nextPage=string&fields=string
  • GETRetrieve the refunds in the eCommerce system for the specified order/orders/:orderId/refunds?pageSize=0&nextPage=string&fields=string

customers

  • GETFind customers in the eCommerce system, using the provided CEQL search expression. If no search expression is provided, all records will be retrieved/customers?where=string&pageSize=0&nextPage=string&fields=string
  • POSTCreate 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/customers
  • GETRetrieve 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/customers/:id
  • DELETEDelete 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/customers/:id
  • PATCHUpdate 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/customers/:id
  • GETFind 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/customers/:id/orders?pageSize=0&nextPage=string&fields=string

bulk

  • POSTCreate a new bulk download job (asynchronous)/bulk/download
  • GETFetch all the bulk jobs for an instance/bulk/jobs?where=string&nextPage=string&pageSize=0&fields=string
  • POSTCreate an asynchronous bulk query job./bulk/query?q=string&lastRunDate=string&from=string&to=string
  • PUTCancel an asynchronous bulk query job./bulk/:id/cancel
  • GETRetrieve the errors of a bulk job./bulk/:id/errors?pageSize=0&nextPage=string&fields=string
  • GETRetrieve the status of a bulk job./bulk/:id/status
  • GETRetrieve the results of an asynchronous bulk query./bulk/:id/:objectName
  • POSTUpload a file of objects to be bulk uploaded to the provider./bulk/:objectName

products

  • GETFind 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/products?where=string&pageSize=0&nextPage=string&fields=string
  • POSTCreate 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/products
  • GETRetrieve 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/products/:id
  • DELETEDelete 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/products/:id
  • PATCHUpdate 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>/products/:id

API details

Base URL
https://api.cloud-elements.com/elements/api-v2
Authentication
None declared in the description
Operations
42 operations on 25 pathsGET 21POST 8PATCH 5DELETE 5PUT 3
Main resources
objectName 12bulk 8orders 7customers 6products 5objects 3ping 1
Description format
Swagger 2.0, API version api-v2
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the ecwid in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the ecwid collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “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.” (GET /ping), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the ecwid?

ecwid endpoints from Cloud Elements It is listed under E-commerce and has 42 endpoints.

Who publishes the ecwid?

It is listed from Cloud Elements's public API description (an OpenAPI document), not published by Cloud Elements on Swastik Codes. Anyone who controls cloud-elements.com can claim the profile by adding a DNS TXT record.

What is the base URL of the ecwid?

Requests go to https://api.cloud-elements.com/elements/api-v2. Endpoint paths are added to this base URL.

How do I authenticate with the ecwid?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the ecwid have?

42 operations on 25 paths (21 GET, 8 POST, 5 PATCH, 5 DELETE, 3 PUT). The largest groups are objectName, bulk, orders, customers.

Is forking the ecwid free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.