Skip to main content
GET
/
orders
List orders
curl --request GET \
  --url https://api.autoprintfarm.com/public/v1/orders \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "order_number": "<string>",
      "platform": "<string>",
      "customer_name": "<string>",
      "customer_email": "<string>",
      "customer_phone": "<string>",
      "order_date": "<string>",
      "status": "<string>",
      "total_revenue": 123,
      "shipping_cost": 123,
      "tax_amount": 123,
      "discount_amount": 123,
      "shipping_street": "<string>",
      "shipping_city": "<string>",
      "shipping_state": "<string>",
      "shipping_zip": "<string>",
      "shipping_country": "<string>",
      "tracking_number": "<string>",
      "tracking_url": "<string>",
      "shipped_at": "<string>",
      "external_id": "<string>",
      "notes": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "meta": {
    "limit": 123,
    "offset": 123,
    "count": 123,
    "total": 123
  }
}

Authorizations

Authorization
string
header
required

API keys are minted in the AutoPrintFarm web app under Settings → API Keys. Send as Authorization: Bearer apf_live_.... Keys are shown exactly once at creation and can be revoked at any time.

Query Parameters

status
string

Filter by order status (e.g. pending, processing, printed, assembled, shipped, fulfilled, cancelled, refunded)

platform
string

Filter by source platform (e.g. shopify, etsy, manual, other)

from
string

Return orders placed on or after this ISO-8601 timestamp (e.g. 2026-01-01T00:00:00Z)

to
string

Return orders placed on or before this ISO-8601 timestamp

limit
integer
default:50

Maximum number of rows to return (1-100)

Required range: 1 <= x <= 100
offset
integer | null
default:0

Number of rows to skip for pagination

Required range: x >= 0

Response

Order list

success
enum<boolean>
required
Available options:
true
data
object[]
required
meta
object
required