/bulk/jobs

Fetch all the bulk jobs for an instance

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• where (query) — The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example to get all upload jobs the expression would be where=job_direction='UPLOAD'. The following fields are valid search fields 'object_name', 'job_status', 'job_direction', 'record_count'
• nextPage (query) — The next page cursor, taken from the response header: `elements-next-page-token`
• pageSize (query, limit) — The page size for pagination, which defaults to 200 if not supplied
• fields (query) — The fields to return on the response. Can be a single field or a comma-separated list of fields

/bulk/download

Create a new bulk download job (asynchronous)

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'

/bulk/query

Create an asynchronous bulk query job.

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• Elements-Async-Callback-Url (header) — The Url to send the notification to when the Job is completed
• q (query) — The CEQL query. When this parameter is omitted, all objects of the given type are returned via the bulk job. Endpoint limiters may still apply.
• lastRunDate (query) — The last time this query was run. This is optional. You can also have this parameter in the query and leave this blank - optional eg. '2014-10-06T13:22:17-08:00'
• from (query) — The created/updated date of the object to filter on - optional eg. '2014-10-06T13:22:17-08:00'
• to (query) — The created/updated date of the object to filter on - optional eg. '2014-10-06T13:22:17-08:00'

/bulk/{id}/cancel

Cancel an asynchronous bulk query job.

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• id (path, required) — The ID of the bulk job to cancel.

/bulk/{id}/errors

Retrieve the errors of a bulk job.

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• id (path, required) — The ID of the bulk job to retrieve its errors.
• pageSize (query, limit) — The page size for pagination, which defaults to 200 if not supplied
• nextPage (query) — The next page cursor, taken from the response header: `elements-next-page-token`
• fields (query) — The fields to return on the response. Can be a single field or a comma-separated list of fields

/bulk/{id}/status

Retrieve the status of a bulk job.

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• id (path, required) — The ID of the bulk job to retrieve its status.

/bulk/{id}/{objectName}

Retrieve the results of an asynchronous bulk query.

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• id (path, required) — The ID of the bulk job
• objectName (path, required) — The name of the object

/bulk/{objectName}

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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• Elements-Async-Callback-Url (header) — The Url to send the notification to when the Job is completed
• objectName (path, required) — The name of the object for which data needs to be uploaded.

/customers

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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• where (query) — The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query (i.e. field='value'). Supported search terms: customer_id and customer_email. All other search criteria are ignored. NOTE: When searching by customer_id, do not quote the value (ex: customer_id=15693430), as the ID is a number rather than a string. When searching by email, quote the value (ex: customer_email='a@b.c'), as the email parameter is a string
• pageSize (query, limit) — The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned
• nextPage (query) — The next page cursor, taken from the response header: `elements-next-page-token`
• fields (query) — The fields to return on the response. Can be a single field or a comma-separated list of fields

/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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'

/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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• id (path, required) — The ID of the customer to delete from the eCommerce system

/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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• id (path, required) — The ID of the customer to retrieve from the eCommerce system

/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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• id (path, required) — The ID of the customer to update in the eCommerce system

/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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• id (path, required) — The ID of the customer to get orders form in the eCommerce system
• pageSize (query, limit) — The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned
• nextPage (query) — The next page cursor, taken from the response header: `elements-next-page-token`
• fields (query) — The fields to return on the response. Can be a single field or a comma-separated list of fields

/objects

Get a list of all the available objects.

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• Elements-Version (header) — Elements Version to be used for getting metadata, possible options are Hydrogen, Helium. Default value is Hydrogen

/objects/{objectName}/docs

Get swagger docs for an object.

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• objectName (path, required) — The name of the object
• discovery (query) — Include discovery metadata in definitions
• resolveReferences (query) — Optionally resolve swagger references for an inline object definition
• basic (query) — Include only OpenAPI / Swagger properties in definitions
• version (query) — The element swagger version to get the corresponding element swagger, Passing in "-1" gives latest element swagger

/objects/{objectName}/metadata

Get a list of all the field for an object.

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• objectName (path, required) — The name of the object
• Elements-Version (header) — Elements Version to be used for getting metadata, possible options are Hydrogen, Helium. Default value is Hydrogen

/orders

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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• where (query) — The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query (i.e. field='value'). Supported search terms: date, from_date, to_date, from_update_date, to_update_date, order, from_order, to_order, customer_id, customer_email and statuses. All other search criteria are ignored
• pageSize (query, limit) — The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned
• nextPage (query) — The next page cursor, taken from the response header: `elements-next-page-token`
• fields (query) — The fields to return on the response. Can be a single field or a comma-separated list of fields

/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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'

/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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• id (path, required) — The ID of the order to delete from the eCommerce system

/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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• id (path, required) — The ID of the order to retrieve from the eCommerce system

/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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• id (path, required) — The ID of the order to update in the eCommerce system
• action (query) — An action to perform on the order: cancel, reopen or close. If left blank then the order is updated but no action is taken

/orders/{orderId}/payments

Retrieve the payments in the eCommerce system for the specified order

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• orderId (path, required) — The ID of the order to retrieve payments from in the eCommerce system
• pageSize (query, limit) — The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned
• nextPage (query) — The next page cursor, taken from the response header: `elements-next-page-token`
• fields (query) — The fields to return on the response. Can be a single field or a comma-separated list of fields

/orders/{orderId}/refunds

Retrieve the refunds in the eCommerce system for the specified order

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• orderId (path, required) — The ID of the order to retrieve refunds from in the eCommerce system
• pageSize (query, limit) — The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned
• nextPage (query) — The next page cursor, taken from the response header: `elements-next-page-token`
• fields (query) — The fields to return on the response. Can be a single field or a comma-separated list of fields

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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'

/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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• where (query) — The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query (i.e. field='value'). Supported search terms: category, hidden_products. All other search criteria are ignored
• pageSize (query, limit) — The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned
• nextPage (query) — The next page cursor, taken from the response header: `elements-next-page-token`
• fields (query) — The fields to return on the response. Can be a single field or a comma-separated list of fields

/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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'

/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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• id (path, required) — The ID of the product to delete from the eCommerce system

/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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• id (path, required) — The ID of the product to retrieve from the eCommerce system

/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

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• id (path, required) — The ID of the product to update in the eCommerce system

/{objectName}

Search for {objectName}

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• objectName (path, required) — The name of the object
• where (query) — The CEQL search expression.
• pageSize (query, limit) — The page size. Defaults to 200 if not provided. Maximum of 5000.
• nextPage (query) — The next page cursor, taken from the response header: `elements-next-page-token`
• fields (query) — The fields to return on the response. Can be a single field or a comma-separated list of fields

/{objectName}

Create an {objectName}

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• objectName (path, required) — The name of the object

/{objectName}/{objectId}

Delete an {objectName}

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• objectName (path, required) — The name of the object
• objectId (path, required) — The {objectName} ID

/{objectName}/{objectId}

Retrieve an {objectName}

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• objectName (path, required) — The name of the object
• objectId (path, required) — The {objectName} ID

/{objectName}/{objectId}

Update an {objectName}

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• objectName (path, required) — The name of the object
• objectId (path, required) — The {objectName} ID

/{objectName}/{objectId}

Update an {objectName}

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• objectName (path, required) — The name of the object
• objectId (path, required) — The {objectName} ID

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

Search for {childObjectName}

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• objectName (path, required) — The name of the object
• objectId (path, required) — The {objectName} ID
• childObjectName (path, required) — The name of the childObjectName
• where (query) — The CEQL search expression.
• pageSize (query, limit) — The page size. Defaults to 200 if not provided. Maximum of 5000.
• nextPage (query) — The next page cursor, taken from the response header: `elements-next-page-token`
• fields (query) — The fields to return on the response. Can be a single field or a comma-separated list of fields

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

Create an {objectName}

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• objectName (path, required) — The name of the object
• objectId (path, required) — The {objectName} ID
• childObjectName (path, required) — The name of the object

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

Delete an {childObjectName}

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• objectName (path, required) — The name of the object
• childObjectName (path, required) — The name of the childObjectName
• objectId (path, required) — The {objectName} ID
• childObjectId (path, required) — The {childObjectName} ID

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

Retrieve an {childObjectName}

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• objectName (path, required) — The name of the object
• childObjectName (path, required) — The name of the childObjectName
• objectId (path, required) — The {objectName} ID
• childObjectId (path, required) — The {childObjectName} ID

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

Update an {childObjectName}

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• objectName (path, required) — The name of the object
• childObjectName (path, required) — The name of the childObjectName
• objectId (path, required) — The {objectName} ID
• childObjectId (path, required) — The {childObjectName} ID

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

Update an {childObjectName}

• Authorization (header, required) — The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'
• objectName (path, required) — The name of the object
• childObjectName (path, required) — The name of the childObjectName
• objectId (path, required) — The {objectName} ID
• childObjectId (path, required) — The {childObjectName} ID