B2Bドキュメント

B2B API – 注文情報と商品情報を自動取得

当社のREST APIは、顧客アカウントをお持ちのすべての顧客にご利用いただけ、注文情報と商品情報を自動的に取得して独自のシステムに統合することができます。

認証

すべてのAPIリクエストには、HTTPヘッダーに含めて送信する有効なAPIキーが必要です。APIアクセスはあなたの顧客アカウントに紐付けられており、顧客アカウントには基本的にご利用いただけます。

info 別途B2Bの申請は不要です。顧客アカウントでログインし、APIタブを開いて、そこでAPIキーを生成してください。 APIアクセスへ →

ヘッダー形式

HTTP Request Header

X-API-Key: YOUR_API_KEY_HERE
Content-Type: application/json
Accept: application/json

cURLでの例

cURL

curl -X GET "https://artumos.com/api/v1/orders" \
  -H "X-API-Key: YOUR_API_KEY_HERE" \
  -H "Accept: application/json"

Base URL

すべてのエンドポイントは次のBase URLからの相対パスです:

Base URL

https://artumos.com/api/v1

すべてのレスポンスは JSON として返されます (Content-Type: application/json).

Rate Limits

Plan	リクエスト / 分	リクエスト / 日
顧客アカウント	60	5.000
拡張された制限	お問い合わせください	お問い合わせください

超過した場合は HTTP 429 Too Many Requests が返されます。ヘッダー Retry-After には待機時間が秒単位で含まれます。

エラーコード

HTTP-Code	意味
`200 OK`	リクエスト成功
`400 Bad Request`	無効なパラメータ
`401 Unauthorized`	APIキーが欠落しているか無効です
`403 Forbidden`	このリソースへの権限がありません
`404 Not Found`	リソースが見つかりません
`429 Too Many Requests`	レート制限を超過しました
`500 Internal Server Error`	サーバーエラー – サポートにお問い合わせください

エラーレスポンス形式

JSON

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key."
  }
}

エンドポイント: 注文

GET /api/v1/orders アカウントのすべての注文

Parameter	型	説明
`page`	integer	ページ (デフォルト: 1)
`per_page`	integer	ページごとのエントリ数 (最大 100)
`status`	string	`paid` \| `pending` \| `all`

Beispiel-Response

{
  "success": true,
  "data": {
    "orders": [
      {
        "id": "ORD-12345",
        "status": "paid",
        "total": 49.99,
        "currency": "EUR",
        "created_at": "2026-01-15T10:30:00Z",
        "items_count": 2
      }
    ],
    "pagination": {
      "page": 1,
      "per_page": 20,
      "total": 42
    }
  }
}

GET /api/v1/orders/{order_id} 個別の注文を取得

エンドポイント: 商品情報と注文情報

GET /api/v1/orders/{order_id}/codes 注文のすべての商品情報

Beispiel-Response

{
  "success": true,
  "data": {
    "order_id": "ORD-12345",
    "codes": [
      {
        "id": "CODE-789",
        "product_name": "Beispielprodukt vom Marktplatz",
        "product_sku": "ART-PRODUCT-001",
        "product_info": "Hinweise laut Verkäuferangaben",
        "delivery_url": "https://...",
        "delivered_at": "2026-01-15T10:31:00Z",
        "status": "active"
      }
    ]
  }
}

GET /api/v1/codes/{code_id} 個別の商品情報を取得

warning 商品情報と注文情報は、該当する注文および販売者情報の範囲内でのみ使用できます。不正な転送は利用規約に違反する可能性があります。

エンドポイント: 商品

GET /api/v1/products 商品カタログを取得

Parameter	型	説明
`category`	string	カテゴリースラッグでフィルタ
`in_stock`	boolean	在庫のある商品のみ
`page`	integer	ページ

Beispiel-Response

{
  "success": true,
  "data": {
    "products": [
      {
        "id": 42,
        "sku": "ART-PRODUCT-001",
        "name": "Beispielprodukt vom Marktplatz",
        "price": 49.99,
        "currency": "EUR",
        "in_stock": true,
        "category": "handmade"
      }
    ]
  }
}

Webhooks

Webhookを使用すると、注文やコードが提供された際にリアルタイム通知を受信できます。Webhookのurlは顧客アカウントに登録できます。

利用可能なイベント

Event	説明
`order.paid`	注文が支払われました
`codes.delivered`	コードが提供されました
`order.refunded`	注文が返金されました

Webhook Payload

POST – あなたのWebhookエンドポイント

{
  "event": "codes.delivered",
  "timestamp": "2026-01-15T10:31:05Z",
  "data": {
    "order_id": "ORD-12345",
    "codes_count": 2
  },
  "signature": "sha256=..."
}

Webhookシークレットで署名を検証してください: HMAC-SHA256(payload, webhook_secret)

よくある質問

誰がB2B APIを利用できますか?

顧客アカウントをお持ちのすべての顧客がAPIアクセスを利用できます。顧客アカウントにログインし、認証済みリクエストには対応するAPIキーを使用してください。

レスポンスはどのような形式ですか?

すべてのレスポンスはJSONとして返されます。ルートオブジェクトには常に success: true/false が含まれ、さらに data または error.

API経由で注文できますか?

最初のバージョンでは、APIは注文、注文情報、商品情報の取得に使用されます。書き込み用の注文エンドポイントは、利用可能になり次第、別途公開されます。

サンドボックス環境はありますか?

はい。サンドボックスは顧客アカウントの「APIアクセス」タブで有効化でき、該当するAPIキーに直接紐付けられます。