• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Retrieve order

GET /v2/orders/{order_id}

Retrieves an Order by ID.

Permissions
ORDERS_READ
 Try in API Explorer

Path Parameters

Example code
Name Description
order_id
string
Required

The ID of the order to retrieve.

Response Fields
Name Description
order
Order

The requested order.
errors
Error [ ]

Any errors that occurred during the request.

Examples

You are viewing an old version of the API
GET /v2/orders/{order_id}
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js 
curl https://connect.squareup.com/v2/orders/CAISENgvlJ6jLWAzERDzjyHVybY \
  -H 'Square-Version: 2022-06-16' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON 
{
  "order": {
    "id": "CAISENgvlJ6jLWAzERDzjyHVybY",
    "location_id": "D7AVYMEAPJ3A3",
    "line_items": [
      {
        "uid": "ULkg0tQTRK2bkU9fNv3IJD",
        "quantity": "1",
        "name": "Item 1",
        "base_price_money": {
          "amount": 500,
          "currency": "USD"
        },
        "gross_sales_money": {
          "amount": 500,
          "currency": "USD"
        },
        "total_tax_money": {
          "amount": 0,
          "currency": "USD"
        },
        "total_discount_money": {
          "amount": 250,
          "currency": "USD"
        },
        "total_money": {
          "amount": 250,
          "currency": "USD"
        },
        "variation_total_price_money": {
          "amount": 500,
          "currency": "USD"
        },
        "applied_discounts": [
          {
            "uid": "9zr9S4dxvPAixvn0lpa1VC",
            "discount_uid": "zGsRZP69aqSSR9lq9euSPB",
            "applied_money": {
              "amount": 250,
              "currency": "USD"
            }
          }
        ]
      },
      {
        "uid": "mumY8Nun4BC5aKe2yyx5a",
        "quantity": "2",
        "name": "Item 2",
        "base_price_money": {
          "amount": 300,
          "currency": "USD"
        },
        "gross_sales_money": {
          "amount": 600,
          "currency": "USD"
        },
        "total_tax_money": {
          "amount": 0,
          "currency": "USD"
        },
        "total_discount_money": {
          "amount": 300,
          "currency": "USD"
        },
        "total_money": {
          "amount": 300,
          "currency": "USD"
        },
        "variation_total_price_money": {
          "amount": 600,
          "currency": "USD"
        },
        "applied_discounts": [
          {
            "uid": "qa8LwwZK82FgSEkQc2HYVC",
            "discount_uid": "zGsRZP69aqSSR9lq9euSPB",
            "applied_money": {
              "amount": 300,
              "currency": "USD"
            }
          }
        ]
      }
    ],
    "discounts": [
      {
        "uid": "zGsRZP69aqSSR9lq9euSPB",
        "name": "50% Off",
        "percentage": "50",
        "applied_money": {
          "amount": 550,
          "currency": "USD"
        },
        "type": "FIXED_PERCENTAGE",
        "scope": "ORDER"
      }
    ],
    "created_at": "2020-05-18T16:30:49.614Z",
    "updated_at": "2020-05-18T16:30:49.614Z",
    "state": "OPEN",
    "version": 1,
    "total_tax_money": {
      "amount": 0,
      "currency": "USD"
    },
    "total_discount_money": {
      "amount": 550,
      "currency": "USD"
    },
    "total_tip_money": {
      "amount": 0,
      "currency": "USD"
    },
    "total_money": {
      "amount": 550,
      "currency": "USD"
    },
    "total_service_charge_money": {
      "amount": 0,
      "currency": "USD"
    },
    "net_amounts": {
      "total_money": {
        "amount": 550,
        "currency": "USD"
      },
      "tax_money": {
        "amount": 0,
        "currency": "USD"
      },
      "discount_money": {
        "amount": 550,
        "currency": "USD"
      },
      "tip_money": {
        "amount": 0,
        "currency": "USD"
      },
      "service_charge_money": {
        "amount": 0,
        "currency": "USD"
      }
    }
  }
}