POS API

Orders

Payments

Merchants

Locations

Items

Modifiers

Modifier Groups

Order Types

Tenders

Clover is a cloud-based point of sale (POS) platform.

Clover

The date and time when the object was created.

Created at (timestamp)

Created by

Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

Currency

UNKNOWN_CURRENCY

When custom mappings are configured on the resource, the result is included here.

medium

A value you specify that uniquely identifies this request among requests you have sent.

A note with information about this order, may be printed on the order receipt and displayed in apps

Note

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

PosPayment status

An optional user-defined reference ID that associates this record with another entity in an external system. For example, a customer ID from an external customer management system.

Reference ID

Optional service charges or gratuity tip applied to the order.

high

Source of order. Indicates the way that the order was placed.

Order status. Clover specific: If no value is set, the status defaults to hidden, which indicates a hidden order. A hidden order is not displayed in user interfaces and can only be retrieved by its id. When creating an order via the REST API the value must be manually set to 'open'. More info [https://docs.clover.com/reference/orderupdateorder]()

Status

Title

Total amount (in cents)

Total discount (in cents)

Total refund (in cents)

Total service charge (in cents)

Total tax (in cents)

The date and time when the object was last updated.

Updated at (timestamp)

Updated by

Version

Abbreviation

A list of locations where the object is not present, even if present_at_all_locations is true. This can include locations that are deactivated.

Available

If true, the item can be added to pickup orders from the merchant's online store.

If true, the item can be added to shipping orders from the merchant's online store.

Cost

Flag to indicate if the object is deleted.

Deleted

Description

Hidden

True if this item should be counted as revenue. For example, gift cards and donations would not be counted as revenue.

Is Revenue

Variations

Name

List of options pertaining to this item's attribute variation

Present at all locations

Price amount

Pricing type

Product type

Tax IDs

Use default tax rates

Food

critical

Alternate name

Modifier group ID

Amount (in cents)

The amount the developer is taking as a fee for facilitating the payment on behalf of the seller.

App fee

The initial amount of money approved for this payment.

Approved amount (in cents)

Card details for this payment. This field is currently not available. Reach out to our team for more info.

The ownership type of the bank account performing the transfer.
The type can be `INDIVIDUAL`, `COMPANY`, or `UNKNOWN`.

ACH-specific details about `BANK_ACCOUNT` type payments with the `transfer_type` of `ACH`.

The name of the bank associated with the bank account.

Country code according to ISO 3166-1 alpha-2.

Country Code

Uniquely identifies the bank account for this seller and can be used
to determine if payments are from the same bank account.

The statement description as sent to the bank.

The type of the bank transfer. The type can be `ACH` or `UNKNOWN`.

Bank Account

The amount of cash given by the customer.

The amount of change due back to the buyer. For Square: this read-only field is calculated from the amount_money and buyer_supplied_money fields.

Cash details

Change back cash amount (in cents)

A description of the external payment source. For example, 
"Food Delivery Service".

The fees paid to the source. The amount minus this field is the net amount seller receives.

Source fee

An ID to associate the payment to its originating source.

The type of external payment the seller received. It can be one of the following:
- CHECK - Paid using a physical check.
- BANK_TRANSFER - Paid using external bank transfer.
- OTHER\_GIFT\_CARD - Paid using a non-Square gift card.
- CRYPTO - Paid using a crypto currency.
- SQUARE_CASH - Paid using Square Cash App.
- SOCIAL - Paid using peer-to-peer payment applications.
- EXTERNAL - A third-party application gathered this payment outside of Square.
- EMONEY - Paid using an E-money provider.
- CARD - A credit or debit card that Square does not support.
- STORED_BALANCE - Use for house accounts, store credit, and so forth.
- FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals
- OTHER - A type not listed here.

The total amount (in cents) of the payment refunded to date.

The ID for the source of funds for this payment. Square-only: This can be a payment token (card nonce) generated by the payment form or a card on file made linked to the customer. if recording a payment that the seller received outside of Square, specify either `CASH` or `EXTERNAL`.

Tax amount (in cents)

Tip amount (in cents)

Wallet details for this payment. This field is currently not available. Reach out to our team for more info.

The status of the wallet payment. The status can be AUTHORIZED, CAPTURED, VOIDED, or FAILED.

Wallet details

Default

Order type name

Maximum allowed

Minimum required

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

Row version

Indicates whether multiple options from the modifier group can be applied to a single or multiple modifiers

Is active

Name of the contact person at the address

country code according to ISO 3166-1 alpha-2.

Address field that holds a sublocality, such as a county

Line 1 of the address e.g. number, street, suite, apt #, etc.

Notes

Salutation of the contact person at the address

The address string. Some APIs don't provide structured address data.

edge-case

language code according to ISO 639-1. For the United States - EN

Clover

Supported resources

Details