Clover API updates - July 2021
Clover made the following API updates for July 2021.
Ecommerce
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.
Inventory
New GET
method for tag_items endpoint
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"
Order printing API
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.
Payments
You can now include additional_charges
as an expansion in requests for the following endpoints:
- Get all payments
- Get all payments for an order
- Get a single authorization
- Get a single payment
- Get all payments under an employee
Documentation
- Corrected the list of expansion fields for the Get all items in a single category endpoint