Clover

App · 24 actions

Work with your Clover point of sale: create and update orders and their line items, look up payments and refunds, manage customers, inventory items, prices and stock, and list categories and employees.

Actions

ActionWhat it does
Add line itemAdd one thing bought to an order: an item from your inventory, or a custom line with its own name and price.
Create customerAdd a customer to Clover with a name, email, phone, business name, note and address.
Create inventory itemAdd an item to sell, with its price, and put it in a category if you like.
Create orderStart a new open order in Clover, with a title, note and order type if you like.
Delete customerDelete a customer from Clover for good.
Delete inventory itemDelete an item from your inventory for good.
Delete orderDelete an order from Clover for good.
Get customerGet one customer with their emails, phone numbers, addresses and notes.
Get inventory itemGet one inventory item with its price, stock, categories and tags.
Get merchantGet the connected Clover business: its name, id and address.
Get orderGet one order with its line items, payments, refunds and customers.
Get paymentGet one payment with its amount, tip, tax, how it was paid and any refunds.
List categoriesList the categories your items are grouped in on the register.
List customersList customers, or find them by exact email, phone number, first name or last name.
List employeesList the business's employees with their names, emails and roles.
List inventory itemsList the items you sell, with their price, stock and categories, or find them by exact name or SKU.
List ordersList orders, optionally only those created in a time range or in one state, with their line items if you like.
List paymentsList payments taken, optionally only those in a time range or with one result.
List refundsList refunds, optionally only those in a time range or for one payment.
Remove line itemTake a line item off an order.
Set item stockSet how many of an item are in stock.
Update customerChange a customer's name, business name or note.
Update inventory itemChange an item's name, price, SKU, product code, cost or whether it shows on the register.
Update orderChange an order's title, note or order type.

Add line item

Add one thing bought to an order: an item from your inventory, or a custom line with its own name and price.

Inputs

Order IDorder_idtextRequired
The order's id, from 'List orders' or an earlier step.
Inventory itemitem_idtext
The item sold. Leave empty for a custom line, and give a name and price instead.
Namenametext
The line's name. Needed for a custom line; for an inventory item, leave empty to use the item's own.
Pricepricenumber
The price, such as 4.50. Needed for a custom line; for an inventory item, leave empty to use the item's own.At least 0.
Notenotetext
A note on this line, such as 'no ice'.

Outputs

line_itemobject
The line item added
Example output
{
  "line_item": {
    "createdTime": 1762419600000,
    "id": "Q1XW8ZK3N5R7T",
    "item": {
      "id": "J9R4BXNQ2M1KE"
    },
    "name": "Cold brew",
    "note": "Oat milk",
    "price": 450,
    "refunded": false
  }
}

Create customer

Add a customer to Clover with a name, email, phone, business name, note and address. Give at least a name, email or phone.

Inputs

First namefirst_nametext
Their first name.
Last namelast_nametext
Their last name.
Emailemailtext
Their email address.
Phonephonetext
Their phone number.
Business namebusiness_nametext
The business they buy for.
Notenotetext
A note about the customer.
Street addressaddress1text
The first line of their address.
Citycitytext
The city of their address.
State or provincestatetext
The state or province.
Postal codezip_codetext
The ZIP or postal code.
Countrycountrytext
The country, such as US.

Outputs

customerobject
The customer
Example output
{
  "customer": {
    "addresses": {
      "elements": [
        {
          "address1": "12 Market St",
          "address2": "",
          "address3": "",
          "city": "Springfield",
          "country": "US",
          "state": "IL",
          "zip": "62701"
        }
      ]
    },
    "customerSince": 1762419600000,
    "emailAddresses": {
      "elements": [
        {
          "emailAddress": "jo@example.com",
          "id": "E1A2B3C4D5E6F",
          "primaryEmail": true
        }
      ]
    },
    "firstName": "Jo",
    "id": "C5X1V9B3N7M2L",
    "lastName": "Bloggs",
    "marketingAllowed": false,
    "metadata": {
      "businessName": "Bloggs Bakery",
      "note": "Prefers email"
    },
    "phoneNumbers": {
      "elements": [
        {
          "id": "P1A2B3C4D5E6F",
          "phoneNumber": "555-0100"
        }
      ]
    }
  }
}

Create inventory item

Add an item to sell, with its price, and put it in a category if you like. Set how many are in stock with 'Set item stock'.

Inputs

NamenametextRequired
The item's name, as it shows on the register.
PricepricenumberRequired
The price, such as 4.50.At least 0.
Price typeprice_typetext
How it is priced. Clover's default is a fixed price.One of: FIXED (Fixed price), VARIABLE (Price entered at sale), PER_UNIT (Price per unit (such as per pound)).
SKUskutext
Your stock keeping unit for the item.
Product codecodetext
Its barcode number, such as a UPC or EAN.
Costcostnumber
What the item costs you, such as 1.20.At least 0.
On the registervisibilitytext
Whether the item shows on the register for staff to sell.One of: shown (Shown on the register), hidden (Hidden from the register).
Categorycategory_idtext
A category to put the item in.

Outputs

added_to_categorytrue/false
True when it was put in the category
itemobject
The item created
Example output
{
  "added_to_category": true,
  "item": {
    "available": true,
    "categories": {
      "elements": [
        {
          "id": "D8F2G6H1J4K9L",
          "modifiedTime": 1762419600000,
          "name": "Drinks",
          "sortOrder": 1
        }
      ]
    },
    "code": "012345678905",
    "cost": 120,
    "hidden": false,
    "id": "J9R4BXNQ2M1KE",
    "itemStock": {
      "item": {
        "id": "J9R4BXNQ2M1KE"
      },
      "modifiedTime": 1762419600000,
      "quantity": 24,
      "stockAlertThreshold": 5
    },
    "modifiedTime": 1762419600000,
    "name": "Cold brew",
    "price": 450,
    "priceType": "FIXED",
    "sku": "CB-16"
  }
}

Create order

Start a new open order in Clover, with a title, note and order type if you like. Add what was bought with 'Add line item'.

Inputs

Titletitletext
A title for the order, shown in Clover's Orders app.
Notenotetext
A note on the order, which can print on the receipt.
Order typeorder_type_idtext
The order type, such as dine in or to go, as set up in Clover.

Outputs

orderobject
The order
Example output
{
  "order": {
    "createdTime": 1762419600000,
    "currency": "USD",
    "employee": {
      "id": "QT0DES4CXR572"
    },
    "id": "KMAAH8QS60Z7A",
    "lineItems": {
      "elements": []
    },
    "modifiedTime": 1762419650000,
    "note": "No onions",
    "orderType": {
      "id": "6Z0YH1PKQ5E2C",
      "label": "Dine in",
      "taxable": true
    },
    "payType": "FULL",
    "paymentState": "OPEN",
    "payments": {
      "elements": [
        {
          "amount": 1250,
          "createdTime": 1762419700000,
          "employee": {
            "id": "QT0DES4CXR572"
          },
          "externalPaymentId": "",
          "id": "8VK2M4QZP0R6A",
          "modifiedTime": 1762419700000,
          "order": {
            "id": "KMAAH8QS60Z7A"
          },
          "result": "SUCCESS",
          "taxAmount": 100,
          "tender": {
            "id": "T3N9S8C1V0BZE",
            "label": "Credit Card",
            "labelKey": "com.clover.tender.credit_card"
          },
          "tipAmount": 200
        }
      ]
    },
    "state": "open",
    "testMode": false,
    "title": "Table 4",
    "total": 0
  }
}

Delete customer

Delete a customer from Clover for good.

Inputs

Customer IDcustomer_idtextRequired
The customer's id, from 'List customers' or an earlier step.

Outputs

customer_idtext
The customer deleted
deletedtrue/false
Always true once done
Example output
{
  "customer_id": "C5X1V9B3N7M2L",
  "deleted": true
}

Delete inventory item

Delete an item from your inventory for good.

Inputs

Itemitem_idtextRequired
The inventory item. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once done
item_idtext
The item deleted
Example output
{
  "deleted": true,
  "item_id": "J9R4BXNQ2M1KE"
}

Delete order

Delete an order from Clover for good.

Inputs

Order IDorder_idtextRequired
The order's id, from 'List orders' or an earlier step.

Outputs

deletedtrue/false
Always true once done
order_idtext
The order deleted
Example output
{
  "deleted": true,
  "order_id": "KMAAH8QS60Z7A"
}

Get customer

Get one customer with their emails, phone numbers, addresses and notes.

Inputs

Customer IDcustomer_idtextRequired
The customer's id, from 'List customers' or an earlier step.

Outputs

customerobject
The customer
Example output
{
  "customer": {
    "addresses": {
      "elements": [
        {
          "address1": "12 Market St",
          "address2": "",
          "address3": "",
          "city": "Springfield",
          "country": "US",
          "state": "IL",
          "zip": "62701"
        }
      ]
    },
    "customerSince": 1762419600000,
    "emailAddresses": {
      "elements": [
        {
          "emailAddress": "jo@example.com",
          "id": "E1A2B3C4D5E6F",
          "primaryEmail": true
        }
      ]
    },
    "firstName": "Jo",
    "id": "C5X1V9B3N7M2L",
    "lastName": "Bloggs",
    "marketingAllowed": false,
    "metadata": {
      "businessName": "Bloggs Bakery",
      "note": "Prefers email"
    },
    "phoneNumbers": {
      "elements": [
        {
          "id": "P1A2B3C4D5E6F",
          "phoneNumber": "555-0100"
        }
      ]
    }
  }
}

Get inventory item

Get one inventory item with its price, stock, categories and tags.

Inputs

Itemitem_idtextRequired
The inventory item. Pick one, or give its id from an earlier step.

Outputs

itemobject
The inventory item
Example output
{
  "item": {
    "available": true,
    "categories": {
      "elements": [
        {
          "id": "D8F2G6H1J4K9L",
          "modifiedTime": 1762419600000,
          "name": "Drinks",
          "sortOrder": 1
        }
      ]
    },
    "code": "012345678905",
    "cost": 120,
    "hidden": false,
    "id": "J9R4BXNQ2M1KE",
    "itemStock": {
      "item": {
        "id": "J9R4BXNQ2M1KE"
      },
      "modifiedTime": 1762419600000,
      "quantity": 24,
      "stockAlertThreshold": 5
    },
    "modifiedTime": 1762419600000,
    "name": "Cold brew",
    "price": 450,
    "priceType": "FIXED",
    "sku": "CB-16"
  }
}

Get merchant

Get the connected Clover business: its name, id and address.

Inputs

None.

Outputs

merchantobject
The merchant
Example output
{
  "merchant": {
    "address": {
      "address1": "12 Market St",
      "address2": "",
      "address3": "",
      "city": "Springfield",
      "country": "US",
      "state": "IL",
      "zip": "62701"
    },
    "id": "3D19QN31ANYR5",
    "name": "Bloggs Coffee"
  }
}

Get order

Get one order with its line items, payments, refunds and customers.

Inputs

Order IDorder_idtextRequired
The order's id, from 'List orders' or an earlier step.

Outputs

orderobject
The order
Example output
{
  "order": {
    "createdTime": 1762419600000,
    "currency": "USD",
    "employee": {
      "id": "QT0DES4CXR572"
    },
    "id": "KMAAH8QS60Z7A",
    "lineItems": {
      "elements": [
        {
          "createdTime": 1762419600000,
          "id": "Q1XW8ZK3N5R7T",
          "item": {
            "id": "J9R4BXNQ2M1KE"
          },
          "name": "Cold brew",
          "note": "Oat milk",
          "price": 450,
          "refunded": false
        }
      ]
    },
    "modifiedTime": 1762419650000,
    "note": "No onions",
    "orderType": {
      "id": "6Z0YH1PKQ5E2C",
      "label": "Dine in",
      "taxable": true
    },
    "payType": "FULL",
    "paymentState": "OPEN",
    "payments": {
      "elements": [
        {
          "amount": 1250,
          "createdTime": 1762419700000,
          "employee": {
            "id": "QT0DES4CXR572"
          },
          "externalPaymentId": "",
          "id": "8VK2M4QZP0R6A",
          "modifiedTime": 1762419700000,
          "order": {
            "id": "KMAAH8QS60Z7A"
          },
          "result": "SUCCESS",
          "taxAmount": 100,
          "tender": {
            "id": "T3N9S8C1V0BZE",
            "label": "Credit Card",
            "labelKey": "com.clover.tender.credit_card"
          },
          "tipAmount": 200
        }
      ]
    },
    "state": "open",
    "testMode": false,
    "title": "Table 4",
    "total": 1250
  }
}

Get payment

Get one payment with its amount, tip, tax, how it was paid and any refunds.

Inputs

Payment IDpayment_idtextRequired
The payment's id, from 'List payments' or an earlier step.

Outputs

paymentobject
The payment
Example output
{
  "payment": {
    "amount": 1250,
    "createdTime": 1762419700000,
    "employee": {
      "id": "QT0DES4CXR572"
    },
    "externalPaymentId": "",
    "id": "8VK2M4QZP0R6A",
    "modifiedTime": 1762419700000,
    "order": {
      "id": "KMAAH8QS60Z7A"
    },
    "result": "SUCCESS",
    "taxAmount": 100,
    "tender": {
      "id": "T3N9S8C1V0BZE",
      "label": "Credit Card",
      "labelKey": "com.clover.tender.credit_card"
    },
    "tipAmount": 200
  }
}

List categories

List the categories your items are grouped in on the register.

Inputs

Page sizelimitnumber
How many to return, 1 to 1000. Clover's default is 100.From 1 to 1000.
Start atoffsetnumber
How many to skip, for the next page: give the 'next_offset' an earlier page returned.At least 0.

Outputs

categorieslist
The categories
countnumber
How many came back on this page
has_moretrue/false
True when the page was full, so there may be more
next_offsetnumber
The offset to give to get the next page
offsetnumber
Where this page started
Example output
{
  "categories": [
    {
      "id": "D8F2G6H1J4K9L",
      "modifiedTime": 1762419600000,
      "name": "Drinks",
      "sortOrder": 1
    }
  ],
  "count": 1,
  "has_more": false,
  "next_offset": 1,
  "offset": 0
}

List customers

List customers, or find them by exact email, phone number, first name or last name. Gets one page.

Inputs

Emailemailtext
Only the customer with this email address.
Phonephonetext
Only customers with this phone number, as saved.
First namefirst_nametext
Only customers with this first name.
Last namelast_nametext
Only customers with this last name.
Page sizelimitnumber
How many to return, 1 to 1000. Clover's default is 100.From 1 to 1000.
Start atoffsetnumber
How many to skip, for the next page: give the 'next_offset' an earlier page returned.At least 0.

Outputs

countnumber
How many came back on this page
customerslist
The customers
has_moretrue/false
True when the page was full, so there may be more
next_offsetnumber
The offset to give to get the next page
offsetnumber
Where this page started
Example output
{
  "count": 1,
  "customers": [
    {
      "addresses": {
        "elements": [
          {
            "address1": "12 Market St",
            "address2": "",
            "address3": "",
            "city": "Springfield",
            "country": "US",
            "state": "IL",
            "zip": "62701"
          }
        ]
      },
      "customerSince": 1762419600000,
      "emailAddresses": {
        "elements": [
          {
            "emailAddress": "jo@example.com",
            "id": "E1A2B3C4D5E6F",
            "primaryEmail": true
          }
        ]
      },
      "firstName": "Jo",
      "id": "C5X1V9B3N7M2L",
      "lastName": "Bloggs",
      "marketingAllowed": false,
      "metadata": {
        "businessName": "Bloggs Bakery",
        "note": "Prefers email"
      },
      "phoneNumbers": {
        "elements": [
          {
            "id": "P1A2B3C4D5E6F",
            "phoneNumber": "555-0100"
          }
        ]
      }
    }
  ],
  "has_more": false,
  "next_offset": 1,
  "offset": 0
}

List employees

List the business's employees with their names, emails and roles.

Inputs

Page sizelimitnumber
How many to return, 1 to 1000. Clover's default is 100.From 1 to 1000.
Start atoffsetnumber
How many to skip, for the next page: give the 'next_offset' an earlier page returned.At least 0.

Outputs

countnumber
How many came back on this page
employeeslist
The employees
has_moretrue/false
True when the page was full, so there may be more
next_offsetnumber
The offset to give to get the next page
offsetnumber
Where this page started
Example output
{
  "count": 1,
  "employees": [
    {
      "customId": "",
      "email": "sam@example.com",
      "id": "QT0DES4CXR572",
      "isOwner": false,
      "name": "Sam Lee",
      "nickname": "Sam",
      "role": "MANAGER"
    }
  ],
  "has_more": false,
  "next_offset": 1,
  "offset": 0
}

List inventory items

List the items you sell, with their price, stock and categories, or find them by exact name or SKU. Gets one page.

Inputs

Namenametext
Only items with exactly this name.
SKUskutext
Only items with this SKU.
Page sizelimitnumber
How many to return, 1 to 1000. Clover's default is 100.From 1 to 1000.
Start atoffsetnumber
How many to skip, for the next page: give the 'next_offset' an earlier page returned.At least 0.

Outputs

countnumber
How many came back on this page
has_moretrue/false
True when the page was full, so there may be more
itemslist
The items
next_offsetnumber
The offset to give to get the next page
offsetnumber
Where this page started
Example output
{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "available": true,
      "categories": {
        "elements": [
          {
            "id": "D8F2G6H1J4K9L",
            "modifiedTime": 1762419600000,
            "name": "Drinks",
            "sortOrder": 1
          }
        ]
      },
      "code": "012345678905",
      "cost": 120,
      "hidden": false,
      "id": "J9R4BXNQ2M1KE",
      "itemStock": {
        "item": {
          "id": "J9R4BXNQ2M1KE"
        },
        "modifiedTime": 1762419600000,
        "quantity": 24,
        "stockAlertThreshold": 5
      },
      "modifiedTime": 1762419600000,
      "name": "Cold brew",
      "price": 450,
      "priceType": "FIXED",
      "sku": "CB-16"
    }
  ],
  "next_offset": 1,
  "offset": 0
}

List orders

List orders, optionally only those created in a time range or in one state, with their line items if you like. Gets one page; to see more, run it again starting at the next offset it gives.

Inputs

Created on or aftercreated_fromdate and time
Only orders created at or after this time.
Created on or beforecreated_untildate and time
Only orders created at or before this time. Clover returns at most 90 days of them per request.
Statestatetext
Only orders in this state.One of: open, locked (Locked (paid or being paid)).
Include line itemsinclude_line_itemstrue/false
Also return each order's line items (up to 100 each).
Page sizelimitnumber
How many to return, 1 to 1000. Clover's default is 100.From 1 to 1000.
Start atoffsetnumber
How many to skip, for the next page: give the 'next_offset' an earlier page returned.At least 0.

Outputs

countnumber
How many came back on this page
has_moretrue/false
True when the page was full, so there may be more
next_offsetnumber
The offset to give to get the next page
offsetnumber
Where this page started
orderslist
The orders
Example output
{
  "count": 1,
  "has_more": false,
  "next_offset": 1,
  "offset": 0,
  "orders": [
    {
      "createdTime": 1762419600000,
      "currency": "USD",
      "employee": {
        "id": "QT0DES4CXR572"
      },
      "id": "KMAAH8QS60Z7A",
      "lineItems": {
        "elements": [
          {
            "createdTime": 1762419600000,
            "id": "Q1XW8ZK3N5R7T",
            "item": {
              "id": "J9R4BXNQ2M1KE"
            },
            "name": "Cold brew",
            "note": "Oat milk",
            "price": 450,
            "refunded": false
          }
        ]
      },
      "modifiedTime": 1762419650000,
      "note": "No onions",
      "orderType": {
        "id": "6Z0YH1PKQ5E2C",
        "label": "Dine in",
        "taxable": true
      },
      "payType": "FULL",
      "paymentState": "OPEN",
      "payments": {
        "elements": [
          {
            "amount": 1250,
            "createdTime": 1762419700000,
            "employee": {
              "id": "QT0DES4CXR572"
            },
            "externalPaymentId": "",
            "id": "8VK2M4QZP0R6A",
            "modifiedTime": 1762419700000,
            "order": {
              "id": "KMAAH8QS60Z7A"
            },
            "result": "SUCCESS",
            "taxAmount": 100,
            "tender": {
              "id": "T3N9S8C1V0BZE",
              "label": "Credit Card",
              "labelKey": "com.clover.tender.credit_card"
            },
            "tipAmount": 200
          }
        ]
      },
      "state": "open",
      "testMode": false,
      "title": "Table 4",
      "total": 1250
    }
  ]
}

List payments

List payments taken, optionally only those in a time range or with one result. Amounts are in cents. Gets one page.

Inputs

Created on or aftercreated_fromdate and time
Only payments created at or after this time.
Created on or beforecreated_untildate and time
Only payments created at or before this time. Clover returns at most 90 days of them per request.
Resultresulttext
Only payments with this result.One of: SUCCESS (Successful), FAIL (Failed), VOIDED, AUTH (Authorized, not yet captured), PENDING.
Page sizelimitnumber
How many to return, 1 to 1000. Clover's default is 100.From 1 to 1000.
Start atoffsetnumber
How many to skip, for the next page: give the 'next_offset' an earlier page returned.At least 0.

Outputs

countnumber
How many came back on this page
has_moretrue/false
True when the page was full, so there may be more
next_offsetnumber
The offset to give to get the next page
offsetnumber
Where this page started
paymentslist
The payments
Example output
{
  "count": 1,
  "has_more": false,
  "next_offset": 1,
  "offset": 0,
  "payments": [
    {
      "amount": 1250,
      "createdTime": 1762419700000,
      "employee": {
        "id": "QT0DES4CXR572"
      },
      "externalPaymentId": "",
      "id": "8VK2M4QZP0R6A",
      "modifiedTime": 1762419700000,
      "order": {
        "id": "KMAAH8QS60Z7A"
      },
      "result": "SUCCESS",
      "taxAmount": 100,
      "tender": {
        "id": "T3N9S8C1V0BZE",
        "label": "Credit Card",
        "labelKey": "com.clover.tender.credit_card"
      },
      "tipAmount": 200
    }
  ]
}

List refunds

List refunds, optionally only those in a time range or for one payment. Clover keeps 90 days of refunds here. Gets one page.

Inputs

Created on or aftercreated_fromdate and time
Only refunds created at or after this time.
Created on or beforecreated_untildate and time
Only refunds created at or before this time. Clover returns at most 90 days of them per request.
Payment IDpayment_idtext
Only refunds of this payment.
Page sizelimitnumber
How many to return, 1 to 1000. Clover's default is 100.From 1 to 1000.
Start atoffsetnumber
How many to skip, for the next page: give the 'next_offset' an earlier page returned.At least 0.

Outputs

countnumber
How many came back on this page
has_moretrue/false
True when the page was full, so there may be more
next_offsetnumber
The offset to give to get the next page
offsetnumber
Where this page started
refundslist
The refunds
Example output
{
  "count": 1,
  "has_more": false,
  "next_offset": 1,
  "offset": 0,
  "refunds": [
    {
      "amount": 450,
      "createdTime": 1762423300000,
      "id": "R2D9K7W1H3Y5Q",
      "orderRef": {
        "id": "KMAAH8QS60Z7A"
      },
      "payment": {
        "id": "8VK2M4QZP0R6A"
      },
      "reason": "Wrong drink",
      "status": "SUCCESS",
      "taxAmount": 0,
      "tipAmount": 0,
      "voided": false
    }
  ]
}

Remove line item

Take a line item off an order.

Inputs

Order IDorder_idtextRequired
The order's id, from 'List orders' or an earlier step.
Line item IDline_item_idtextRequired
The line item's id, from 'Get order' or an earlier step.

Outputs

line_item_idtext
The line item removed
order_idtext
The order
removedtrue/false
Always true once done
Example output
{
  "line_item_id": "Q1XW8ZK3N5R7T",
  "order_id": "KMAAH8QS60Z7A",
  "removed": true
}

Set item stock

Set how many of an item are in stock. Its low-stock alert level is kept.

Inputs

Itemitem_idtextRequired
The inventory item. Pick one, or give its id from an earlier step.
Quantity in stockquantitynumberRequired
How many are in stock now, such as 24 or 2.5.

Outputs

item_idtext
The item
quantitynumber
The quantity set
stockobject
The item's stock now
Example output
{
  "item_id": "J9R4BXNQ2M1KE",
  "quantity": 24,
  "stock": {
    "item": {
      "id": "J9R4BXNQ2M1KE"
    },
    "modifiedTime": 1762419600000,
    "quantity": 24,
    "stockAlertThreshold": 5
  }
}

Update customer

Change a customer's name, business name or note. Empty fields are left as they are.

Inputs

Customer IDcustomer_idtextRequired
The customer's id, from 'List customers' or an earlier step.
First namefirst_nametext
A new first name.
Last namelast_nametext
A new last name.
Business namebusiness_nametext
A new business name.
Notenotetext
A new note, in place of the old one.

Outputs

customerobject
The customer
Example output
{
  "customer": {
    "addresses": {
      "elements": [
        {
          "address1": "12 Market St",
          "address2": "",
          "address3": "",
          "city": "Springfield",
          "country": "US",
          "state": "IL",
          "zip": "62701"
        }
      ]
    },
    "customerSince": 1762419600000,
    "emailAddresses": {
      "elements": [
        {
          "emailAddress": "jo@example.com",
          "id": "E1A2B3C4D5E6F",
          "primaryEmail": true
        }
      ]
    },
    "firstName": "Jo",
    "id": "C5X1V9B3N7M2L",
    "lastName": "Bloggs",
    "marketingAllowed": false,
    "metadata": {
      "businessName": "Bloggs Bakery",
      "note": "Prefers email"
    },
    "phoneNumbers": {
      "elements": [
        {
          "id": "P1A2B3C4D5E6F",
          "phoneNumber": "555-0100"
        }
      ]
    }
  }
}

Update inventory item

Change an item's name, price, SKU, product code, cost or whether it shows on the register. Empty fields are left as they are.

Inputs

Itemitem_idtextRequired
The inventory item. Pick one, or give its id from an earlier step.
Namenametext
A new name.
Pricepricenumber
A new price, such as 4.75.At least 0.
SKUskutext
A new SKU.
Product codecodetext
A new barcode number.
Costcostnumber
A new cost, such as 1.25.At least 0.
On the registervisibilitytext
Whether the item shows on the register for staff to sell.One of: shown (Shown on the register), hidden (Hidden from the register).

Outputs

itemobject
The inventory item
Example output
{
  "item": {
    "available": true,
    "categories": {
      "elements": [
        {
          "id": "D8F2G6H1J4K9L",
          "modifiedTime": 1762419600000,
          "name": "Drinks",
          "sortOrder": 1
        }
      ]
    },
    "code": "012345678905",
    "cost": 120,
    "hidden": false,
    "id": "J9R4BXNQ2M1KE",
    "itemStock": {
      "item": {
        "id": "J9R4BXNQ2M1KE"
      },
      "modifiedTime": 1762419600000,
      "quantity": 24,
      "stockAlertThreshold": 5
    },
    "modifiedTime": 1762419600000,
    "name": "Cold brew",
    "price": 450,
    "priceType": "FIXED",
    "sku": "CB-16"
  }
}

Update order

Change an order's title, note or order type. Empty fields are left as they are.

Inputs

Order IDorder_idtextRequired
The order's id, from 'List orders' or an earlier step.
Titletitletext
A new title for the order.
Notenotetext
A new note for the order.
Order typeorder_type_idtext
The order type, such as dine in or to go, as set up in Clover.

Outputs

orderobject
The order
Example output
{
  "order": {
    "createdTime": 1762419600000,
    "currency": "USD",
    "employee": {
      "id": "QT0DES4CXR572"
    },
    "id": "KMAAH8QS60Z7A",
    "lineItems": {
      "elements": [
        {
          "createdTime": 1762419600000,
          "id": "Q1XW8ZK3N5R7T",
          "item": {
            "id": "J9R4BXNQ2M1KE"
          },
          "name": "Cold brew",
          "note": "Oat milk",
          "price": 450,
          "refunded": false
        }
      ]
    },
    "modifiedTime": 1762419650000,
    "note": "No onions",
    "orderType": {
      "id": "6Z0YH1PKQ5E2C",
      "label": "Dine in",
      "taxable": true
    },
    "payType": "FULL",
    "paymentState": "OPEN",
    "payments": {
      "elements": [
        {
          "amount": 1250,
          "createdTime": 1762419700000,
          "employee": {
            "id": "QT0DES4CXR572"
          },
          "externalPaymentId": "",
          "id": "8VK2M4QZP0R6A",
          "modifiedTime": 1762419700000,
          "order": {
            "id": "KMAAH8QS60Z7A"
          },
          "result": "SUCCESS",
          "taxAmount": 100,
          "tender": {
            "id": "T3N9S8C1V0BZE",
            "label": "Credit Card",
            "labelKey": "com.clover.tender.credit_card"
          },
          "tipAmount": 200
        }
      ]
    },
    "state": "open",
    "testMode": false,
    "title": "Table 4",
    "total": 1250
  }
}

On this page