Release NotesAnnouncementsVideosBlog
Guides

Manage orders data

North America—United States and Canada

Clover Orders API provides solutions for creating and managing both in-store and online orders, ensuring flexibility and efficiency in handling various order types. The Clover APIs allow you to create two types of orders.

Get started

Use the following links to view the tutorials and endpoints to manage Clover orders.

Create an atomic order

Create a complete order with line items, modifiers, discounts, and service charges with a single API call. Order totals and taxes are calculated in real-time.

Create a custom order

Create an order using multiple API endpoints. You can override default properties such as tax rates or item prices. This is suitable for orders requiring non-standard items or specific customizations.

Calculate order totals

Calculate order details with discounts, service charges, and taxes.

Print orders

Use the merchant’s default device to print order details and customize order and payment receipts.

Key components of an order

When using the Clover API to create and manage orders, several key components and data elements are involved. The main components that work together to create a comprehensive order management system within the Clover API are:

TermDescriptionKey data elements
OrderIndicates a finalized purchase that has been processed and recorded in the system. Includes all items, modifiers, discounts, service charges, and payment details. Used to track and manage completed transactions, including payment and fulfillment.id—Unique identifier for the order.
currency—Currency in which the order is processed.
total—Total amount for the order, including all items, taxes, and discounts.
state—Current state of the order, such as open, closed, voided.
Order cartTemporary collection of items that a customer intends to purchase. It is used to build and manage the shopping experience before finalizing the purchase. Includes items, modifiers, discounts, and service charges, but is not yet a finalized order. Remains in the active state until the customer checks out.id—Unique identifier for the order.
currency—Currency in which the order is processed.
total—Total amount for the order, including all items, taxes, and discounts.
state—Current state of the order, such as active.
Order typeClassification of the order, such as online, delivery, pick-up, or dine-in. Each order type is specific to the merchant.id—Unique identifier for the order type.
name—Name of the order type, such as online, delivery, pick-up, or dine-in.
isDefault—Boolean indicating if this is the default order type for the merchant.
Line ItemsIndividual products or services included in the order. You can use a modifier to indicate a customization, for example, the size of the coffee (small or large).id—Unique identifier for the line items within the order.
price—Item price.
quantity: Number of units of the item.
ModifiersCustomizations or options applied to a line item.id—Unique identifier for the modifier applied to a line item.
price—Additional cost, if any, for the modifier.
DiscountsAmount or percentage discount or reductions applied to the order subtotal.id—Unique identifier for the discount.
amount—Amount or percentage of the discount.
TaxesTaxes applied to the order or individual items.id—Unique identifier for the tax.
rate—Tax rate applied to the order or item.
Service chargesAdditional charges or gratuity tip applied to the order for services.id—Unique identifier of the service charge.
amount—Service charge amount.
PaymentsDetails of payments made for the order.id—Unique identifier of the payment.
amount—Amount paid for the order.
type—Payment type, such as credit card or cash.
MerchantInformation about the merchant or business where the order is placed. The merchantId is a required parameter.mId—Unique identifier of the merchant.
Customer Information about the customer associated with the order.id—Unique identifier of the customer.
amount—Amount paid for the order.
EmployeeInformation about the employee who took the order.id—Unique identifier of the employee.

Updated about 7 hours ago