---
title: "Orders"
method: GET
path: "/v1/orders"
---

# Orders

`GET /v1/orders`

## Request

- Base URL: `https://api.octapi.app`
- URL: `https://api.octapi.app/v1/orders`
- Auth: HTTP bearer

## Query parameters

- `status` 'pending' | 'paid' | 'fulfilled' | 'cancelled' | 'refunded'

## Response `200`

Default Response

- object
  - `orders` object[], required
    - `id` string, required
    - `reference` string, nullable, required
    - `buyer_name` string, nullable, required
    - `status` 'pending' | 'paid' | 'fulfilled' | 'cancelled' | 'refunded', required
    - `currency` string, nullable, required
    - `total_cents` number, nullable, required
    - `placed_at` union, required
      - string
      - string, date-time
    - `items` unknown[], required
      - unknown
    - `shipments` unknown[], nullable
      - unknown

---

[API](https://skmtc.dev/octapi/apis/octapi-api.md) · [All operations](https://skmtc.dev/octapi/apis/octapi-api/llms.txt) · [OpenAPI document](https://skmtc.dev/octapi/apis/octapi-api/revisions/580afda787d2?raw)