GET /v1/orders

scope

read_orders

リクエストパラメーター

名前	位置	型	必須	説明
limit	クエリ	integer	任意	1 回に返す件数（1〜100）。既定 20
offset	クエリ	integer	任意	取得を開始する位置（0 始まり）。⚠️ 走査の途中でデータが更新されると取りこぼす。注文の増分取得には after_id と updated_since を使ってください
status	クエリ	object	任意	注文ステータスで絞り込む
after_id	クエリ	string	任意	前回の続きから取得するためのカーソル。updated_since と併用すると『同じ更新時刻の中で、この ID より後のもの』から返します。offset の代わりにこれを使うと、走査の途中で注文が更新されても取りこぼしません
updated_since	クエリ	string	任意	ISO 8601 形式。この時刻以降に更新された注文のみ返します（境界を含む）。増分取得に使います。指定時は updated_at の昇順（同時刻は order_id 昇順）で返すため、最後に受け取った updated_at を次回のカーソルにできる

レスポンスの例

{
  "data": [
    {
      "id": "1001",
      "ordered_at": "2026-06-01T03:00:00Z",
      "updated_at": "2026-06-01T03:30:00Z",
      "status": "init",
      "payment_method": "card",
      "total": {
        "amount": 3200,
        "currency": "JPY"
      },
      "is_subscription": true,
      "inflow_route": {
        "id": "12",
        "code": "gift-quick",
        "name": "ギフトクイックURL"
      },
      "gift_status": "none",
      "gift_source_order_id": "1000"
    }
  ],
  "pagination": {
    "limit": 0,
    "offset": 0,
    "total": 0
  }
}

解説

注文ヘッダを一覧取得します。買い手の個人情報は含みません。status で絞り込めます。updated_since（ISO 8601）を指定すると増分取得になり、updated_at の昇順（同時刻は注文 ID 昇順）で返します。境界は含むため同じ注文が再度返ることがあります（欠落なし・重複あり）。応答の最後の updated_at を次回の updated_since に渡し、重複は注文 ID で除外してください。

エラーレスポンスの例

{
  "error": {
    "code": "insufficient_scope",
    "message": "requires scope 'read_orders'",
    "request_id": "req_01H..."
  }
}

返しうるエラー: 400 / 401 / 403