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

# List Orders

GET https://api.papertracc.com/v1/store/account/orders

Lists the signed-in shopper's orders, newest first: orders placed while signed in, and orders placed as a guest with the same email.

**Keys:** public key or secret key.

Reference: https://api-docs.papertracc.com/storefront/orders/list-orders

## Authentication

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

## Servers

- `https://api.papertracc.com/v1` (Production, default)
- `https://api.papertracc.com/rc-1` (Release Candidate 1)

## Request

### Query parameters

- `page` (integer, optional, default: 1) — Page number, starting at 1. Ignored when `last_id` and `keyset` are sent.
- `size` (integer, optional, default: 20) — Records per page. Defaults to 20, capped at 50.
- `last_id` (string, optional) — The `last_id` from the previous response. Send it with `keyset` to get the next page. Omit both for the first page.
- `keyset` (string, optional) — The `keyset` from the previous response. Send it with `last_id`. Copy it as it is; don't build or change it.

### Headers

- `shopper-token` (string, required) — The `token` returned when the shopper signed in. Treat it as a secret: never put it in a URL or a log.

## Response

### 200

Successfully fetched orders

- `status` (boolean, required) — Always `true` on success.
- `message` (string, required) — Human-readable outcome.
- `count` (integer, required) — Records that match the request across all pages.
- `pages` (integer, required) — Total pages at the requested size.
- `page` (integer, required) — The page returned. `0` when the request used `last_id` and `keyset`.
- `keyset` (string, required, nullable) — Send back as `keyset`, with `last_id`, to get the next page. `null` when there are no more records.
- `last_id` (string, required, nullable) — Send back as `last_id`, with `keyset`, to get the next page. `null` when there are no more records.
- `data` (list of OrderSummary, required)

## Errors

### 400 Bad Request Error

The `channel` header is missing, the body is not valid JSON, or a field failed validation.

- `status` (boolean, required) — Always `false` on a failed request.
- `message` (string, required) — What went wrong, written for the shopper or the developer.
- `error_code` (string, optional) — Present on `402` responses.

### 401 Unauthorized Error

The `shopper-token` header is missing, the session has expired, or the shopper signed out.

- `status` (boolean, required) — Always `false` on a failed request.
- `message` (string, required) — What went wrong, written for the shopper or the developer.
- `error_code` (string, optional) — Present on `402` responses.

### 402 Payment Required Error

The workspace's subscription plan does not include the Open API.

- `status` (boolean, required) — Always `false` on a failed request.
- `message` (string, required) — What went wrong, written for the shopper or the developer.
- `error_code` (string, optional) — Present on `402` responses.

## Types

### OrderSummary

- `reference` (string, required) — Order reference.
- `state` (enum, required) — `RECEIVED` until the merchant confirms it, `CONFIRMED` once confirmed or invoiced, `PAID` once paid in full, `FULFILLED` once the merchant has fulfilled it, `CANCELLED` if the merchant declined or voided it.
  - Allowed values: `RECEIVED`, `CONFIRMED`, `PAID`, `FULFILLED`, `CANCELLED`
- `currency` (string, required) — ISO 4217 code.
- `total` (string, required) — Decimal amount as a string, in the currency shown alongside it.
- `items_count` (integer, required) — Units ordered. A measured line counts as one.
- `created_at` (datetime, required)
- `checkout_reference` (string, required, nullable) — Papertracc Checkout reference for this order's payment. `null` when the order has no payment link.
- `checkout_url` (string, required, nullable) — Page where the shopper pays for the order. Only set while the payment link is open and the order is `RECEIVED` or `CONFIRMED`; show a pay button when it is present.
- `checkout_status` (enum, required) — State of the payment link. `PENDING` until paid, `PARTIALLY_PAID` after a part payment, `COMPLETED` once paid, `EXPIRED` once the link has run out, `CANCELLED` if the order was voided. `null` when the order has no payment link.
  - Allowed values: `PENDING`, `PARTIALLY_PAID`, `COMPLETED`, `EXPIRED`, `CANCELLED`
- `expected_on` (date, required, nullable) — Latest date the order was promised to ship by, when it holds backordered, pre-ordered or made-to-order items. `null` when everything ships from stock or no date was promised.
- `fulfilled_at` (datetime, required, nullable) — When the merchant marked the order as fulfilled, for example sent or handed over. `null` until then. The merchant can undo this, so it can go back to `null`.
- `amount_paid` (string, optional) — Paid so far. Only on orders paid in instalments.
- `instalments` (list of OrderInstalment, optional) — The payment schedule. Only on orders paid in instalments.
- `layaway` (OrderLayaway, optional) — Present on layaway orders.

### OrderInstalment

- `number` (integer, required)
- `due_date` (datetime, required)
- `amount` (string, required)
- `paid` (string, required) — How much of this payment has been made.
- `is_due` (boolean, required) — `true` when this payment is due now.
- `is_overdue` (boolean, required) — `true` when its due date has passed and it isn't fully paid.
- `is_release` (boolean, required) — `true` on the payment after which the goods are released.

### OrderLayaway

Present on layaway orders.

- `release_instalment` (integer, required)
- `release_amount` (string, required) — Total to pay before the goods are released.
- `left_to_release` (string, required) — What's still to pay before the goods are released.

## Examples

**Response**

```json
{
  "status": true,
  "message": "Successfully fetched orders",
  "count": 1,
  "pages": 1,
  "page": 1,
  "keyset": "string",
  "last_id": "string",
  "data": [
    {
      "reference": "QUO-0042",
      "state": "RECEIVED",
      "currency": "NGN",
      "total": "50000.00",
      "items_count": 1,
      "created_at": "2024-01-15T09:30:00Z",
      "checkout_reference": "pt_cPySEZ66jKqbI5cQ",
      "checkout_url": "https://checkout.papertracc.com/pt_cPySEZ66jKqbI5cQ",
      "checkout_status": "PENDING",
      "expected_on": "2026-11-08",
      "fulfilled_at": "2026-11-03T14:30:00Z",
      "amount_paid": "35000.00",
      "instalments": [
        {
          "number": 1,
          "due_date": "2024-01-15T09:30:00Z",
          "amount": "35000.00",
          "paid": "35000.00",
          "is_due": true,
          "is_overdue": true,
          "is_release": true
        }
      ],
      "layaway": {
        "release_instalment": 2,
        "release_amount": "70000.00",
        "left_to_release": "35000.00"
      }
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.papertracc.com/v1/store/account/orders"

headers = {
    "channel": "channel",
    "shopper-token": "shopper-token",
    "Authorization": "Bearer <apiKey>"
}

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

print(response.json())
```

```javascript
const url = 'https://api.papertracc.com/v1/store/account/orders';
const options = {
  method: 'GET',
  headers: {
    channel: 'channel',
    'shopper-token': 'shopper-token',
    Authorization: 'Bearer <apiKey>'
  }
};

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.papertracc.com/v1/store/account/orders"

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

	req.Header.Add("channel", "channel")
	req.Header.Add("shopper-token", "shopper-token")
	req.Header.Add("Authorization", "Bearer <apiKey>")

	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.papertracc.com/v1/store/account/orders")

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

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

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.papertracc.com/v1/store/account/orders")
  .header("channel", "channel")
  .header("shopper-token", "shopper-token")
  .header("Authorization", "Bearer <apiKey>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.papertracc.com/v1/store/account/orders', [
  'headers' => [
    'Authorization' => 'Bearer <apiKey>',
    'channel' => 'channel',
    'shopper-token' => 'shopper-token',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.papertracc.com/v1/store/account/orders");
var request = new RestRequest(Method.GET);
request.AddHeader("channel", "channel");
request.AddHeader("shopper-token", "shopper-token");
request.AddHeader("Authorization", "Bearer <apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "channel": "channel",
  "shopper-token": "shopper-token",
  "Authorization": "Bearer <apiKey>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.papertracc.com/v1/store/account/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()
```