---
title: "ListOrders"
method: GET
path: "/v1/{location_id}/orders"
tags: ["V1Transactions"]
---

# ListOrders

`GET /v1/{location_id}/orders`

Provides summary information for a merchant's online store orders.

## Path parameters

- `location_id` string, required

## Query parameters

- `order` string
- `limit` integer
- `batch_token` string

## Response `200`

Success

- V1Order[]
  - `btc_price_satoshi` number — For Bitcoin transactions, the price of the buyer's order in satoshi (100 million satoshi equals 1 BTC).
  - `btc_receive_address` string — For Bitcoin transactions, the address that the buyer sent Bitcoin to.
  - `buyer_email` string — The email address of the order's buyer.
  - `buyer_note` string — A note provided by the buyer when the order was created, if any.
  - `canceled_note` string — A note provided by the merchant when the order's state was set to CANCELED, if any.
  - `completed_note` string — A note provided by the merchant when the order's state was set to COMPLETED, if any
  - `created_at` string — The time when the order was created, in ISO 8601 format.
  - `errors` Error[] — Any errors that occurred during the request.
    - `category` string, required — The high-level category for the error.
    - `code` string, required — The specific code of the error.
    - `detail` string — A human-readable description of the error for debugging purposes.
    - `field` string — The name of the field provided in the original request (if any) that the error pertains to.
  - `expires_at` string — The time when the order expires if no action is taken, in ISO 8601 format.
  - `id` string — The order's unique identifier.
  - `order_history` V1OrderHistoryEntry[] — The history of actions associated with the order.
    - `action` string — The type of action performed on the order.
    - `created_at` string — The time when the action was performed, in ISO 8601 format.
  - `payment_id` string — The unique identifier of the payment associated with the order.
  - `promo_code` string — The promo code provided by the buyer, if any.
  - `recipient_name` string — The name of the order's buyer.
  - `recipient_phone_number` string — The phone number to use for the order's delivery.
  - `refunded_note` string — A note provided by the merchant when the order's state was set to REFUNDED, if any.
  - `shipping_address` Address — Represents a postal address in a country. The address format is based on an [open-source library from Google](https://github.com/google/libaddressinput). For more information, see [AddressValidationMetadata](https://github.com/google/libaddressinput/wiki/AddressValidationMetadata). This format has dedicated fields for four address components: postal code, locality (city), administrative district (state, prefecture, or province), and sublocality (town or village). These components have dedicated fields in the `Address` object because software sometimes behaves differently based on them. For example, sales tax software may charge different amounts of sales tax based on the postal code, and some software is only available in certain states due to compliance reasons. For the remaining address components, the `Address` type provides the `address_line_1` and `address_line_2` fields for free-form data entry. These fields are free-form because the remaining address components have too many variations around the world and typical software does not parse these components. These fields enable users to enter anything they want. Note that, in the current implementation, all other `Address` type fields are blank. These include `address_line_3`, `sublocality_2`, `sublocality_3`, `administrative_district_level_2`, `administrative_district_level_3`, `first_name`, `last_name`, and `organization`. When it comes to localization, the seller's language preferences (see [Language preferences](https://developer.squareup.com/docs/locations-api#location-specific-and-seller-level-language-preferences)) are ignored for addresses. Even though Square products (such as Square Point of Sale and the Seller Dashboard) mostly use a seller's language preference in communication, when it comes to addresses, they will use English for a US address, Japanese for an address in Japan, and so on.
    - `address_line_1` string — The first line of the address. Fields that start with `address_line` provide the address's most specific details, like street number, street name, and building name. They do *not* provide less specific details like city, state/province, or country (these details are provided in other fields).
    - `address_line_2` string — The second line of the address, if any.
    - `address_line_3` string — The third line of the address, if any.
    - `administrative_district_level_1` string — A civil entity within the address's country. In the US, this is the state.
    - `administrative_district_level_2` string — A civil entity within the address's `administrative_district_level_1`. In the US, this is the county.
    - `administrative_district_level_3` string — A civil entity within the address's `administrative_district_level_2`, if any.
    - `country` string — The address's country, in ISO 3166-1-alpha-2 format.
    - `first_name` string — Optional first name when it's representing recipient.
    - `last_name` string — Optional last name when it's representing recipient.
    - `locality` string — The city or town of the address.
    - `organization` string — Optional organization name when it's representing recipient.
    - `postal_code` string — The address's postal code.
    - `sublocality` string — A civil region within the address's `locality`, if any.
    - `sublocality_2` string — A civil region within the address's `sublocality`, if any.
    - `sublocality_3` string — A civil region within the address's `sublocality_2`, if any.
  - `state` string — Whether the tax is an ADDITIVE tax or an INCLUSIVE tax.
  - `subtotal_money` V1Money
    - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).
    - `currency_code` string
  - `tender` V1Tender — A tender represents a discrete monetary exchange. Square represents this exchange as a money object with a specific currency and amount, where the amount is given in the smallest denomination of the given currency. Square POS can accept more than one form of tender for a single payment (such as by splitting a bill between a credit card and a gift card). The `tender` field of the Payment object lists all forms of tender used for the payment. Split tender payments behave slightly differently from single tender payments: The receipt_url for a split tender corresponds only to the first tender listed in the tender field. To get the receipt URLs for the remaining tenders, use the receipt_url fields of the corresponding Tender objects. *A note on gift cards**: when a customer purchases a Square gift card from a merchant, the merchant receives the full amount of the gift card in the associated payment. When that gift card is used as a tender, the balance of the gift card is reduced and the merchant receives no funds. A `Tender` object with a type of `SQUARE_GIFT_CARD` indicates a gift card was used for some or all of the associated payment.
    - `card_brand` string — The brand of credit card provided.
    - `change_back_money` V1Money
      - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).
      - `currency_code` string
    - `employee_id` string — The ID of the employee that processed the tender.
    - `entry_method` string — The tender's unique ID.
    - `id` string — The tender's unique ID.
    - `is_exchange` boolean — Indicates whether or not the tender is associated with an exchange. If is_exchange is true, the tender represents the value of goods returned in an exchange not the actual money paid. The exchange value reduces the tender amounts needed to pay for items purchased in the exchange.
    - `name` string — A human-readable description of the tender.
    - `pan_suffix` string — The last four digits of the provided credit card's account number.
    - `payment_note` string — Notes entered by the merchant about the tender at the time of payment, if any. Typically only present for tender with the type: OTHER.
    - `receipt_url` string — The URL of the receipt for the tender.
    - `refunded_money` V1Money
      - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).
      - `currency_code` string
    - `settled_at` string — The time when the tender was settled, in ISO 8601 format.
    - `tendered_at` string — The time when the tender was created, in ISO 8601 format.
    - `tendered_money` V1Money
      - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).
      - `currency_code` string
    - `total_money` V1Money
      - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).
      - `currency_code` string
    - `type` string — The type of tender.
  - `total_discount_money` V1Money
    - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).
    - `currency_code` string
  - `total_price_money` V1Money
    - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).
    - `currency_code` string
  - `total_shipping_money` V1Money
    - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).
    - `currency_code` string
  - `total_tax_money` V1Money
    - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).
    - `currency_code` string
  - `updated_at` string — The time when the order was last modified, in ISO 8601 format.

---

[API](https://skmtc.net/square/apis/squareup.md) · [All operations](https://skmtc.net/square/apis/squareup/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/square/squareup/versions/8d95e3639487/schema)