概要
APIリファレンス
指定された契約情報の内容でギフトとして決済を即時に行う。
※ 一般設定画面の「スキップ時ギフトを有効にする」にチェックを入れた場合のみ利用可能です
項目名 | 内容 |
---|---|
アクション名 | newOrderForSkipGift |
リクエストメソッド | POST |
項目名 | 内容 | 必須 | フォーマット | 入力例 | 備考 |
---|---|---|---|---|---|
subscriptionContractId | 定期購買ID | はい | gid://shopify/SubscriptionContract/*** | gid://shopify/SubscriptionContract/1111111111 |
決済情報が返却されます。
■正常時レスポンス
プロパティ | 型 | 説明 |
---|---|---|
subscriptionBillingAttemptId | string | 決済のShopify管理ID |
ready | boolean | true:決済完了、false:決済中(今すぐ注文時点ではfalse固定) |
createdAt | string | 決済作成日 |
isSkipGift | boolean | スキップギフトか否か |
■異常時レスポンス
ステータスコード | 型 | エラーメッセージ | 備考 |
---|---|---|---|
400 | string | 定期購買はすでに解約されています | |
400 | string | この定期購買の契約種別では許可されていない操作です | |
403 | string | 決済に失敗しました。画面を更新し、支払い履歴を確認してください。 | |
403 | string | このストアはエンタープライズプランではありません | |
403 | string | スキップギフト設定が無効です | |
403 | string | ギフト機能が利用できません | |
403 | string | 決済に失敗しました。画面を更新し、支払い履歴を確認してください。 | |
404 | string | 定期購買が存在しません | |
404 | string | ストアが存在しません | |
409 | string | 契約情報を更新しています。更新が完了するまでお待ちください。 | 「送料の自動計算」機能がONの場合のみ返却されます |
409 | string | 現在決済処理中のため、しばらく時間をおいてからお試しください。 | |
500 | string | ギフト注文の作成に失敗しました。 |