Clover POS¶
The Clover POS modules allow you to search, retrieve, create, update, and delete the customers, orders, line items from your Clover POS account.
Getting Started with Clover POS¶
Prerequisites
- A Clover POS account - create an account at clover.com.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting Clover POS to Ibexa Connect¶
To connect your Clover POS account to Ibexa Connect you need to obtain the API Key from your Clover POS account and insert it in the Create a connection dialog in the Ibexa Connect module.
1. Log in to your Clover POS account.
2. Copy the API Key to your clipboard.
3. Log in to your Ibexa Connect account, add a module from the Clover POS app into an Ibexa Connect scenario.
4. Click Add next to the Connection field.
5. In the Connection name field, enter a name for the connection.
6. In the API Key enter the details copied in step 3 and click Continue.
The connection has been established.
Customers¶
Search Customers¶
Searches for customers or lists them all.
Get a Customer¶
Retrieves an existing customer.
Get List of Customers in CSV¶
Retrieves all customers in CSV format.
Create a Customer¶
Creates a new customer.
Update a Customer¶
Updates an existing customer.
Delete a Customer¶
Deletes an existing customer.
Orders¶
Search Orders¶
Searches for orders or lists them all.
Get an Order¶
Retrieves an existing order.
Delete an Order¶
Deletes an existing order.
Line Items¶
List Line Items¶
Retrieves a list of line items.
Get a Line Item¶
Retrieves an existing line item.
Delete a Line Item¶
Deletes an existing line item.
Others¶
Make an API Call¶
Performs an arbitrary authorized API Call.
URL |
Enter a path relative to |
Method |
Select the HTTP method you want to use: 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¶
The following API call returns all the orders from your Amazing Marvin account:
URL: /v1/orders
Method: GET
Matches of the search can be found in the module's Output under Bundle > Body. In our example, 9 orders were returned: