Square API
You are viewing an old version of the API
Orders
Square API
Get sales data for a Square seller, itemize payments, push orders to POS, and more.
The Orders API is your one-stop shop for adding rich functionality to payments. You can itemize payments using custom line items or catalog objects, send orders to physical Point of Sale devices to be fulfilled, attach a customer to a payment, and more.
In addition, the Orders API lets you search through all of a seller's past sales and returns itemization data, customer references, and other details from sales made using POS or online.
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.
-
Create order
POST /v2/orders - Creates a new order that can include information about products for purchase and settings to apply to the purchase.
-
Batch retrieve orders
POST /v2/orders/batch-retrieve - Retrieves a set of orders by their IDs.
-
Calculate order
POST /v2/orders/calculate - Enables applications to preview order pricing without creating an order.
BETA -
Clone order
POST /v2/orders/clone - Creates a new order, in the DRAFT state, by duplicating an existing order.
BETA -
Search orders
POST /v2/orders/search - Search all orders for one or more locations.
-
Retrieve order
GET /v2/orders/{order_id} - Retrieves an Order by ID.
-
Update order
PUT /v2/orders/{order_id} - Updates an open order by adding, replacing, or deleting fields.
BETA -
Pay order
POST /v2/orders/{order_id}/pay - Pay for an order using one or more approved payments or settle an order with a total of 0.
BETA