https://cloud-elements.com42 endpoints available
/pingPing 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.
/ordersFind orders in the eCommerce system, using the provided CEQL search expression. If no search expression is provided, all records will be retrieved
/ordersCreate 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
/objectsGet a list of all the available objects.
/productsFind 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
/productsCreate 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
/bulk/jobsFetch all the bulk jobs for an instance
/customersFind customers in the eCommerce system, using the provided CEQL search expression. If no search expression is provided, all records will be retrieved
/customersCreate 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
/bulk/queryCreate an asynchronous bulk query job.
/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
/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>
/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
/{objectName}Search for {objectName}
/{objectName}Create an {objectName}
/bulk/downloadCreate a new bulk download job (asynchronous)
/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
/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>
/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
/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
/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
/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
/bulk/{id}/cancelCancel an asynchronous bulk query job.
/bulk/{id}/errorsRetrieve the errors of a bulk job.
/bulk/{id}/statusRetrieve the status of a bulk job.
/bulk/{objectName}Upload a file of objects to be bulk uploaded to the provider.
/customers/{id}/ordersFind 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
/bulk/{id}/{objectName}Retrieve the results of an asynchronous bulk query.
/{objectName}/{objectId}Retrieve an {objectName}
/{objectName}/{objectId}Update an {objectName}
/{objectName}/{objectId}Update an {objectName}
/{objectName}/{objectId}Delete an {objectName}
/orders/{orderId}/refundsRetrieve the refunds in the eCommerce system for the specified order
/objects/{objectName}/docsGet swagger docs for an object.
/orders/{orderId}/paymentsRetrieve the payments in the eCommerce system for the specified order
/objects/{objectName}/metadataGet a list of all the field for an object.
/{objectName}/{objectId}/{childObjectName}Search for {childObjectName}
/{objectName}/{objectId}/{childObjectName}Create an {objectName}
/{objectName}/{objectId}/{childObjectName}/{childObjectId}Retrieve an {childObjectName}
/{objectName}/{objectId}/{childObjectName}/{childObjectId}Update an {childObjectName}
/{objectName}/{objectId}/{childObjectName}/{childObjectId}Update an {childObjectName}
/{objectName}/{objectId}/{childObjectName}/{childObjectId}Delete an {childObjectName}
https://cloud-elements.com42 endpoints available
/pingPing 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.
/ordersFind orders in the eCommerce system, using the provided CEQL search expression. If no search expression is provided, all records will be retrieved
/ordersCreate 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
/objectsGet a list of all the available objects.
/productsFind 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
/productsCreate 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
/bulk/jobsFetch all the bulk jobs for an instance
/customersFind customers in the eCommerce system, using the provided CEQL search expression. If no search expression is provided, all records will be retrieved
/customersCreate 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
/bulk/queryCreate an asynchronous bulk query job.
/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
/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>
/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
/{objectName}Search for {objectName}
/{objectName}Create an {objectName}
/bulk/downloadCreate a new bulk download job (asynchronous)
/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
/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>
/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
/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
/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
/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
/bulk/{id}/cancelCancel an asynchronous bulk query job.
/bulk/{id}/errorsRetrieve the errors of a bulk job.
/bulk/{id}/statusRetrieve the status of a bulk job.
/bulk/{objectName}Upload a file of objects to be bulk uploaded to the provider.
/customers/{id}/ordersFind 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
/bulk/{id}/{objectName}Retrieve the results of an asynchronous bulk query.
/{objectName}/{objectId}Retrieve an {objectName}
/{objectName}/{objectId}Update an {objectName}
/{objectName}/{objectId}Update an {objectName}
/{objectName}/{objectId}Delete an {objectName}
/orders/{orderId}/refundsRetrieve the refunds in the eCommerce system for the specified order
/objects/{objectName}/docsGet swagger docs for an object.
/orders/{orderId}/paymentsRetrieve the payments in the eCommerce system for the specified order
/objects/{objectName}/metadataGet a list of all the field for an object.
/{objectName}/{objectId}/{childObjectName}Search for {childObjectName}
/{objectName}/{objectId}/{childObjectName}Create an {objectName}
/{objectName}/{objectId}/{childObjectName}/{childObjectId}Retrieve an {childObjectName}
/{objectName}/{objectId}/{childObjectName}/{childObjectId}Update an {childObjectName}
/{objectName}/{objectId}/{childObjectName}/{childObjectId}Update an {childObjectName}
/{objectName}/{objectId}/{childObjectName}/{childObjectId}Delete an {childObjectName}