> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bizmori.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 注文一覧を取得

> ページネーション付きで注文を取得します。
- ステータス、タイプ、チャネルでフィルタリング
- キーワード検索に対応
- 最新順にソート



## OpenAPI

````yaml ja/api-reference/openapi.yaml GET /api/v2/orders
openapi: 3.0.0
info:
  title: BIZ MORI API
  version: 2.0.0
  description: >-
    BIZ MORI API は、デジタルコンテンツ保護のための4つのコアサービスを提供します:

    - **Anti-AI**: 画像をAI学習から保護

    - **Watermark Embed**: 画像に不可視のデジタル watermark を埋め込み

    - **Watermark Extract**: 画像から watermark を抽出・検証

    - **AI Detection**: 画像がAI生成かどうかを検知

    - **テストAPIキー**: `sk_test_`
    プレフィックスのキーは同じBearer認証を使用し、実際の処理サービスの実行やクレジットの消費なしに注文ライフサイクルを検証できます。テストアップロードの内容は破棄され、結果ファイルは作成されません
  contact:
    name: BIZ MORI サポート
    email: support@bizmori.com
servers:
  - url: https://api.bizmori.com
    description: 本番環境
security: []
tags:
  - name: Anti-AI
    description: Anti-AI画像保護の注文
  - name: Watermark Embed
    description: watermark 埋め込みの注文
  - name: Watermark Extract
    description: watermark 抽出の注文
  - name: AI Detection
    description: AI生成画像検知の注文
  - name: Orders
    description: 注文の照会と管理
  - name: Webhooks
    description: Webhookの設定とイベント
paths:
  /api/v2/orders:
    get:
      tags:
        - Orders
      summary: 注文一覧を取得
      description: |-
        ページネーション付きで注文を取得します。
        - ステータス、タイプ、チャネルでフィルタリング
        - キーワード検索に対応
        - 最新順にソート
      parameters:
        - in: query
          name: page
          schema:
            type: integer
            default: 1
            minimum: 1
          description: ページ番号
        - in: query
          name: limit
          schema:
            type: integer
            default: 10
            minimum: 1
            maximum: 100
          description: ページあたりの項目数（-1ですべて取得）
        - in: query
          name: keyword
          schema:
            type: string
          description: 検索キーワード
        - in: query
          name: status
          schema:
            type: string
            enum:
              - pending
              - inProgress
              - complete
              - failed
              - expired
              - all
            default: all
          description: ステータスフィルター
        - in: query
          name: type
          schema:
            type: string
            enum:
              - antiAi
              - watermarkEmbed
              - watermarkExtract
              - aiDetection
              - all
          description: 注文タイプフィルター
        - in: query
          name: channel
          schema:
            type: string
            enum:
              - api
              - web
              - all
            default: all
          description: チャネルフィルター
      responses:
        '200':
          description: 成功
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      orders:
                        type: array
                        items:
                          $ref: '#/components/schemas/Order'
                      pageInfo:
                        $ref: '#/components/schemas/PageInfo'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - BearerAuth: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: >-
            curl -X GET
            "https://api.bizmori.com/api/v2/orders?page=1&limit=10&status=all" \
              -H "Authorization: Bearer YOUR_API_TOKEN"
        - lang: javascript
          label: JavaScript
          source: >-
            const params = new URLSearchParams({ page: 1, limit: 10, status:
            'all' });

            const response = await fetch(
              `https://api.bizmori.com/api/v2/orders?${params}`,
              { headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' } }
            );

            const data = await response.json();
        - lang: python
          label: Python
          source: |-
            import requests

            response = requests.get(
                'https://api.bizmori.com/api/v2/orders',
                headers={'Authorization': 'Bearer YOUR_API_TOKEN'},
                params={'page': 1, 'limit': 10, 'status': 'all'}
            )
            data = response.json()
components:
  schemas:
    Order:
      type: object
      properties:
        orderId:
          type: string
          description: 注文ID
        orderName:
          type: string
          description: 注文名
        type:
          type: string
          enum:
            - antiAi
            - watermarkEmbed
            - watermarkExtract
            - aiDetection
          description: 注文タイプ
        channel:
          type: string
          enum:
            - api
            - web
          description: 注文チャネル
        status:
          type: string
          enum:
            - pending
            - inProgress
            - complete
            - failed
            - expired
          description: |-
            注文ステータス
            * pending - 待機中
            * inProgress - 処理中
            * complete - 完了
            * failed - 失敗
            * expired - 期限切れ（注文作成から7日経過するとファイルはダウンロードできません）
        fileCount:
          type: integer
          description: ファイル数
        thumbnailImageUrl:
          type: string
          format: uri
          nullable: true
          description: サムネイル画像URL（プリサインドURL）
        createdAt:
          type: string
          format: date-time
          description: 作成日時
        updatedAt:
          type: string
          format: date-time
          description: 最終更新日時
        probability:
          type: number
          nullable: true
          description: AI検知確率（aiDetection注文専用）
        statusCode:
          type: string
          nullable: true
          enum:
            - likely_real
            - uncertain_real
            - uncertain_ai
            - likely_ai
          description: |-
            AI検知結果コード（aiDetection注文専用）
            * likely_real - 実在コンテンツである可能性が高い
            * uncertain_real - 不確実、実在寄り
            * uncertain_ai - 不確実、AI生成寄り
            * likely_ai - AI生成コンテンツである可能性が高い
    PageInfo:
      type: object
      properties:
        totalItems:
          type: integer
          description: 総項目数
        totalPages:
          type: integer
          description: 総ページ数
        currentPage:
          type: integer
          description: 現在のページ番号
        itemsPerPage:
          type: integer
          description: ページあたりの項目数
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: エラーコード
  responses:
    Unauthorized:
      description: 認証失敗
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: AUTH_NOT_AUTHENTICATED
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        外部クライアントアクセス用のBearer APIキー。本番キーは `sk_` プレフィックスを使用し、テストキーは `sk_test_`
        プレフィックスを使用して、処理やクレジット消費なしに注文ライフサイクルを検証します。

````