Orders API Overview
The Orders API lets you build applications to track and manage the lifecycle of a purchase. The API can record purchase items, calculate totals, confirm payments, track an order's progress through fulfillment, and update a catalog inventory. It can also create fulfillment orders and send them to the Square Point of Sale application for fulfillment.
If you use the Square Orders API with a non-Square payments provider, Square charges a transaction fee. For more information, see Orders API fee structure.
The Orders API works with the following key data types:
Order. The top-level container for order information.
Orderobjects include fields for line item details, fulfillment details, and order summary data, including the location ID credited with the order and the total amount of taxes collected.
OrderLineItem. Represents a purchase item (for example, a coffee or T-shirt). Each line item has an
OrderLineItemModifierthat represents an available size or color. Items and modifiers can be built from
Catalogobjects or they can be defined ad hoc (at the time of creation).
OrderLineItemTax. A price modifier that can be applied at the order or line item level. Taxes and discounts can be configured as
Catalogobjects and referenced in the order or they can be created ad hoc.
OrderFulfillment. Contains details about how to fulfill this order, such as the customer name or the time at which the customer should pick up the order.
Orderobjects made with fulfillments are pushed to the Seller Dashboard when charged, so sellers can manage order fulfillment in the Square Point of Sale application.
OrderSource. 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.
The Orders API integrates seamlessly with other Square APIs and resources to expand the functionality of your application.
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 currently supports two types of fulfillment orders: Pickup and Shipment. For more information, see Add fulfillment details.
Link your payments to
Order objects to itemize sales and apply price modifiers such as taxes, discounts, and service charges. You can also use the Orders API to retrieve any payment activity associated with a sale, whether from the Square Point of Sale application, invoices, or an integration build with the Payments API and Orders API.
For more information, see Pay for Orders.
Line items, line item modifiers, taxes, and discounts can all be defined as catalog objects. The Orders API reaches its full range of capabilities when orders are built using Square Catalog objects.
Key advantages to using catalog items include:
Orders that reference catalog IDs for taxes and discounts are automatically calculated and applied to these price modifiers.
Orders that reference catalog line items use details defined in the catalog, such as the item name and price.
When these orders are closed, Square updates the inventory for those items.
Use the Catalog API to build a catalog and unlock the full range of capabilities of the Orders API. For more information, see Create Orders.
Did you know?
Orders can also be built from ad hoc line items defined when the
Order object is created. You only need to supply an item name and price.
Order objects can reference a customer profile. You can later use
SearchOrders to search orders by customer. For more information about making customer profiles, see Keep Records of Customer Profiles.
The Orders API integration with the Customers API is in beta. For more information about known beta issues, see the changelog.
You should be aware of the following considerations regarding customer assignments:
Linking orders and payments to customers helps provide a more seamless experience for Square sellers and their customers. When possible, you should specify the
customer_idwhen you create a payment or an order. If you do not have the customer ID, use information collected from the customer to call SearchCustomers to find a matching customer profile. If one cannot be found, call CreateCustomer to create a new profile using the information collected from the customer.
If your application does not collect any information from the customer, you can omit the
customer_idand rely on Square's inference to find the best matching customer profile or to create an instant profile. Note that this process is asynchronous and might take some time before
customer_idis added to the payment. If Square cannot find a matching customer profile and cannot create an instant profile, the
customer_idfield of the payment remains unset. In this case, the transaction is not associated with a customer in Square products, such as Square Point of Sale and the Seller Dashboard.
Orders made from a Square Online store might not be immediately associated with a customer. When a new buyer places an order from a Square Online store, Square attempts to create an instant profile in the seller's Customer Directory and then assign the profile to the order. This process is asynchronous and might take some time to update the customer information when viewed on the Transactions page in Square Point of Sale or the Seller Dashboard. The delay does not occur if the buyer is a returning customer.
Similarly, these orders might not include a
customer_idwhen retrieved using the Orders API. Instead of relying on this field for your integration, consider using the
customer_idfield of the corresponding payment, which is more likely to be populated. If this field is not specified when the payment is created, Square attempts to set it by finding a matching customer profile or creating an instant profile.
Sellers can merge duplicate customer profiles that represent the same customer. The merge operation deletes the existing customer profiles and creates a new aggregated customer profile with a new ID. Currently, searching for orders using the new customer ID does not return any orders that were made using a previous customer ID.
As a workaround, you should store all previous customer IDs and provide them in the
customer_idsquery filter in your
SearchOrdersrequest. To obtain these IDs, subscribe to
customer.createdwebhook events and check whether the notifications contain the
event_context.mergefield. This field is included when the customer profile is created from a merge operation and contains the IDs of all affected customer profiles. For more information, see Notifications for customer profile merge events.
customer_id is not set for a payment made using a non-payment-card payment method (such as Gift Card, ACH, or Cash App), Square does not attempt to find or create a customer profile to populate the
A webhook is a subscription that notifies you when a Square event occurs. The Orders API supports the following events:
|order.created||An Order was created.|
|order.fulfillment.updated||An OrderFulfillment was created or updated.|
|order.updated||An Order was updated.|
For more information about using webhooks, see Square Webhooks Overview. For a list of webhook events you can subscribe to, see V2 Webhook Events Reference.
If you need more assistance, contact Developer Support or ask for help in the Developer Forums.