> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.getanalog.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getanalog.ai/_mcp/server.

# Get Orders

GET https://api.getanalog.ai/v1/orders

Retrieves a paginated list of orders with optional filters such as date range, store, phone number, and payment status.

Reference: https://docs.getanalog.ai/api-reference/orders/get-orders-v-1-orders-get

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `end_date` (datetime, optional)
- `limit` (integer, optional)
- `merchant_id` (string, optional)
- `page` (integer, optional)
- `payment_status` (enum, optional)
  - Allowed values: `pending`, `failed`, `cancelled`, `paid`
- `phone` (string, optional)
- `start_date` (datetime, optional)
- `store_id` (string, optional)

## Response

### 200

Successful Response

- `data` (OrderResponseList, required)
- `limit` (integer, required)
- `page` (integer, required)
- `total` (integer, required)
- `object` (string, required)

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

## Types

### OrderResponseList

- `orders` (list of OrderResponseExtended, required)

### ValidationError

- `loc` (list of ValidationErrorLocItem, required)
- `msg` (string, required)
- `type` (string, required)

### OrderResponseExtended

- `id` (string, required) — Unique identifier for the order
- `store` (StorePartialInfoWithAnalogID, required) — Store information associated with the order
- `customer` (CustomerBase, required) — Customer who placed the order
- `status` (enum, required) — Current status of the order
  - Allowed values: `PENDING`, `CUSTOMER_CANCELLED`, `STORE_CANCELLED`, `ACCEPTED`, `REJECTED`, `READY`, `FULFILLED`, `AUTO_ACCEPTED`
- `price` (integer, required) — Total price of the order in cents
- `tax` (integer, required) — Total tax amount in cents
- `items` (list of map from string to any, required) — List of items in the order
- `ready_by` (datetime, required) — Requested ready time for the order
- `created_at` (datetime, required) — Time when the order was created
- `is_read` (boolean, required) — Whether the order has been read
- `in_pos` (boolean, required) — Whether the order has been synced to POS
- `object` (string, required) — Usually "Order" for an order object
- `customer_comments` (string, optional) — Optional comments from the customer
- `ready_at` (datetime, optional) — Actual time when order was marked ready
- `completed_at` (datetime, optional) — Time when the order was completed
- `payment_status` (enum, optional) — Current status of the payment
  - Allowed values: `pending`, `failed`, `cancelled`, `paid`
- `payment_method` (enum, optional) — Method used for payment
  - Allowed values: `PAY_BY_LINK`, `PAY_IN_STORE`

### ValidationErrorLocItem

- string
- integer

### StorePartialInfoWithAnalogID

- `created_at` (datetime, required)
- `id` (string, required)
- `name` (MultilingualText, required)
- `external_id` (string, optional)

### CustomerBase

- `name` (string, required)
- `phone` (string, required)

### MultilingualText

- `translations` (map from string to string, required) — Translations for different languages

## Examples

**Response**

```json
{
  "data": {
    "orders": [
      {
        "id": "1234",
        "store": {
          "created_at": "2024-01-15T09:30:00Z",
          "id": "5678",
          "name": {
            "translations": {
              "en": "Downtown Store"
            }
          },
          "external_id": "store_ext_123"
        },
        "customer": {
          "name": "John Doe",
          "phone": "+1234567890"
        },
        "status": "ACCEPTED",
        "price": 2995,
        "tax": 245,
        "items": [
          {
            "name": "Burger Combo",
            "quantity": 2,
            "price": 1495,
            "tax": 123
          }
        ],
        "ready_by": "2024-01-15T12:30:00Z",
        "created_at": "2024-01-15T09:30:00Z",
        "is_read": true,
        "in_pos": true,
        "object": "Order",
        "customer_comments": "No onions please",
        "ready_at": "2024-01-15T12:25:00Z",
        "completed_at": "2024-01-15T12:35:00Z",
        "payment_status": "paid",
        "payment_method": "PAY_BY_LINK"
      }
    ]
  },
  "limit": 100,
  "page": 1,
  "total": 245,
  "object": "list"
}
```

**SDK Code**

```python
import requests

url = "https://api.getanalog.ai/v1/orders"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.getanalog.ai/v1/orders';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getanalog.ai/v1/orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.getanalog.ai/v1/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.getanalog.ai/v1/orders")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.getanalog.ai/v1/orders', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.getanalog.ai/v1/orders");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.getanalog.ai/v1/orders")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```