Clover made the following API updates for March 2022.
Added a new rule to v1/refunds for fraud prevention—transaction limits. With this enhancement, merchants can now set a maximum limit for a single refund using the Ecomm Fraud Prevention Transaction Limits rule. Transactions that are attempted above the configured threshold will fail.
Clover made the following API updates for February 2022.
Added a new endpoint v1/refunds for the partial refund of a transaction that has a surcharge but doesn't have a tip amount, line item, or tax.
Clover made the following Ecommerce API updates for January 2022.
Clover introduced Recurring Payments and Subscriptions APIs in February 2022. These APIs allow setting up recurring charges on a periodical basis, such as monthly or weekly. Customers can be charged on a finite basis, for example, a payoff installment for 6 months, or infinite, for example, a streaming subscription. The subscription service processes each invoice at the configured date.
Clover introduced Invoicing APIs. These APIs allow merchants the ability to get paid. An invoice can be a one-time invoice or a recurring invoice sent on a regular basis, such as a subscription.
Clover made the following API updates for October 2021.
Added a new endpoint, /v1/device/reset, which resets the device to its initial state and cancels any in-flight commands from the point of sale (POS). To cancel one or more in-flight commands without resetting the device, use the /v1/device/cancel endpoint.
Clover made the following API updates for September 2021.
colorCode property for items and categoriesWhen creating or updating an inventory item or category, you can set a color to represent the item or category and make it easier for merchants to visually group items. This color code appears in the Register and Dining apps, as well as the Inventory page of the merchant web dashboard.
IMPORTANT
Beginning in February 2022, Clover will no longer allow apps to send auth tokens in URLs. Instead, API tokens will need to be included in the Authorization header.
For more information, see Use API tokens.
Clover made the following API updates for August 2021.
Added new properties to make it easier to manage the state of a merchant's inventory. The available boolean has been added to both Item and Modifier. This property can be used to indicate whether the item or modifier is currently purchasable. The autoManage property on an Item allows you to let Clover automatically make an item unavailable for purchase when its stock count reaches zero.
A new layout for the API reference is now live! The new design loads faster and shows one endpoint at a time so you can concentrate on the task at hand. Code samples are available for more languages and frameworks, and you can continue testing Clover APIs in your browser.
Updated API reference
Updated the authorization method used in the API reference docs to HTTP header auth. This change makes it easier for you to correctly authorize test API calls, as support for URL authorization is now deprecated.
IMPORTANT
Beginning in February 2022, Clover will no longer allow apps to send auth tokens in URLs. Instead, API tokens will need to be included in the Authorization header.
For more information, see Use API tokens.
Clover made the following API updates for July 2021.
Charge requests can now include level 2 data to better support merchants processing purchase card transactions. See the Levels and processing of purchasing cards and the Charges API documentation for more information.
GET method for tag_items endpointYou can now retrieve a list of a merchant's tag-to-item associations with a single API call. This endpoint returns an array of association objects listing the UUIDs of the tag and item comprising each association.
curl --request GET \
--url https://sandbox.dev.clover.com/v3/merchants/{mId}/tag_items \
--header 'Accept: application/json'
"elements": [
{
"tag": {
"id": "4TQY3QE1HW55P"
},
"item": {
"id": "HQ6Q9WMX944SP"
}
},
{
"tag": {
"id": "7YGR7YK7YJX7A"
},
"item": {
"id": "HQ6Q9WMX944SP"
}
},
{
"tag": {
"id": "8AEJKA95NQVWY"
},
"item": {
"id": "0XY9AX0X3YRKM"
}
},
{
"tag": {
"id": "8AEJKA95NQVWY"
},
"item": {
"id": "BDNXWPRCJQC7C"
}
},
{
"tag": {
"id": "8AEJKA95NQVWY"
},
"item": {
"id": "2MCPW4RT2HWAT"
}
},
{
"tag": {
"id": "8AEJKA95NQVWY"
},
"item": {
"id": "Q2KHKF107EXF4"
Introduced a new API that allows you to send print jobs directly to a merchant's order printer.
The POST /v3/merchants/{mId}/print_event endpoint takes an order UUID and prints the order receipt using the merchant's selected receipt options.
curl --request POST \
--url https://sandbox.dev.clover.com/v3/merchants/{mId}/print_event \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"orderRef": {"id": "HQ6Q9WMX944SP"}}
{
"id": "WNSZ2D0WX884W",
"orderRef": {
"id": "HQ6Q9WMX944SP"
},
"deviceRef": {
"id": "926766ca-5636-8598-e959-6e3c6fe047e1"
},
"state": "CREATED",
"createdTime": 1626896196000,
"modifiedTime": 1626896196000,
"printTime": 1626896196000
}
See Print orders with the REST API for more information.
You can now include additional_charges as an expansion in requests for the following endpoints:
Clover made the following API update for April 2021.
When using the /v3/merchants/{merchantId}/items endpoint, you can now add the itemStock.quantity filter to retrieve items based on the number the merchant has in stock. The following comparison operators are supported:
< - less than> - greater than <= - less than or equal to>= - greater than or equal to= - equal to!= - not equal toFor example, if you set itemStock.quantity<=20, the response contains only the items with stockCount less than or equal to 20.
To subscribe to Clover's developer changelog, add the changelog main page as a source in your RSS reader.
Clover made the following API documentation updates for March 2021.
The documentation for the following endpoints has been updated with information about error messages and how to fix your requests to resolve the issue.
To subscribe to Clover's developer changelog, add to the changelog main page as a source in your RSS reader.
Clover made the following API documentation update for February 2021: