ADMIN API
OrderオブジェクトにcheckoutTokenフィールド追加
GraphQL Admin APIで注文とチェックアウトを直接紐づけられるように
GraphQL Admin APIのOrderオブジェクトにcheckoutTokenフィールドが追加されました。これにより、注文を生成したチェックアウトのトークンをGraphQLクエリから直接取得できます。REST Admin APIに既存のcheckout_tokenフィールドと同じ値が返るため、REST→GraphQL移行中のプロジェクトでも安心して利用できます（公開日: 2026年5月15日）。
1Before / After 図解
2業務ユースケース3選
- 課題
- GraphQL移行プロジェクトで、注文とチェックアウトの紐づけ処理だけRESTに残っており移行が止まっていた
- 打ち手
-
checkoutTokenをGraphQLクエリに追加するだけで、REST呼び出しを廃止できる - 効果
- APIの統一化が進み、認証・バージョン管理・エラーハンドリングの一元化が実現できる
- 技術メモ
- 返り値はREST
checkout_tokenと同値のため、既存のトークン処理ロジックをそのまま流用可能
- 課題
- カスタムアプリで注文後のチェックアウトセッション解析を行いたいが、GraphQLだけでは情報が不足していた
- 打ち手
- 注文一覧を取得するGraphQLクエリに
checkoutTokenを含め、チェックアウトデータとJOINして分析パイプラインを構築する - 効果
- 1APIで注文とチェックアウトのトークンを一括取得でき、分析基盤のシンプル化・コスト削減につながる
- 技術メモ
- 大量注文の一括取得時はページネーション（
afterカーソル）との組み合わせが推奨される
- 課題
- サードパーティのチェックアウト追跡ツールとの連携に、チェックアウトトークンを都度RESから取得していた
- 打ち手
- Webhookで受信した注文データをGraphQLで再取得する際に
checkoutTokenも同時取得し、外部ツールへ連携する - 効果
- RESTへの依存がなくなりインテグレーションのメンテナンスコストが下がる
- 技術メモ
- Webhook + GraphQL Admin API の組み合わせは公式推奨パターン。APIバージョンは元記事に明示なし。最新バージョンを公式ドキュメントで確認のこと
3技術者目線のポイント
| 観点 | 詳細 |
|---|---|
| 対象API | GraphQL Admin API の Order オブジェクト |
| フィールド名 |
checkoutToken（GraphQL）＝ checkout_token（REST）と同一の値を返す |
| 追加方法 | 既存の Order クエリに checkoutToken を追記するだけ。スキーマ変更や設定は不要 |
| 移行への影響 | REST→GraphQL移行のブロッカーになっていたフィールドが解消。段階的移行が進めやすくなる |
| 注意点 | 対応APIバージョン・利用可能プランの明示は元記事に記載なし。本番適用前に公式ドキュメントで確認推奨 |
GraphQL
クエリ例（概念）
{
order(id: "gid://shopify/Order/123") {
id
name
checkoutToken
}
}
REST 比較
従来のRESTフィールド
GET /admin/api/orders/{id}.json
↓ レスポンスに含まれる
"checkout_token": "abc123..."
返り値は両者で同一
GraphQL Admin APIのOrderオブジェクトにcheckoutTokenが追加されたことで、注文とチェックアウトの紐づけをGraphQL単体で完結できるようになり、REST APIへの依存を排除したクリーンな移行・インテグレーション構築が可能になりました。
Source: https://shopify.dev/changelog/new-checkouttoken-field-added-to-the-order-object | 公開日: 2026年5月15日
Share:
FulfillmentOrderLineItemにshippingLineフィールドが追加
Functionログ、スコープ付与で自動表示に