Admin API/GraphQL reference/Orders①

この記事について

この記事は、Admin API/Graph QL reference/Ordersの記事を和訳したものです。

記事内で使用する画像は、公式ドキュメント内の画像を引用して使用させていただいております。

Shopify アプリのご紹介

Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。

https://apps.shopify.com/shopify-application-314?locale=ja&from=daniel

Shopify アプリである、「らくらく日本語フォント設定｜リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。

https://apps.shopify.com/font-picker-1?locale=ja&from=daniel

Order APIs

マーチャントが注文を受け取り、処理し、管理する新しい方法を提供します。

• AdjustmentSale - 注文価格の調整に関連する販売です。

• Attribute - 一般的なカスタム属性を表します。

• AttributeInput - 属性に必要な入力フィールドを指定します。

• AutomaticDiscountApplication - 自動割引アプリケーションは、自動的に適用された割引の意図を捕捉します。

• CalculatedAutomaticDiscountApplication - 割引コードアプリケーションは、注文に適用された時点での割引コードの意図をキャプチャします。

• CalculatedDiscountAllocation - 関連する割引アプリケーションによって割り当てられたラインの割引額。

• CalculatedDiscountApplication - 複数の CalculatedDiscountApplications をページングするために自動生成されるタイプです。

• CalculatedDiscountCodeApplication - 割引コードアプリケーションは、注文に適用された時点での割引コードの意図を捕捉します。

• CalculatedDraftOrder - ドラフトオーダーの計算されたプロパティです。

• CalculatedDraftOrderLineItem - ドラフトオーダーの計算されたラインアイテム。

• CalculatedLineItem - 新規に追加されたり、新しい変更が適用されたりする可能性のある、オーダー編集に関わるラインアイテムです。

• CalculatedManualDiscountApplication - 手動割引アプリケーションは、注文に対して手動で作成された割引の意図を捕捉します。

• CalculatedOrder - 編集が適用されたが保存されていない注文。

• CalculatedScriptDiscountApplication - 割引コードアプリケーションは、注文に適用された時点での割引コードの意図をキャプチャします。

• CapabilityParams - 支払い方法に関連するケイパビリティに関連するすべての情報です。

• CaptureSession -キャプチャセッションを表します。

• CaptureSessionRejectionReasonInput - キャプチャステータスの理由です。

• CaptureSessionStatus - キャプチャステータスを表します。

• CaptureSessionStatusCode - キャプチャステータスのコードです。

• CaptureSessionStatusReason - キャプチャステータスの理由。

• CuptureSessionStatusReasonRejectionCode - キャプチャの拒否理由コードです。

• CurrencySetting - 通貨設定を表します。

• CurrencySettingOperation - 通貨の設定操作を表します。

• CustomPaymentMethod - すべてのカスタム決済方法の情報を保持します。

• CustomPaymentMethodInput - カスタム支払方法を作成または更新するために必要な情報を指定します。

• DiscountAllocation - 関連する割引アプリケーションによって割り当てられた行の割引額です。

• DiscountApplication - 複数の DiscountApplications をページングするための自動生成タイプです。

• DiscountApplicationAllocationMethod - 割引の値が権利のあるラインに割り当てられる方法です。

• DiscountApplicationLevel - 割引の値がその権利付きの行に割り当てられる方法です。

• DiscountApplicationTargetSelection - 割引が適用されるオーダー上のラインで、割引アプリケーションの target_type で定義されたタイプのもの。

• DiscountApplicationTargetType - 割引が適用される注文上のラインのタイプ（例：ラインアイテムまたはシッピングライン）。

• DiscountCodeApplication - 割引コードアプリケーションは、注文に適用された時点での割引コードの意図を把握します。

• DiscountTargetType - 定期購入の割引が適用されるラインのタイプです。

• DiscountType - 割引の元のタイプです。

• DraftOrder - ドラフトオーダーを表します。マーチャントはドラフトオーダーを使用して、顧客に代わってオーダーを作成することができます。

• DraftOrderAppliedDiscount - ドラフトオーダーに適用されるオーダーレベルのディスカウントです。

• DraftOrderAppliedDiscountInput - 下書き注文に注文レベルの値引きを適用するための入力フィールドです。

• DraftOrderAppliedDiscountType - ドラフト注文に適用可能な有効な割引タイプです。

• DraftOrderDeleteInput - 削除するドラフト注文をその ID で指定します。

• DraftOrderInput - ドラフトオーダーの作成または更新に使用される入力フィールドです。

• DraftOrderLineItem - ドラフトオーダーに含まれるラインアイテムを表します。

• DraftOrderLineItemInput - ドラフトオーダーのラインアイテムを作成するために使用される入力フィールドです。

• DraftOrderSortKeys - DraftOrder クエリの有効なソートキーのセットです。

• DraftOrderStatus - 徴兵制の有効なステータスです。

• Duty - 1 つのラインアイテムに対する 1 つの Duty を表します。

• DutySale - デューティチャージに関連付けられた販売です。

• EmailInput - 電子メールのフィールドを指定します。

• GiftCardSale - ギフトカードに関連する販売です。

• LineItem - ショッピングカート内の 1 行を表します。

• LineItemMutable - ショッピングカート内の 1 つの行を表します。

• LineItemSellingPlan - 1 つのラインアイテムの販売計画を表します。

• ManualDiscountApplication - 手動割引アプリケーションは、注文に対して手動で作成された割引の意図をキャプチャします。

• Order - 注文とは、ショップから 1 つまたは複数の製品を購入するための顧客の要求です。Order オブジェクトを使用して、オーダーを取得および更新することができます。詳細は、Admin API による既存の注文の編集を参照してください。

• OrderActionType - 販売契約で可能なオーダーアクションタイプ。

• OrderAdjustment - オーダーの調整では、返金された送料や、計算された返金額と実際の返金額の差を計上します。

• OrderAdjustmentKind - 注文調整の種類。

• OrderAgreement - 注文の発注に関連する契約。

• OrderApp - 注文を作成したアプリケーションです。

• OrderCancelReason - 注文がキャンセルされる理由を表します。有効な値は、顧客、詐欺、在庫、辞退、その他です。

• OrderCaptureInput - キャプチャする認証済みトランザクションと、そこからキャプチャする合計金額を指定します。

• OrderCloseInput - 決済する未決済注文を指定します。

• OrderDisplayFinancialStatus - 注文の現在の財務状況を表します。

• OrderDisplayFulfillmentStatus - 注文の現在のフルフィルメントステータスを表します。

• OrderEditAgreement - オーダーの編集に関連する契約です。

• OrderEditAppliedDiscountInput - 注文の編集中に割引を追加するために使用される入力フィールドです。

• OrderInput - 要求された注文で更新する情報を指定します。

• OrderMarkAsPaidInput - 支払い済みとしてマークする注文を指定します。

• OrderOpenInput - 開くクローズド注文を指定します。

• OrderPaymentCollectionDetails - 追加の支払いが必要な注文の支払いコレクションの詳細です。

• OrderRisk - 注文の不正チェックを表します。

• OrderRiskLevel - 注文が不正である可能性を表します。

• OrderSortKeys - Order クエリの有効なソートキーのセットです。

• OrderStagedChange - 複数の OrderStagedChanges をページングするための自動生成されたタイプです。

• OrderStagedChangeAddCustomItem - 新しく作成されたカスタムアイテムです。

• OrderStagedChangeAddLineItemDiscount - 注文編集の一部として追加される割引アプリケーションです。

• OrderStagedChangeAddShippingLine - 注文編集の一部として追加される新しい配送ラインです。

• OrderStagedChangeAddVariant - 既存の商品バリアントから作成される新しいアイテムです。

• OrderStagedChangeDecrementItem - 既存のオーダーのラインアイテムからアイテムが削除されます。

• OrderStagedChangeIncrementItem - 既存のオーダーのラインアイテムにアイテムを追加すること。

• OrderTransaction - トランザクションは、オーダーの一部としての金銭のやり取りを表す。

• OrderTransactionInput - オーダートランザクションの作成に必要な情報を指定する。

• OrderTransactionKind - さまざまな種類の注文トランザクションです。

• OrderTransactionStatus - Transaction Status' はトランザクションの状態を表す。

• PaymentAuthorizationSettings - ショップのすべての支払い承認設定を保持します。

• PaymentMethod - 支払い方法の詳細を表します。

• PaymentMethodConfiguration - 決済方法の設定の詳細を表します。

• PaymentMethodConfigurationInput - 更新可能な、マーチャントが選択したペイメントプロバイダーの支払い方法です。

• PaymentMethodConfigurationMessage - 支払い方法が無効になった理由です。

• PaymentMethodRate - 利用可能なすべてのクレジットカードのレートタイプと値です。

• PaymentMethods - Shopify で使用される支払い方法のリストです。

• PaymentProcessingMethod - 利用可能な支払い処理方法です。

• PaymentProvider - 決済プロバイダを表します。

• PaymentProviderChurnReasonInput - 決済プロバイダの更新の理由と詳細を表します。

• PaymentProviderConfiguration - すべてのペイメントプロバイダーの設定情報を保持します。

• PeationProviderConfigurationInput - 更新可能な支払いプロバイダの構成パラメ ータです。

• PaymentProviderCredential - ペイメントゲートウェイの認証情報です。

• PaymentProviderCredentialInput - ペイメントプロバイダーの資格情報の設定に使用されるフィールドです。

• PaymentProviderCredentialLabel - 各資格情報の説明を表します。

• PeationProviderDisableReason - Shopify Payments プロバイダを無効にする理由です。

• PationsProviderFraudSettingsInput - ペイメントアカウントの不正行為の設定です。

• PeationProviderNotificationSettingsInput - アカウントの通知設定です。

• PaymentProviderOptionsInput - 更新時のペイメントプロバイダーのオプションです。

• PaymentSession - 支払いセッションを表します。

• PaymentSessionActionsRedirect - リダイレクトアクションの実行に必要なペイロードです。

• PaymentSessionNextAction - パートナーが期待する次のアクションを表します。

• PaymentSessionNextActionAction - パートナーの支払いアクションです。

• PaymentSessionNextActionContext - アクションを実行するために必要なコンテキストです。

• PaymentSessionRejectionReasonInput - 支払いステータスの理由です。

• PaymentSessionStatus - 支払い状況を表します。

• PaymentSessionStatusCode - 支払いステータスのコードです。

• PaymentSessionStatusReason - 支払いステータスの理由です。

• PaymentSessionStatusReasonRejectionCode - 支払いの拒否理由コードです。

• PaymentSettings - 支払いに関する設定です。

• PaymentsAppConfiguration - ペイメントアプリの本番環境の設定です。

• PayoutSchedulePayoutInterval - 接続された銀行口座に支払いが送信される間隔です。

• PaypalExpressActivationStatus - PayPal Express のアクティベーションステータスです。

• ProductSale - 商品に関連する販売です。

• ProviderGroup - 支払いに使用される、alternative や other などのプロバイダグループです。

• Refund - 注文内のアイテムまたはトランザクションの払い戻しを表します。

• RefundAgreement - 注文の返金に関連する契約です。

• RefundDuty - 返金される義務を表します。

• RefundDutyInput - 払い戻しの際の義務の返却に必要なフィールドを指定します。

• RefundDutyRefundType - 特定の返金義務に対して実行する返金のタイプです。

• RefundInput - 払い戻しを作成するためのフィールドを指定します。

• RefundLineItem - 返金されたラインアイテムの詳細を表します。

• RefundLineItemInput - 払い戻しのラインアイテムを戻すのに必要なフィールドを指定します。

• RefundLineItemRestockType - 特定の返金ラインアイテムに対して実行される再入荷のタイプです。

• RefundSession - 払い戻しセッションを表します。

• RefundSessionRejectionReasonInput - 返金ステータスの理由です。

• RefundSessionStatus - 返金状況を表します。

• RefundSessionStatusCode - 払い戻しステータスのコードです。

• RefundSessionStatusReason - 返金ステータスの理由。

• RefundSessionStatusReasonRejectionCode - 返金拒否の理由コードです。

• ResourceAlertIcon - リソースアラートに使用できるアイコンです。

• ResourceAlertSeverity - リソースアラートで利用可能な重大度のレベルです。

• Sale - 複数の Sales をページングするために自動生成されるタイプです。

• SaleActionType - セールで可能な注文アクションタイプです。

• SaleLineType - セールレコードで使用可能なラインタイプです。

• SaleTax - 販売記録に関連付けられた税金です。

• SalesAgreement - 複数の SalesAgreements をページングするための自動生成されたタイプです。

• ScriptDiscountApplication - スクリプト割引アプリケーションは Shopify スクリプトによって作成された注文のラインアイテムまたは配送ラインのための割引の意図をキャプチャします。

• ShippingLine - 顧客が注文時に選択した配送詳細を表します。

• ShippingLineInput - 注文の配送詳細を指定します。

• ShippingLineSale - 送料に関連付けられた販売です。

• ShippingRefund - 払い戻しで返金される送料を表します。

• ShippingRefundInput - 返金時に送料を返金するために必要なフィールドを指定します。

• ShopifyPaymentsAccountInput - 更新可能な Shopify Payments アカウントのプロパティです。

• ShopifyPaymentsBillingDetailsInput - Shopify ペイメントアカウントの請求書の詳細です。

• ShopifyPaymentsExtendedAuthorization - 拡張オーソリに関連するすべての Shopify Payments の情報を提示します。

• ShopifyPaymentsPayoutScheduleInput - Shopify ペイメントアカウントの支払いスケジュールです。

• ShopifyPaymentsRefundSet - 注文の払い戻しに関連する Shopify Payments のすべての情報を提示します。

• ShopifyPaymentsTransactionSet - 注文のトランザクションに関連する Shopify Payments のすべての情報を提示します.

• SubscriptionAppliedCodeDiscount - 適用されたコード割引を表します。

• SubscriptionBillingAttempt - サブスクリプション課金スケジュールの実行の記録です。

• SubscriptionBillingAttemptInput - サブスクリプション課金の試行を完了するために必要なフィールドを指定します。

• SubscriptionBillingPolicy - サブスクリプション課金ポリシーを表します。

• SubscriptionBillingPolicyInput - サブスクリプション課金ポリシーの入力フィールドを指定します。

• SubscriptionContract - サブスクリプション契約を表します。

• SubscriptionContractCreateInput - サブスクリプション契約の作成に必要な入力フィールドを指定します。

• SubscriptionContractLastPaymentStatus - サブスクリプション契約の最後の支払いの可能なステータス値です。

• SubscriptionContractSubscriptionStatus - 加入契約の可能なステータス値です。

• SubscriptionCyclePriceAdjustment - サブスクリプションラインの価格サイクル調整を表します。

• SubscriptionDeliveryMethod - 物理的な商品を顧客に届けるために使用する配送方法を記述します。

• SubscriptionDeliveryMethodInput - サブスクリプションドラフトの配送方法フィールドを指定します。これは入力組合であり、提供できるフィールドは 1 つだけです。指定されたフィールドにより、どの配送方法を使用するかが決まります。注：現時点では shipping のみサポートされていますが、その他の入力は購読でサポートされるようになると追加されます。

• SubscriptionDeliveryMethodShipping - 配送方法を表します: 郵送先住所と配送オプションです

• SubscriptionDeliveryMethodShippingInput - 配送方法のフィールドを指定します。この入力は、部分的な入力を受け付けます。 フィールドが提供されない場合、その前の値は変更されません。

• SubscriptionDeliveryMethodShippingOption - 定期購入契約で選択された配送オプションを表します。

• SubscriptionDeliveryMethodShippingOptionInput - 配送オプションフィールドを指定します。

• SubscriptionDeliveryPolicy - サブスクリプション デリバリー ポリシーを表します。

• SubscriptionDeliveryPolicyInput - サブスクリプション デリバリー ポリシーの入力フィールドを指定します。

• SubscriptionDiscount - 複数の SubscriptionDiscount をページングするための自動生成されたタイプです。

• SubscriptionDiscountAllocation - 特定の割引が行価格から何を減らすかを表します。

• SubscriptionDiscountEntitledLines - 割引が適用されるサブスクリプションラインを表します。

• SubscriptionDiscountFixedAmountValue - 割引の値とその適用方法を表します。

• SubscriptionDiscountPercentageValue - 割引のパーセンテージ値です。

• SubscriptionDiscountRejectionReason - 購読草稿の割引が拒否された理由です。

• SubscriptionDiscountValue - 割引の値とその適用方法です。

• SubscriptionDraft -サブスクリプションドラフトを表します。

• SubscriptionDraftInput - 予約購読ドラフトの作成に必要な入力フィールドを指定します。

• SubscriptionFreeShippingDiscountInput - 契約書の購読料無料配送割引の入力フィールドを指定します。

• SubscriptionLine - サブスクリプションラインを表します。

• SubscriptionLineInput - 契約書に新しい購読ラインを追加する際に必要な入力フィールドを指定します。

• SubscriptionLineUpdateInput - 契約上のサブスクリプションラインを更新するために必要な入力フィールドを指定します。

• SubscriptionMailingAddress - サブスクリプションのメーリングアドレスを表します。

• SubscriptionManualDiscount - カスタムの購読割引です。

• SubscriptionManualDiscountEntitledLinesInput - 割引が適用されるサブスクリプションラインを表します。

• SubscriptionManualDiscountFixedAmountInput - 割引の固定額を指定して、回線に分配します。

• SubscriptionManualDiscountInput - 契約上の購読割引の入力フィールドを指定します。

• SubscriptionManualDiscountLinesInput - 割引の対象となるラインアイテムです。

• SubscriptionManualDiscountValueInput - 割引値とその配分を指定します。

• SubscriptionPricingPolicy - サブスクリプションラインの価格設定ポリシーを表します。

• SubscriptionPricingPolicyCycleDiscountsInput - 各請求サイクルのすべての価格変更を含む配列です。

• SubscriptionPricingPolicyInput - サブスクリプションラインの時間経過に伴う予想される価格変更を記述します。

• SubscriptionShippingOption - サブスクリプション契約を配送するための配送オプションです。

• SubscriptionShippingOptionResult - サブスクリプション契約の配送オプションを取得するクエリの結果です。

• SubscriptionShippingOptionResultFailure - 利用可能な配送オプションを決定するための失敗です。

• SubscriptionShippingOptionResultSuccess - 購読契約の配信に利用可能な配送オプションです。

• SuggestedOrderTransaction - 推奨されるトランザクションを表します。

• SuggestedOrderTransactionKind - 提案された注文取引の種類を指定します。

• SuggestedRefund - 返品されたアイテムに基づいて提出される返金の提案を表します。

• TaxLine - 関連するラインアイテムに請求される税金に関する情報を表します。

• TenderTransaction - テンダートランザクションは、ショップの残高を修正するトランザクションを表します。

• TenderTransactionCreditCardDetails - このトランザクションに使用されたクレジットカードに関する情報です。

• TenderTransactionDetails - この取引に使用された支払手段に関する情報です。

• ThreeDSecureSetting - ゲートウェイの 3D セキュア設定値です。

• TipSale - チップに関連した販売です。

• TransactionFee - 注文取引に関連する取引手数料です。

• TransactionSupportedRefundType - サポートされている返金タイプです。

• VoidSession - 無効なセッションを表します。

• VoidSessionRejectionReasonInput - 無効ステータスの理由です。

• VoidSessionStatus - 無効な状態を表します。

• VoidSessionStatusCode - ボイドステータスのコードです。

• VoidSessionStatusReason - ボイドステータスの理由です。

• VoidSessionStatusReasonRejectionCode - Void の拒否理由コードです。

• captureSessionReject - 開いているキャプチャセッションを拒否します。与えられたキャプチャーセッションでcaptureSessionRejectミューテーションが完了すると、captureSessionResolveミューテーションの試みは失敗します。後続の captureSessionReject ミューテーションの試みは成功しますが、RejectionReasonInput 引数は無視されます。

• [captureSessionResolve](https://shopify.dev/api/admin/graphql/reference/orders/capturesessionresolve)** - 開いているキャプチャセッションを解決します。与えられたキャプチャーセッションでcaptureSessionResolveミューテーションが完了すると、captureSessionRejectミューテーションの試みは失敗します。後続の captureSessionResolve ミューテーションの試みは成功しますが、Details 引数は無視されます。

• customPaymentMethodCreate - カスタムの支払い方法を作成します。

• customPaymentMethodDisable - カスタムの支払い方法を無効にします。

• customPaymentMethodUpdate -カスタムの支払い方法を更新します。

• draftOrderCalculate - ドラフトオーダーのプロパティを計算します。実際にドラフトオーダーを作成することなく、税金や価格などの情報を決定するのに便利です。

• draftOrderComplete - ドラフトオーダーを完成させ、オーダーを作成します。

• draftOrderCreate - ドラフトオーダーを作成します。

• draftOrderDelete - ドラフトオーダーを削除します。

• draftOrderInvoicePreview - 下書き注文の請求書メールをプレビューします。

• draughtOrderInvoiceSend - 下書き注文の請求書を電子メールで送信します。

• draftOrderUpdate - 下書き注文を更新します。

• orderCapture - 承認された注文の支払いをキャプチャします。

• orderClose - 未決済の注文を閉じます。

• orderEditAddCustomItem - 既存の注文にカスタムラインアイテムを追加します。例えば、ギフトラッピングサービスをカスタムラインアイテムとして追加することができます。既存の注文を編集する方法については、Admin API で既存の注文を編集するを参照してください。

• orderEditAddLineItemDiscount - この注文編集中に追加されたアイテムに割引を追加します。

• orderEditAddVariant - 既存の製品バリアントからラインアイテムを追加します。

• orderEditBegin - 注文の編集を開始します。Mutation はOrderEditで動作します。すべての注文の編集は orderEditBegin で始まり、任意の数の orderEdit* のミューテーションが行われ、orderEditCommit で終了します。

• orderEditCommit - 段階的な変更をオーダーに適用し、保存します。ミューテーションは OrderEdit で行われます。すべてのオーダーエディットは orderEditBegin で始まり、任意の数の orderEdit* のミューテーションが行われ、orderEditCommit で終わります。

• orderEditRemoveLineItemDiscount - この編集の一部として追加された割引を削除します。

• orderEditSetQuantity - オーダー上のアイテムの数量を設定します。

• orderMarkAsPaid - 注文を支払い済みとしてマークします。

• orderOpen - 閉じた注文を開きます。

• orderSetFulfillmentDeadline - 注文のすべてのアイテムが履行される必要のある最新の日時を設定します。

• orderUpdate - 注文のフィールドを更新します。

• paymentProviderCreate - ペイメントプロバイダーを作成します。

• paymentProviderDisable - ペイメントプロバイダーを無効にします。

• paymentProviderEnable - ペイメントプロバイダーを有効にします。

• paymentProviderUpdate - ペイメントプロバイダーを更新します。

• paymentSessionReject - 開いている支払いセッションを拒否します。指定されたペイメントセッションで paymentSessionReject ミューテーションが完了すると、paymentSessionResolve ミューテーションの試みは失敗します。後続の paymentSessionReject ミューテーションの試みは成功しますが、RejectionReasonInput 引数は無視されます。

• paymentSessionResolve - 開いている支払いセッションを解決します。指定されたペイメントセッションで paymentSessionResolve ミューテーションが完了すると、paymentSessionReject ミューテーションの試みは失敗します。後続の paymentSessionResolve ミューテーションの試みは成功しますが、Details 引数は無視されます。

• refundCreate - 払い戻しを作成します。

• refundSessionReject - 開いている返金セッションを拒否します。refundSessionRejectのミューテーションが指定された返金セッションで完了すると、refundSessionResolveのミューテーションの試みは失敗します。後続の refundSessionReject ミューテーションの試みは成功しますが、RejectionReasonInput 引数は無視されます。

• refundSessionResolve - オープンな返金セッションを解決します。与えられた返金セッションで refundSessionResolve ミューテーションが完了した後、refundSessionReject ミューテーションの試みは失敗します。後続の refundSessionResolve ミューテーションの試みは成功しますが、Details 引数は無視されます。

• subscriptionBillingAttemptCreate - 新しいサブスクリプション課金の試みを作成します。

• subscriptionContractCreate - サブスクリプション契約を作成します。

• subscriptionContractSetNextBillingDate -サブスクリプション契約の次回請求日を設定します。

• subscriptionContractUpdate - サブスクリプション契約を更新します。

• subscriptionDraftCommit - 利用権対象物のドラフトの更新をコミットします。

• subscriptionDraftDiscountAdd - サブスクリプション契約のドラフトにサブスクリプション割引を追加します。

• SubscriptionDraftDiscountCodeApply - 購読契約ドラフトにコード割引を適用します。

• SubscriptionDraftDiscountRemove - 予約購読ドラフトから予約購読割引を削除します。

• subscriptionDraftDiscountUpdate - 予約購読ドラフト上の予約購読割引を更新します。

• subscriptionDraftFreeShippingDiscountAdd - 予約購読ドラフトに予約購読無料配送割引を追加します。

• subscriptionDraftFreeShippingDiscountUpdate - 予約購読ドラフトの送料無料割引を更新します。

• subscriptionDraftLineAdd -購読契約の草稿に購読行を追加します。

• subscriptionDraftLineRemove - 予約購読ドラフトから予約行を削除します。

• subscriptionDraftLineUpdate - 予約購読ドラフトの予約行を更新します。

• subscriptionDraftUpdate - サブスクリプションドラフトを更新します。

• voidSessionReject - 開いているボイドセッションを拒否します。voidSessionRejectのミューテーションが与えられたボイドセッションで完了した後、voidSessionResolveのミューテーションの試みは失敗します。後続の voidSessionReject ミューテーションの試みは成功しますが、RejectionReasonInput 引数は無視されます。

• voidSessionResolve - オープンなボイドセッションを解決します。voidSessionResolveの処理が完了すると、voidSessionRejectの処理はすべて失敗します。後続の voidSessionResolve ミューテーションの試みは成功しますが、Details 引数は無視されます。 無料版の DeepL 翻訳（www.DeepL.com/

UNIONS

aymentSessionNextActionContext (union)

アクションの実行に必要なコンテキストです。

可能なタイプ

PaymentSessionActionsRedirect

SubscriptionDeliveryMethod (union)

可能なタイプ

SubscriptionDeliveryMethodShipping

SubscriptionDiscountValue (union)

割引額とその適用方法。

可能なタイプ

• SubscriptionDiscountFixedAmountValue
• SubscriptionDiscountPercentageValue

SubscriptionShippingOptionResult (union)

サブスクリプション契約の配送オプションを取得するためのクエリの結果です。

可能なタイプ

• SubscriptionShippingOptionResultFailure
• SubscriptionShippingOptionResultSuccess

TenderTransactionDetails (union)

この取引で使用された決済手段に関する情報です。

可能なタイプ

TenderTransactionCreditCardDetails

OBJECTS (object)

AdjustmentSale (object)

注文価格の調整に伴う販売。

必要なアクセス
read_orders のアクセススコープです。

このページについて

• フィールド
• インプリメント

フィールド

• actionType (SaleActionType!)
  セールが表すオーダーアクションのタイプです。
• id (ID!)
  セールのユニークな識別子です。
• lineType (SaleLineType!)
  セールに割り当てられたラインタイプです。
• quantity (Int)
  注文された、または返却される予定のユニットの数です。
• taxes ([SaleTax!])
  販売に関連するすべての個別の税金です。
• totalAmount (MoneyBag!)
  税金と割引後の販売総額です。
• totalDiscountAmountafterTaxes (MoneyBag!)
  税引き後のラインアイテムに割り当てられた割引額の合計です。
• totalDiscountAmountBeforeTaxes (MoneyBag!)
  税引き前のラインアイテムに割り当てられたディスカウントの合計額です。
• totalTaxAmount (MoneyBag!)
  販売のための税金の合計額です。

Implements

• Sale

Attribute (object)

一般的なカスタム属性を表します。

このページについて

• フィールド
• Attribute を返すタイプ

フィールド

• key (String!)

  属性のキーまたは名前です。

• value (String)

  属性の値を指定します。

Attribute を返すタイプ

• CalculatedDraftOrderLineItem.customAttributes
• CalculatedLineItem.customAttributes
• DraftOrder.customAttributes
• DraftOrderLineItem.customAttributes
• LineItem.customAttributes
• LineItemMutable.customAttributes
• Order.customAttributes
• PaymentProviderConfiguration.extraSettings
• SubscriptionLine.customAttributes

AutomaticDiscountApplication (object)

自動割引適用では、自動的に適用された割引の意図を汲み取ります。

このページについて

• フィールド
• インプリメント

フィールド

allocationMethod (DiscountApplicationAllocationMethod!)
割引の値がその権利のあるアイテムに割り当てられる方法です。

index (Int!)
割引適用を識別し、計算上の割引適用の優先順位を示すために使用できる、順序付けられたインデックス。

targetSelection (DiscountApplicationTargetSelection!)
割引されたラインに割引額をどのように配分するか。

targetType (DiscountApplicationTargetType!)
割引がラインアイテムと出荷ラインのどちらに適用されるかを示します。

title (String!)
割引アプリケーションのタイトル。

value (PricingValue!)
割引適用の値。

Implements

• DiscountApplication

CalculatedAutomaticDiscountApplication (object)

割引コードアプリケーションは、注文に割引コードが適用された時点で、割引コードの意図を把握します。

必要なアクセス
read_order_edits のアクセススコープです。

このページについて

• フィールド
• インプリメント

フィールド

allocationMethod (DiscountApplicationAllocationMethod!)
割引の値を権利のあるアイテムに割り当てる方法です。

applyTo (DiscountApplicationLevel!)
割引が適用されたレベル。

description (String)
割引適用の説明です。割引が適用された理由を示す。

id (ID!)
グローバルに一意な識別子です。

targetSelection (DocountApplicationTargetSelection!)
割引されたラインに割引額をどのように配分するか。

targetType (DiscountApplicationTargetType!)
割引がラインアイテムと出荷ラインのどちらに適用されるかを指定します。

value (PricingValue!)
割引適用の値を指定します。

Implements

• CalculatedDiscountApplication

CalculatedDiscountAllocation (object)

関連する割引アプリケーションによって割り当てられたラインを割引する金額。

必要なアクセス
read_order_editsのアクセススコープです。

このページについて

• フィールド
• CalculatedDiscountAllocation を返すタイプ

フィールド

allocatedAmountSet (MoneyBag!)
割引適用によって割り当てられた金額を、ショップ通貨とプレセント通貨で表したもの。

discountApplication (CalculatedDiscountApplication!)
割り当てられた金額の元となった割引。

CalculatedDiscountAllocation を返すタイプ

• CalculatedLineItem.computedDiscountAllocations

CalculatedDiscountApplication (object)

複数の CalculatedDiscountApplications をページングするための自動生成タイプです。

このページについて

• フィールド

フィールド

edges([CalculatedDiscountApplicationEdge!])
エッジのリストです。

pageInfo(PageInfo!)
ページネーションを助けるための情報。

自動生成されたタイプで、1 つの CalculatedDiscountApplication とページネーション中のカーソルを保持します。

このページについて

• フィールド
• CalculatedDiscountApplicationEdge を返すタイプ

フィールド

cursor (String!)
ページネーションで使用するためのカーソルです。

node (CalculatedDiscountApplication!)
CalculatedDiscountApplicationEdge の末尾の項目です。

CalculatedDiscountApplicationEdge を返すタイプ

• CalculatedDiscountApplicationConnection.edge
  新しく追加されたり、新しい変更が適用される可能性のある注文編集に関わる割引アプリケーション。

フィールド

allocationMethod (DiscountApplicationAllocationMethod!)
割引の値が権利を持つアイテムに割り当てられる方法。

applyTo (DiscountApplicationLevel!)
割引が適用されたレベル。

description (String)
割引適用の説明です。割引が適用された理由を示します。

id (ID!)
グローバルに一意な識別子です。

targetSelection (DecountApplicationTargetSelection!)
割引された行に割引額をどのように配分するか。

targetType (DiscountApplicationTargetType!)
割引がラインアイテムと出荷ラインのどちらに適用されるかを指定します。

value (PricingValue!)
割引適用の値です。

Types that インプリメント CalculatedDiscountApplication

• CalculatedAutomaticDiscountApplication
• CalculatedDiscountCodeApplication
• CalculatedManualDiscountApplication
• CalculatedScriptDiscountApplication

CalculatedDiscountCodeApplication (object)

割引コード適用は、注文に割引コードが適用された時点で、その割引コードの意図を把握するものです。

必要なアクセス
read_order_edits アクセススコープ。

このページについて

• フィールド
• インプリメント

フィールド

allocationMethod (DiscountApplicationAllocationMethod!)
割引の値を権利のあるアイテムに割り当てる方法です。

appliedTo (DiscountApplicationLevel!)
割引が適用されたレベル。

code (String!)
申請時に使用された割引コードを特定する文字列です。

description (String)
割引適用の説明です。割引を適用した理由を示す。

id (ID!)
グローバルに一意な識別子です。

targetSelection (DecountApplicationTargetSelection!)
割引された行に割引額をどのように配分するか。

targetType (DiscountApplicationTargetType!)
割引がラインアイテムと出荷ラインのどちらに適用されるかを指定します。

value (PricingValue!)
割引適用の値を指定します。

Implements

• CalculatedDiscountApplication

CalculatedDraftOrder (object)

ドラフトオーダーの計算されたプロパティです。

必要なアクセス
read_draft_ordersのアクセススコープ。

このページについて

• フィールド

フィールド

appliedDiscount (DraftOrderAppliedDiscount)
ドラフトオーダーに適用されるオーダーレベルのディスカウント。

availableShippingRates ([ShippingRate!]!)
下書き注文に適用される利用可能な配送料。有効な配送先住所を持ち、少なくとも 1 つのラインアイテムを持つ顧客が必要です。

customer (Customer)
注文の草稿に対する請求書がある場合は、その請求書が送られる顧客。

lineItems ([CalculatedDraftOrderLineItem!]!)
計算されたプロパティを持つドラフトオーダーのラインアイテム。

shippingLine ([ShippingLine])
配送料を含むラインアイテム。

subtotalPrice (Money!)
ラインアイテムとその割引の小計（送料や送料割引、税金は含みません）。

taxLines ([TaxLine!]!)
各ラインアイテムと配送ラインに請求された税金の合計額。

totalPrice (Money!)
ドラフトオーダーの合計金額（税金、配送料、割引を含む）。

totalShippingPrice (Money!)
ドラフトオーダーの送料の合計。

totalTax (Money!)
ドラフト注文の税金の合計額。

CalculatedDraftOrderLineItem object (object)

ドラフトオーダーの計算されたラインアイテムです。

Required access
read_draft_orders アクセススコープ

このページについて

• フィールド
• CalculatedDraftOrderLineItem を返すタイプ

フィールド

appliedDiscount (DraftOrderAppliedDiscount)
ラインアイテムに適用される割引。

custom (Boolean!)
これが製品バリアントラインアイテムであるか、カスタムラインアイテムであるかを示します。

customAttributes ([Attribute!]!)
ラインアイテムに関する追加情報のリスト。

discountedTotal (MoneyV2!)
割引が適用された合計価格。

discountedUnitPrice (MoneyV2!)
割引が適用された単価。

fulfillmentService (FulfillmentService)
注文を履行したサービスプロバイダーの名前。

有効な値は、手動またはプロバイダの名前のいずれかです。例えば、amazon、shipwire などです。

削除されたフルフィルメント・サービスは null を返します。

image (image)
ドラフトオーダーのラインアイテムに関連するイメージ。

isGiftCard（Boolean!)
その行項目がギフトカードの購入を表しているかどうかを示す。

name (String!)
商品の名前。

originalTotal (MoneyV2!)
商品のオリジナルの単価 × 数量に基づく、行商品の合計価格（割引なし）。

originalUnitPrice (MoneyV2!)
割引が適用されていないバリアントの価格。

product (Product)
下書き注文の行アイテムに関連する製品。

quantity (Int!)
ドラフトオーダーで要求されたバリアントアイテムの数。

requiresShipping (Boolean!)
バリアントに物理的な配送が必要かどうか。

sku (String)
バリアントの SKU 番号。

taxable (Boolean!)
バリアントが課税対象かどうか。

title (String!)
商品またはバリアントのタイトル（このフィールドはカスタムラインアイテムにのみ適用されます）。

totalDiscount (MoneyV2!)
割引の合計金額。

variant (ProductVariant)
下書き注文のラインアイテムに関連するバリアント。

variantTitle (String)
バリアントの名称。

vendor (String)
variant を作ったベンダーの名前。

weight (Weight)
ドラフトオーダーラインアイテムの重量単位と値。

CalculatedDraftOrderLineItem を返すタイプ

• CalculatedDraftOrder.LineItems

CalculatedLineItem (object)

新規に追加されたり、新しい変更が適用されたりする可能性のある、注文編集に関わるラインアイテム。

必要なアクセス
read_order_edits のアクセススコープです。

このページについて

• フィールド
• CalculatedLineItem を返すタイプ
• 非推奨の Fields

フィールド

CalculatedDiscountAllocations ([CalculatedDiscountAllocation!]!)
割引アプリケーションによってラインアイテムに割り当てられた割引。

customAttributes ([Attribute!]!)
ラインアイテムに関する追加情報のリスト。

discountedUnitPriceSet (MoneyBag!)
ショップ通貨とプレセント通貨での割引適用後の合計ラインプライス。

editableQuantity (Int!)
編集可能なアイテムの合計数。

editableQuantityBeforeChanges (Int!)
現在の編集で行われた変更の前の編集可能な数量です。

editableSubtotalSet (MoneyBag!)
ショップ通貨およびプレセント通貨での、編集可能なラインの合計価格。

hasStagedLineItemDiscount (Boolean!)
計算されたラインアイテムがステージングされた割引を持っているかどうか。

id (ID!)
グローバルに一意な識別子。

image (Image)
ラインアイテムのバリアントに関連付けられた Image オブジェクト。

originalUnitPriceSet (MoneyBag!)
割引が適用されていないバリアント価格（ショップ通貨とプリセメント通貨）。

quantity (Int!)
アイテムの合計数。

restockable (Boolean!)
そのラインアイテムが再入荷可能かどうか。

restocking (Boolean!)
ラインアイテムの変更が再入荷になるかどうか。

sku (String)
バリアントの SKU 番号。

stagedChanges ([OrderStagedChange!]!)
このラインアイテムに影響を与える変更点のリスト。

title (String!)
商品またはバリアントのタイトル。

uneditableSubtotalSet (MoneyBag!)
ショップ通貨とプレセント通貨での編集不可能な行の合計価格。

variant (ProductVariant)
この行アイテムに関連する製品バリアント。カスタムラインアイテムやバリアントが削除されたアイテムの場合は null になります。

variantTitle (String)
バリアントの名前。

CalculatedLineItem を返すタイプ

• CalculatedOrder.AddedLineItems
• CalculatedOrder.lineItems

非推奨のフィールド

discountAllocations ([DiscountAllocation!]!)
割引アプリケーションによってラインアイテムに割り当てられた割引。

非推奨の警告
代わりにcalculatedDiscountAllocationsを使用してください。

複数の CalculatedLineItems をページングするための自動生成型です。

このページについて

• フィールド

フィールド

edges ([CalculatedLineItemEdge!]!)
エッジのリストです。

pageInfo (PageInfo!)
ページネーションを補助するための情報。

自動生成されたタイプで、1 つの CalculatedLineItem とページネーション時のカーソルを保持します。

このページについて

• フィールド
• CalculatedLineItemEdge を返すタイプ

フィールド

cursor (String!)
ページネーションで使用するカーソルです。

node (CalculatedLineItem!)
CalculatedLineItemEdge の最後にあるアイテムです。

CalculatedLineItemEdge を返すタイプ

• CalculatedLineItemConnection.edges

CalculatedManualDiscountApplication (object)

手動割引アプリケーションは、注文に対して手動で作成された割引の意図を捕捉します。

必要なアクセス
read_order_edits のアクセススコープです。

このページについて

• フィールド
• インプリメント

フィールド

allocationMethod (DiscountApplicationAllocationMethod!)
割引の値が権利のあるアイテムに割り当てられる方法です。

applyTo (DiscountApplicationLevel!)
割引が適用されたレベル。

description (String)
割引適用の説明です。割引が適用された理由を示します。

id (ID!)
グローバルに一意な識別子です。

targetSelection (DecountApplicationTargetSelection!)
割引された行に割引額をどのように配分するか。

targetType (DiscountApplicationTargetType!)
割引がラインアイテムと出荷ラインのどちらに適用されるかを指定します。

value (PricingValue!)
割引適用の値です。

インプリメント

• CalculatedDiscountApplication

CalculatedOrder (object)

編集が適用されているのに保存されていない注文。

必要なアクセス
read_order_edits のアクセススコープです。

このページについて

• コネクション
• フィールド
• インプリメント
• 非推奨のフィールド

コネクション

addedDiscountApplications (CulocatedDacuntApplicationConnection!)
注文に追加される新しい割引アプリケーションのみを返します。

引数	説明
after ( String )	指定されたカーソルの後に来る要素を返します。
before ( String )	指定されたカーソルの前にある要素を返します。
first ( Int )	リストから最初の n 個の要素までを返します。
last ( Int )	リストから最後の n 個の要素までを返します。
reverse ( Boolean )	基礎となるリストの順序を逆にします。 デフォルト値：false

addedLineItems (CalculatedLineItemConnection!)
順番に追加される新しいラインアイテムのみを返します。

引数	説明
after ( String )	指定されたカーソルの後に来る要素を返します。
before ( String )	指定されたカーソルの前にある要素を返します。
first ( Int )	リストから最初の n 個の要素までを返します。
last ( Int )	リストから最後の n 個の要素までを返します。
reverse ( Boolean)	基礎となるリストの順序を逆にします。 デフォルト値：false

lineItems (CalculatedLineItemConnection!)
編集を開始する前に存在していたオーダー上のすべてのアイテムを返します。は変更されたものを含みます。

引数	説明
after ( String )	指定されたカーソルの後にある要素を返します。
before ( String )	指定されたカーソルの前にある要素を返します.
first ( Int )	リストから最初の n 個の要素までを返します。
last ( Int )	リストから最後の n 個の要素までを返します。
query ( String )	サポートされているフィルターパラメーター： ・editable フィルターの使用に関する詳細な情報は、検索構文の詳細を参照してください。
reverse ( Boolean )	基礎となるリストの順序を逆にします。 デフォルト値：false

stagedChanges (OrderStagedChangeConnection!)
オーダーで行われた変更のリスト。

Argument	Description
after ( String )	指定されたカーソルの後に来る要素を返します。
before ( String )	指定されたカーソルの前にある要素を返します。
first ( Int )	リストから最初の n 個の要素までを返します。
last( Int)	リストから最後の n 個の要素までを返します。
reverse ( Boolean )	対象となるリストの順序を逆にします。 デフォルト値：false

フィールド

cartDiscountAmountSet (MoneyBag)
注文レベルのディスカウントの金額（ラインアイテムのディスカウントは含まない）をショップ通貨と請求通貨で指定します。

committed (Boolean!)
変更が注文に適用されたときに true になります。

id (ID!)
グローバルに一意な識別子です。

notificationPreviewHtml (HTML)
注文編集のための顧客通知の HTML です。

notificationPreviewTitle (String!)
顧客通知のタイトル。

originalOrder (Order!)
変更が適用されていない注文です。

subtotalLineItemsQuantity (Int!)
注文の小計に貢献するラインアイテムの数量の合計です。

subtotalPriceSet (MoneyBag)
ショップ通貨およびプレセント通貨での、ラインアイテムとその割引の小計（送料、送料割引は含まれない）。

taxLines ([TaxLine!]!)
ラインアイテムに請求された税金。

totalOutstandingSet (MoneyBag!)
ショップ通貨とプレセント通貨での、注文の合計金額からお客様から受け取った合計金額を差し引いたもの。

totalPriceSet (MoneyBag!)
ショップ通貨とプレセント通貨での注文の合計金額（税金と割引を含む）。

Implements

• Node

非推奨のフィールド

order (Order!) deprecated
変更が適用されたオーダーです。

非推奨の警告
代わりに originalOrder を使用してください。

CalculatedScriptDiscountApplication (object)

ディスカウントコードアプリケーションは、注文にディスカウントコードが適用された時点で、その意図を把握するものです。

必要なアクセス
read_order_edits のアクセススコープです。

このページについて

• フィールド
• インプリメント

フィールド

allocationMethod (DiscountApplicationAllocationMethod!)
割引の値を権利のあるアイテムに割り当てる方法です。

applyTo (DiscountApplicationLevel!)
割引が適用されたレベル。

description (String)
割引適用の説明です。割引が適用された理由を示す。

id (ID!)
グローバルに一意な識別子です。

targetSelection (DocountApplicationTargetSelection!)
割引されたラインに割引額をどのように配分するか。

targetType (DiscountApplicationTargetType!)
割引がラインアイテムと出荷ラインのどちらに適用されるかを指定します。

value (PricingValue!)
割引適用の値を指定します。

Implements

• CalculatedDiscountApplication

CapabilityParams (object)

支払い方法に関連するケイパビリティに関連するすべての情報。

必要なアクセス
read_payment_settingsのアクセススコープ。

このページについて

• フィールド
• CapabilityParams を返すタイプ

フィールド

available (Boolean!)
支払方法のステータス。

message (PaymentMethodConfigurationMessage)
支払い方法が無効または保留になっている場合の関連メッセージ。

CapabilityParams を返すタイプ

• PaymentMethodConfiguration.capabilityParams

CaptureSession オブジェクト (object)

キャプチャーセッションを表します。

必要なアクセス
read_payment_sessions のアクセススコープ。

このページについて

• フィールド
• CaptureSession に対するミューテーション

フィールド

id (ID!)
グローバルに一意な識別子です。

status (CaptureSessionStatus!)
キャプチャーの状態。

CaptureSession ミューテーション

captureSessionReject
開いているキャプチャセッションを拒否する。captureSessionRejectミューテーションが与えられたキャプチャーセッションで完了した後、すべてのcaptureSessionResolveミューテーションの試みは失敗します。それ以降のcaptureSessionRejectミューテーションの試みは成功しますが、RejectionReasonInput引数は無視されます。

captureSessionResolve
開いているキャプチャーセッションを解決します。指定されたキャプチャーセッションでcaptureSessionResolveミューテーションが完了した後、すべてのcaptureSessionRejectミューテーションの試みは失敗する。それ以降のcaptureSessionResolveミューテーションの試みは成功するが、Details引数は無視される。

CaptureSessionStatus (object)

キャプチャーステータスを表す。

必要なアクセス
read_payment_sessions のアクセススコープです。

このページについて

• フィールド
• CaptureSessionStatus を返すタイプ

フィールド

code (CaptureSessionStatusCode!)
キャプチャーのステータスコードです。

reason (CaptureSessionStatusReason)
キャプチャステータスの理由(該当する場合)

CaptureSessionStatus を返すタイプ

• CaptureSession.status

CaptureSessionStatusReason (object)

キャプチャーステータスの理由。

必要なアクセス
read_payment_sessions のアクセススコープです。

このページについて

• Filds
• CaptureSessionStatusReason を返すタイプ

フィールド

code (CaptureSessionStatusReasonRejectionCode!)
理由コードです。

merchantMessage (String)
マーチャントのためのカスタム、ローカライズされたメッセージ。

CaptureSessionStatusReason を返すタイプ

• CaptureSessionStatus.reason

Shopify アプリのご紹介

Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。

https://apps.shopify.com/shopify-application-314?locale=ja&from=daniel

Shopify アプリである、「らくらく日本語フォント設定｜リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。

https://apps.shopify.com/font-picker-1?locale=ja&from=daniel