# Clover

> 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.

App · 24 actions. Web page: https://docs.lodol.com/docs/integrations/clover

## Actions

### 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 ID (`order_id`, text, required): The order's id, from 'List orders' or an earlier step.
- Inventory item (`item_id`, text): The item sold. Leave empty for a custom line, and give a name and price instead.
- Name (`name`, text): The line's name. Needed for a custom line; for an inventory item, leave empty to use the item's own.
- Price (`price`, number): 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.
- Note (`note`, text): A note on this line, such as 'no ice'.

**Outputs**

- `line_item` (object): The line item added

**Example output**

```json
{
  "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 name (`first_name`, text): Their first name.
- Last name (`last_name`, text): Their last name.
- Email (`email`, text): Their email address.
- Phone (`phone`, text): Their phone number.
- Business name (`business_name`, text): The business they buy for.
- Note (`note`, text): A note about the customer.
- Street address (`address1`, text): The first line of their address.
- City (`city`, text): The city of their address.
- State or province (`state`, text): The state or province.
- Postal code (`zip_code`, text): The ZIP or postal code.
- Country (`country`, text): The country, such as US.

**Outputs**

- `customer` (object): The customer

**Example output**

```json
{
  "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**

- Name (`name`, text, required): The item's name, as it shows on the register.
- Price (`price`, number, required): The price, such as 4.50. At least 0.
- Price type (`price_type`, text): 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)).
- SKU (`sku`, text): Your stock keeping unit for the item.
- Product code (`code`, text): Its barcode number, such as a UPC or EAN.
- Cost (`cost`, number): What the item costs you, such as 1.20. At least 0.
- On the register (`visibility`, text): Whether the item shows on the register for staff to sell. One of: `shown` (Shown on the register), `hidden` (Hidden from the register).
- Category (`category_id`, text): A category to put the item in.

**Outputs**

- `added_to_category` (true/false): True when it was put in the category
- `item` (object): The item created

**Example output**

```json
{
  "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**

- Title (`title`, text): A title for the order, shown in Clover's Orders app.
- Note (`note`, text): A note on the order, which can print on the receipt.
- Order type (`order_type_id`, text): The order type, such as dine in or to go, as set up in Clover.

**Outputs**

- `order` (object): The order

**Example output**

```json
{
  "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 ID (`customer_id`, text, required): The customer's id, from 'List customers' or an earlier step.

**Outputs**

- `customer_id` (text): The customer deleted
- `deleted` (true/false): Always true once done

**Example output**

```json
{
  "customer_id": "C5X1V9B3N7M2L",
  "deleted": true
}
```

### Delete inventory item

Delete an item from your inventory for good.

**Inputs**

- Item (`item_id`, text, required): The inventory item. Pick one, or give its id from an earlier step.

**Outputs**

- `deleted` (true/false): Always true once done
- `item_id` (text): The item deleted

**Example output**

```json
{
  "deleted": true,
  "item_id": "J9R4BXNQ2M1KE"
}
```

### Delete order

Delete an order from Clover for good.

**Inputs**

- Order ID (`order_id`, text, required): The order's id, from 'List orders' or an earlier step.

**Outputs**

- `deleted` (true/false): Always true once done
- `order_id` (text): The order deleted

**Example output**

```json
{
  "deleted": true,
  "order_id": "KMAAH8QS60Z7A"
}
```

### Get customer

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

**Inputs**

- Customer ID (`customer_id`, text, required): The customer's id, from 'List customers' or an earlier step.

**Outputs**

- `customer` (object): The customer

**Example output**

```json
{
  "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**

- Item (`item_id`, text, required): The inventory item. Pick one, or give its id from an earlier step.

**Outputs**

- `item` (object): The inventory item

**Example output**

```json
{
  "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**

- `merchant` (object): The merchant

**Example output**

```json
{
  "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 ID (`order_id`, text, required): The order's id, from 'List orders' or an earlier step.

**Outputs**

- `order` (object): The order

**Example output**

```json
{
  "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 ID (`payment_id`, text, required): The payment's id, from 'List payments' or an earlier step.

**Outputs**

- `payment` (object): The payment

**Example output**

```json
{
  "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 size (`limit`, number): How many to return, 1 to 1000. Clover's default is 100. From 1 to 1000.
- Start at (`offset`, number): How many to skip, for the next page: give the 'next_offset' an earlier page returned. At least 0.

**Outputs**

- `categories` (list): The categories
- `count` (number): How many came back on this page
- `has_more` (true/false): True when the page was full, so there may be more
- `next_offset` (number): The offset to give to get the next page
- `offset` (number): Where this page started

**Example output**

```json
{
  "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**

- Email (`email`, text): Only the customer with this email address.
- Phone (`phone`, text): Only customers with this phone number, as saved.
- First name (`first_name`, text): Only customers with this first name.
- Last name (`last_name`, text): Only customers with this last name.
- Page size (`limit`, number): How many to return, 1 to 1000. Clover's default is 100. From 1 to 1000.
- Start at (`offset`, number): How many to skip, for the next page: give the 'next_offset' an earlier page returned. At least 0.

**Outputs**

- `count` (number): How many came back on this page
- `customers` (list): The customers
- `has_more` (true/false): True when the page was full, so there may be more
- `next_offset` (number): The offset to give to get the next page
- `offset` (number): Where this page started

**Example output**

```json
{
  "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 size (`limit`, number): How many to return, 1 to 1000. Clover's default is 100. From 1 to 1000.
- Start at (`offset`, number): How many to skip, for the next page: give the 'next_offset' an earlier page returned. At least 0.

**Outputs**

- `count` (number): How many came back on this page
- `employees` (list): The employees
- `has_more` (true/false): True when the page was full, so there may be more
- `next_offset` (number): The offset to give to get the next page
- `offset` (number): Where this page started

**Example output**

```json
{
  "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**

- Name (`name`, text): Only items with exactly this name.
- SKU (`sku`, text): Only items with this SKU.
- Page size (`limit`, number): How many to return, 1 to 1000. Clover's default is 100. From 1 to 1000.
- Start at (`offset`, number): How many to skip, for the next page: give the 'next_offset' an earlier page returned. At least 0.

**Outputs**

- `count` (number): How many came back on this page
- `has_more` (true/false): True when the page was full, so there may be more
- `items` (list): The items
- `next_offset` (number): The offset to give to get the next page
- `offset` (number): Where this page started

**Example output**

```json
{
  "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 after (`created_from`, date and time): Only orders created at or after this time.
- Created on or before (`created_until`, date and time): Only orders created at or before this time. Clover returns at most 90 days of them per request.
- State (`state`, text): Only orders in this state. One of: `open`, `locked` (Locked (paid or being paid)).
- Include line items (`include_line_items`, true/false): Also return each order's line items (up to 100 each).
- Page size (`limit`, number): How many to return, 1 to 1000. Clover's default is 100. From 1 to 1000.
- Start at (`offset`, number): How many to skip, for the next page: give the 'next_offset' an earlier page returned. At least 0.

**Outputs**

- `count` (number): How many came back on this page
- `has_more` (true/false): True when the page was full, so there may be more
- `next_offset` (number): The offset to give to get the next page
- `offset` (number): Where this page started
- `orders` (list): The orders

**Example output**

```json
{
  "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 after (`created_from`, date and time): Only payments created at or after this time.
- Created on or before (`created_until`, date and time): Only payments created at or before this time. Clover returns at most 90 days of them per request.
- Result (`result`, text): Only payments with this result. One of: `SUCCESS` (Successful), `FAIL` (Failed), `VOIDED`, `AUTH` (Authorized, not yet captured), `PENDING`.
- Page size (`limit`, number): How many to return, 1 to 1000. Clover's default is 100. From 1 to 1000.
- Start at (`offset`, number): How many to skip, for the next page: give the 'next_offset' an earlier page returned. At least 0.

**Outputs**

- `count` (number): How many came back on this page
- `has_more` (true/false): True when the page was full, so there may be more
- `next_offset` (number): The offset to give to get the next page
- `offset` (number): Where this page started
- `payments` (list): The payments

**Example output**

```json
{
  "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 after (`created_from`, date and time): Only refunds created at or after this time.
- Created on or before (`created_until`, date and time): Only refunds created at or before this time. Clover returns at most 90 days of them per request.
- Payment ID (`payment_id`, text): Only refunds of this payment.
- Page size (`limit`, number): How many to return, 1 to 1000. Clover's default is 100. From 1 to 1000.
- Start at (`offset`, number): How many to skip, for the next page: give the 'next_offset' an earlier page returned. At least 0.

**Outputs**

- `count` (number): How many came back on this page
- `has_more` (true/false): True when the page was full, so there may be more
- `next_offset` (number): The offset to give to get the next page
- `offset` (number): Where this page started
- `refunds` (list): The refunds

**Example output**

```json
{
  "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 ID (`order_id`, text, required): The order's id, from 'List orders' or an earlier step.
- Line item ID (`line_item_id`, text, required): The line item's id, from 'Get order' or an earlier step.

**Outputs**

- `line_item_id` (text): The line item removed
- `order_id` (text): The order
- `removed` (true/false): Always true once done

**Example output**

```json
{
  "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**

- Item (`item_id`, text, required): The inventory item. Pick one, or give its id from an earlier step.
- Quantity in stock (`quantity`, number, required): How many are in stock now, such as 24 or 2.5.

**Outputs**

- `item_id` (text): The item
- `quantity` (number): The quantity set
- `stock` (object): The item's stock now

**Example output**

```json
{
  "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 ID (`customer_id`, text, required): The customer's id, from 'List customers' or an earlier step.
- First name (`first_name`, text): A new first name.
- Last name (`last_name`, text): A new last name.
- Business name (`business_name`, text): A new business name.
- Note (`note`, text): A new note, in place of the old one.

**Outputs**

- `customer` (object): The customer

**Example output**

```json
{
  "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**

- Item (`item_id`, text, required): The inventory item. Pick one, or give its id from an earlier step.
- Name (`name`, text): A new name.
- Price (`price`, number): A new price, such as 4.75. At least 0.
- SKU (`sku`, text): A new SKU.
- Product code (`code`, text): A new barcode number.
- Cost (`cost`, number): A new cost, such as 1.25. At least 0.
- On the register (`visibility`, text): Whether the item shows on the register for staff to sell. One of: `shown` (Shown on the register), `hidden` (Hidden from the register).

**Outputs**

- `item` (object): The inventory item

**Example output**

```json
{
  "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 ID (`order_id`, text, required): The order's id, from 'List orders' or an earlier step.
- Title (`title`, text): A new title for the order.
- Note (`note`, text): A new note for the order.
- Order type (`order_type_id`, text): The order type, such as dine in or to go, as set up in Clover.

**Outputs**

- `order` (object): The order

**Example output**

```json
{
  "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
  }
}
```
