目次

１．基本情報

指定された契約情報の内容で決済を即時に行う。

項目名 内容
アクション名 newOrder
リクエストメソッド POST

２．リクエストに必要な内容

項目名 内容 必須 フォーマット 入力例 備考
subscriptionId 定期購買ID はい gid://shopify/SubscriptionContract/*** gid://shopify/SubscriptionContract/1111111111
withSkip 次回決済をスキップ いいえ boolean true false
deliveryDate お届け日 いいえ YYYY-MM-DD 2024-09-09
deliveryTime お届け時間 いいえ 1文字以上2文字以下の文字列 10 アプリの「一般設定 > お届け時間設定」で設定したタグを指定する。

３．レスポンス内容

決済情報が返却されます。

■正常時レスポンス

プロパティ 型 説明
id array() 定期購買アプリ内の決済管理ID
applicationId number 定期購買アプリ内の契約商品管理ID
orderId number 注文のShopify管理ID
completedAt array() 決済完了日（今すぐ注文時点ではNULL固定）
createdAt string() 決済作成日
ready array() true：決済完了、false：決済中（今すぐ注文時点ではfalse固定）
errorCode string null
errorMessage string null
subscriptionBillingAttemptId string null
orderToken string null
orderName string null
nextBillingDateUpdate boolean true：定期決済、false：今すぐ注文
billingDate null 決済日（今すぐ注文時点ではNULL固定）
retryPayment boolean n日後再決済機能を利用して決済されたものか
idempotencyKey 決済キー 決済ごとに設定される冪等性担保のためのキー文字列
activateUponSuccess boolean 決済成功時に契約がアクティブでない場合にアクティブとするか（true：アクティブとする）

■異常時レスポンス

ステータスコード 型 エラーメッセージ
400 string 定期購買はすでに解約されています
400 string この定期購買の契約種別では許可されていない操作です
403 string 決済に失敗しました。画面を更新し、支払い履歴を確認してください。
404 string 定期購買が存在しません
404 string ストアが存在しません
404 string 指定されたお届け時間が存在しません
500 string 内部エラーが発生しています