Active
This application does not need additional settings. So you can make connection only by using your login credentials or by following the instructions below .

CommerceHQ

With CommerceHQ modules in Boost.space Integrator, you can:

watch, create, update, retrieve, list, and delete customers
create, update, retrieve, list, and delete collections
watch new and updated products, create, update, retrieve, list, and delete products
watch new paid orders and ship orders

To get started with CommerceHQ, create an account at commercehq.com

Connect CommerceHQ to Boost.space Integrator

To connect CommerceHQ app, you need to obtain the Store name, API Key, and API Password from your CommerceHQ account and insert them in to the CommerceHQ module scenario.

Log in to your CommerceHQ account.
Click Dashboard > Apps Store.
Click Add a Private App.
Enter a name for the app and click Add The Private App.
Copy the API Key and API Password to a safe place.
Log in to your Boost.space Integrator, insert a Boost.space Integrator module in your scenario, and click the Add button next to the Connection field.
In the Connection name field, enter a name for the connection.
In the Store field enter your domain from https://example.commercehq.com/ here the store name is example.
In the API Key and API Password fields, enter the details copied in step 5 and click Save.

You have successfully established the connection. You can now begin editing scenarios and adding more CommerceHQ modules. If your connection needs reauthorization at any point, follow the connection renewal steps here.

Customers

You can watch, create, update, retrieve, list, and delete customers using the following modules.

Watch New Customers

Triggers when a new customer is created.

Connection	Establish a connection to your CommerceHQ account.
Limit	Set the maximum number of customers Boost.space Integrator will return during one execution cycle. The default value is 10.

Create a Customer

Creates a new customer.

Connection

Establish a connection to your CommerceHQ account.

For field descriptions, see the CommerceHQ Customers API reference.

Update a Customer

Updates an existing customer.

Connection	Establish a connection to your CommerceHQ account.
Customer ID	Select or map the Customer ID whose details you want to update.

For field descriptions, see the CommerceHQ Customers API reference.

Get a Customer

Gets information on a single customer.

Connection	Establish a connection to your CommerceHQ account.
Customer ID	Select or map the Customer ID whose details you want to retrieve.

List Customers

Gets all customers.

Connection	Establish a connection to your CommerceHQ account.
Direction	Select the direction to display customers. For example, `ASC`.
Sort by	Select the option to sort the customers. For example, `email`.
Limit	Set the maximum number of customers Boost.space Integrator will return during one execution cycle. The default value is 10.

For field descriptions, see the CommerceHQ Customers API reference.

Delete a Customer

Deletes an existing customer. Only customers without orders can be deleted.

Connection	Establish a connection to your CommerceHQ account.
Customer ID	Select or map the Customer ID you want to delete.

Collections

You can create, update, retrieve, list, and delete collections using the following modules.

Create a Collection

Creates a new collection.

Connection

Establish a connection to your CommerceHQ account.

For field descriptions, see the CommerceHQ Collections API reference.

Update a Collection

Updates an existing collection.

Connection	Establish a connection to your CommerceHQ account.
Collection ID	Select or map the Collection ID whose details you want to update.

For field descriptions, see the CommerceHQ Collections API reference.

Get a Collection

Gets information on a collection.

Connection	Establish a connection to your CommerceHQ account.
Collection ID	Select or map the Collection ID whose details you want to retrieve.

List Collections

Gets all collections.

Connection	Establish a connection to your CommerceHQ account.
Direction	Select the direction to list collections. For example, `ASC`.
Limit	Set the maximum number of collections Boost.space Integrator will return during one execution cycle. The default value is 10.

Delete a Collection

Deletes an existing collection.

Connection	Establish a connection to your CommerceHQ account.
Collection ID	Select or map the Collection ID you want to delete.

Products

You can watch new and updated products, and create, update, retrieve, list, and delete products using the following modules.

Watch New Products

Triggers when a new product is created.

Connection	Establish a connection to your CommerceHQ account.
Limit	Set the maximum number of new products Boost.space Integrator will return during one execution cycle. The default value is 10.

Watch Updated Products

Triggers when an existing product is updated.

Connection	Establish a connection to your CommerceHQ account.
Limit	Set the maximum number of updated products Boost.space Integrator will return during one execution cycle. The default value is 10.

Create a Product

Creates a new product.

Connection

Establish a connection to your CommerceHQ account.

For field descriptions, see the CommerceHQ Products API reference.

Update a Product

Updates an existing product. If it has been purchased before, its data will remain untouched in orders.

Connection	Establish a connection to your CommerceHQ account.
Product ID	Select or map the Product ID whose details you want to update.

For field descriptions, see the CommerceHQ Products API reference.

Get a Product

Gets information on a product.

Connection	Establish a connection to your CommerceHQ account.
Product ID	Select or map the Product ID whose details you want to retrieve.

List Products

Gets all products.

Connection	Establish a connection to your CommerceHQ account.
Limit	Set the maximum number of products Boost.space Integrator will return during one execution cycle. The default value is 10.

For field descriptions, see the CommerceHQ Products API reference.

Delete a Product

Deletes an existing product. If it has been purchased before, its data will remain untouched in orders.

Connection	Establish a connection to your CommerceHQ account.
Product ID	Select or map the Product ID you want to delete.

Orders

You can watch new paid orders and ship orders using the following modules.

Watch New Paid Orders

Triggers when new paid order is created.

Connection	Establish a connection to your CommerceHQ account.
Limit	Set the maximum number of paid orders Boost.space Integrator will return during one execution cycle. The default value is 10.

Ship Order

Marks order as shipped.

Connection	Establish a connection to your CommerceHQ account.
Order ID	Select or map the Order ID whose order you want to ship.
Fulfillment ID	Select or map the Fulfilment ID of the order.
Shipping Carrier	Select or map the shipping carrier applicable to the order.
Tracking Number	Enter the tracking number of the shipment.
Notify	Select whether to send an email notification to the user about the shipment.

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized API call.

	Note
	For the list of available endpoints, refer to the CommerceHQ API documentation.

Connection	Establish a connection to your CommerceHQ account.
URL	Enter a path relative to `https://makedev.commercehq.com/api`. For example, `/v1/products`.
Method	GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry.
Headers	Enter the desired request headers. You don’t have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Example of use – List Customers

The following API call returns all customers from your account.

URL: /v1/customers

Method: GET

The search matches can be found in the module’s Output under Bundle > Body > items.

In our example, 5 customers returned: