/bulk/download

Create a new bulk download job (asynchronous)

/bulk/query

Create an asynchronous bulk query job.

/bulk/{id}/cancel

Cancel an asynchronous bulk query job.

/bulk/{id}/errors

Retrieve the errors of a bulk job.

/bulk/{id}/status

Retrieve the status of a bulk job.

/bulk/{id}/{objectName}

Retrieve the results of an asynchronous bulk query.

/bulk/{objectName}

Upload a file of objects to be bulk uploaded to the provider.

/customers

Find customers in the eCommerce system, using the provided CEQL search expression. If no search expression is provided, all records will be retrieved

/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

/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

/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}/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

Get a list of all the available objects.

/objects/{objectName}/docs

Get swagger docs for an object.

/objects/{objectName}/metadata

Get a list of all the field for an object.

/orders

Find orders in the eCommerce system, using the provided CEQL search expression. If no search expression is provided, all records will be retrieved

/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

/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

/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

/orders/{orderId}/payments

Retrieve the payments in the eCommerce system for the specified order

/orders/{orderId}/refunds

Retrieve the refunds in the eCommerce system for the specified order

/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

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

/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

/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

/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. Update supports the following fields: sku, quantity, trackQuantity, quantityDelta, warningLimit, name, price, weight, tangible, enabled, fixedShippingRateOnly, fixedShippingRate, description, wholesalePrices, compareAtPrice, productClassId

/{objectName}

Search for {objectName}

/{objectName}

Create an {objectName}

/{objectName}/{objectId}

Delete an {objectName}

/{objectName}/{objectId}

Retrieve an {objectName}

/{objectName}/{objectId}

Update an {objectName}

/{objectName}/{objectId}

Update an {objectName}

/{objectName}/{objectId}/{childObjectName}

Search for {childObjectName}

/{objectName}/{objectId}/{childObjectName}

Create an {objectName}

/{objectName}/{objectId}/{childObjectName}/{childObjectId}

Delete an {childObjectName}

/{objectName}/{objectId}/{childObjectName}/{childObjectId}

Retrieve an {childObjectName}

/{objectName}/{objectId}/{childObjectName}/{childObjectId}

Update an {childObjectName}

/{objectName}/{objectId}/{childObjectName}/{childObjectId}

Update an {childObjectName}