Orders API - What It Does

Overview

The Orders API can:

• Record purchase items
• Calculate totals
• Confirm payments
• Track an order's progress through fulfillment
• Update a catalog inventory
• Create fulfillment orders and send them to the Square Point of Sale application for fulfillment

Important: There is no transaction fee for orders paid using Square payments. If you want to use the Square Orders API with a non-Square payments provider, there is a 1% fee per transaction. For more information, contact us.

Orders Components

The following are some of the key data elements for the Orders API:

Orders

An order is a top-level container representing a request to purchase goods or services from a business. Every order includes fields for line item details, fulfillment details, and order summary data, such as the location ID credited with the order and the total amount of taxes collected.

Line Items

Individual items that are purchased as part of the order (for example, an order for a sandwich and two cups of tea). Each line item can have one or more modifiers to represent an available size or color (for example, a chicken sandwich with extra mustard). Line items and modifiers can be built from Catalog API objects or created ad hoc (at the time of creation).

Price Adjustments

An order (or individual line items) might be eligible for discounts or subject to service charges and taxes. The Orders API calculates and applies any price adjustments at the order or line item level. Price adjustments can be configured as Catalog API objects or created ad hoc.

Fulfillment Information

Additional details about how to fulfill this type of order, such as the customer's name or the time at which the customer should pick up the order. Every order that has fulfillment information is pushed to the Seller Dashboard when charged, so that sellers can manage order fulfillment in the Square Point of Sale application.

Order Source

Tracks the digital or physical source of the order. Orders can be searched or retrieved by the source. For more information, see Orders objects and data types.

Integrating with the Orders API

The Orders API integrates seamlessly with other Square APIs and resources to expand the functionality of your application.

Square Point of Sale

Orders with fulfillment that have been fully paid are pushed to the Square Point of Sale application so that sellers can manage fulfillment with the Square Point of Sale application. The Orders API supports three types of fulfillment orders: Pickup, Shipment, and Delivery. For more information, see Add fulfillment details. The Orders API can also get orders that are originated and completed on the Square Point of Sale application. Such an order might have the Order.source field set to SQUARE_POS. Any associated payments will have the Payment.application_details.square_product field set to SQUARE_POS.