Orders API

Create Orders

You can create Order objects by calling the CreateOrder endpoint. Orders objects can be created with any combination of line items, fulfillment objects, taxes, and discounts. They can also be created empty and updated with elements over time.

Sellers can view orders in the Seller Dashboard; however, note that Square pushes orders to the Seller Dashboard only if the orders meet specific conditions. For more information, see View orders in the Seller Dashboard.

Create line items Permalink Get a link to this section

You have two options for making line items:

  • You can make orders using catalog_ids, which is strongly recommended.

  • You can create line items ad hoc without referencing existing catalog items.

Option 1: Get the catalog_object_id for your line item Permalink Get a link to this section

The following sample cURL command creates an order using catalog items:

  1. Replace COFFEE_ITEM_ID with your catalog item ID and SMALL_MODIFIER_ID with your catalog item variation ID.

  2. Generate a unique string for your idempotency key.

  3. Send a POST request to the CreateOrder endpoint (/v2/orders).

    For more information about line items, see the Orders API Technical Reference.

    Create Order
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    curl https://connect.squareupsandbox.com/v2/orders \
      -X POST \
      -H 'Square-Version: 2021-09-15' \
      -H 'Authorization: Bearer {ACCESS_TOKEN}' \
      -H 'Content-Type: application/json' \
      -d '{
        "idempotency_key": "{UNIQUE_KEY}",
        "order": {
          "location_id": "{LOCATION_ID}",
          "line_items": [
            {
              "catalog_object_id": "{COFFEE_ITEM_ID}",
              "modifiers": [
                {
                  "catalog_object_id": "{SMALL_MODIFIER_ID}"
                }
              ],
              "quantity": "1"
            }
          ]
        }
      }'

Option 2: Define a line item ad hoc Permalink Get a link to this section

The following sample cURL command creates an order with a line item:

  1. Replace name and quantity.

  2. Set base_price_money with a money object representing your cost. For more information, see Working with Monetary Amounts.

  3. Generate a unique string for your idempotency key.

  4. Send a POST request to the CreateOrder endpoint (/v2/orders).

    The following shows a sample JSON body for a cURL command that creates an order using an ad hoc line item:

    Create Order
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    curl https://connect.squareupsandbox.com/v2/orders \
      -X POST \
      -H 'Square-Version: 2021-09-15' \
      -H 'Authorization: Bearer {ACCESS_TOKEN}' \
      -H 'Content-Type: application/json' \
      -d '{
        "idempotency_key": "{UNIQUE_KEY}",
        "order": {
          "location_id": "X9XWRESTK1CZ1",
          "line_items": [
            {
              "name": "Small Coffee",
              "quantity": "1",
              "base_price_money": {
                "amount": 500,
                "currency": "USD"
              }
            }
          ]
        }
      }'

    For more information about line items, see the Orders API Technical Reference.

Add fulfillment details Permalink Get a link to this section

To create a pickup order, you need to configure an OrderFulfillment object and set it in your order.

This sample command creates a pickup order for a small coffee:

Create Order
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
curl https://connect.squareupsandbox.com/v2/orders \
  -X POST \
  -H 'Square-Version: 2021-09-15' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "idempotency_key": "{UNIQUE_KEY}",
    "order": {
      "location_id": "X9XWRESTK1CZ1",
      "line_items": [
        {
          "catalog_object_id": "{COFFEE_ITEM_ID}",
          "modifiers": [
            {
              "catalog_object_id": "{SMALL_MODIFIER_ID}"
            }
          ],
          "quantity": "1"
        }
      ],
      "fulfillments": [
        {
          "type": "PICKUP",
          "state": "PROPOSED",
          "pickup_details": {
            "recipient": {
              "display_name": "Jaiden Urie"
            },
            "expires_at": "2019-02-14T20:21:54.859Z",
            "auto_complete_duration": "P0DT1H0S",
            "schedule_type": "SCHEDULED",
            "pickup_at": "2019-02-14T19:21:54.859Z",
            "note": "Pour over coffee"
          }
        }
      ]
    }
  }'

View orders in the Seller Dashboard Permalink Get a link to this section

An order appears in the Seller Dashboard if both the following conditions are true:

  • The order includes fulfillment.

  • The order is paid.

If you are testing in the Square Sandbox, the order appears in the Seller Dashboard in Sandbox mode, but not in Production mode. For more information, see Sandbox Seller Dashboard.

Calculate an order Permalink Get a link to this section

While the CreateOrder endpoint creates an order (persists the order), the CalculateOrder endpoint enables applications to preview prices without creating an order. For example, Square Virtual Terminal uses this endpoint in the application flow to show pricing to the buyer without creating an order. The order is created only after the buyer proceeds to checkout. You can integrate CalculateOrder in your applications. For more information about Virtual Terminal, see Get Started with Virtual Terminal.

Pricing previews are also useful when applications integrate advanced pricing components, such as rewards and discounts. For example, an eCommerce application might integrate the Square loyalty program to offer buyer loyalty discounts. The application can use the CalculateOrder endpoint to show buyers a preview of applying loyalty points to their orders without locking loyalty points until the buyers are ready to pay for the order. For example, see Deferred reward creation.

In the CalculateOrder request, you provide the following:

  • A complete order. The order you provide can be an existing order or an order that has not been created.

  • Proposed rewards. The rewards to apply.

The endpoint creates a copy of the order (not persisted) with the specified discount applied. Applications can then show the order as a preview to help the buyer make a decision.

Create a draft order Permalink Get a link to this section

In the current implementation, the CreateOrder endpoint by default sets the state of the order it creates to OPEN. An OPEN state indicates that the order can be fulfilled and payment can be processed.

In some application scenarios, such as an eCommerce cart building application, buyers add items to the cart only to later abandon the order. In such scenarios, applications can create temporary orders by explicitly setting the order state to DRAFT in a CreateOrder request.

{
  "order": {
    "line_items": …,
    "state": "DRAFT"
  }
}

Orders in the DRAFT state cannot be fulfilled or paid. For example, Square first-party products or the Payments API cannot process payments for a DRAFT order. When the buyer is ready to make the purchase, the application can call UpdateOrder to set the order state to OPEN so that the order can be fulfilled or payment can be processed.

{
  "order": {
    "id": …,
    "version": …,
    "state": "OPEN"
  }
}

Note that applications can use UpdateOrder to both change the state and fulfill the order at the same time.

In the current implementation, the Orders API does not provide an endpoint to delete an order. However, Square reserves the right to delete DRAFT orders that have not been updated in 30 days.

Applications can use the order state as a search filter in SearchOrders to retrieve only orders that can be fulfilled (state is OPEN) as shown.

curl https://connect.squareupsandbox.com/v2/orders/search \
  -X POST \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": {
      "filter": {
        "state_filter": {
          "states": [
            "OPEN"
          ]
        }
      }
    },
    "location_ids": [
      "{LOCATION_ID}"
    ]
  }'

In summary, a DRAFT order differs from an OPEN order as follows:

  • A DRAFT order cannot be fulfilled. You can create fulfillments, but they cannot progress beyond the initial PROPOSED fulfillment state.

  • A DRAFT order cannot be paid. That is, a DRAFT order does not have tenders added.

  • There is no guarantee you can retrieve a DRAFT order 30 days after creation.

  • A DRAFT order does not appear in Sales Summary reports in the Seller Dashboard.

Clone an order Permalink Get a link to this section

The CloneOrder endpoint enables applications to easily reorder without having to create an order from scratch. In the request, you provide an existing order number to clone.

You can clone any existing order regardless of the order state, but a cloned order has DRAFT as the initial state. The cloned order is like any other order created using the CreateOrder endpoint. The order follows the normal order lifecycle and can be modified like any other order.

When cloning an existing order, the endpoint copies only the applicable fields in the new order, such as:

  • merchant_id

  • location_id

  • customer_id

  • line_items (except for server-computed fields)

  • taxes

  • discounts

  • service_charges

  • pricing_options

Orders also have other fields that are specific to individual orders, such as fulfillments, tenders, metadata, reference_id, rewards, and the timestamp fields. These field values are not copied.

For more information and an example, see CloneOrder.

Related topics Permalink Get a link to this section