📈

Admin API/GraphQL reference/Orders⑦

2021/10/01に公開

GraphQL

API

Shopify

tech

この記事について

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

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

Shopify アプリのご紹介

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

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

Orders（続き）

`subscriptionDraftFreeShippingDiscountAdd` (`mutations`)

サブスクリプションドラフトにサブスクリプションフリーシッピングディスカウントを追加します。

このページについて

インタラクティブな例

これは、ミューテーションクエリの例です。このクエリを編集するには、以下の埋め込みインタラクティブツールを使用します。

ヒント：フィールドの自動補完にはCtrl + Spaceを使用します。

mutation subscriptionDraftFreeShippingDiscountAdd(
  $draftId: ID!
  $input: SubscriptionFreeShippingDiscountInput!
) {
  subscriptionDraftFreeShippingDiscountAdd(draftId: $draftId, input: $input) {
    discountAdded {
      id
    }
    draft {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

{
  "draftId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "input": {}
}

引数

引数	説明
`draftId` ( `ID!` ) `required`	サブスクリプションフリーシッピングディスカウントを追加するサブスクリプション契約ドラフトの ID です。
`input` ( `SubscriptionFreeShippingDiscountInput!` ) `required`	新しいサブスクリプション送料無料割引のプロパティです。

SubscriptionFreeShippingDiscountInput フィールド

recurringCycleLimit (Int)
定期購入の送料無料割引が注文に適用される最大回数です。

title (String)
定期購入型送料無料サービスに関連するタイトル。

Return フィールド

discountAdded (SubscriptionManualDiscount)
追加されたサブスクリプションの送料無料割引です。

draft (SubscriptionDraft)
サブスクリプション契約ドラフトオブジェクトです。

userErrors ([SubscriptionDraftUserError!]!)
ミューテーションを実行して発生したエラーのリストです。

`subscriptionDraftFreeShippingDiscountUpdate` (`mutations`)

定期購入ドラフトの送料無料割引を更新します。

このページについて

インタラクティブな例

これは、ミューテーションクエリの例です。このクエリを編集するには、以下の埋め込みインタラクティブツールを使用します。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用します。

mutation subscriptionDraftFreeShippingDiscountUpdate(
  $draftId: ID!
  $discountId: ID!
  $input: SubscriptionFreeShippingDiscountInput!
) {
  subscriptionDraftFreeShippingDiscountUpdate(
    draftId: $draftId
    discountId: $discountId
    input: $input
  ) {
    discountUpdated {
      id
    }
    draft {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

{
  "draftId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "discountId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "input": {}
}

引数

引数	説明
`discountId` ( `ID!` ) `required`	更新するサブスクリプション・ディスカウントの gid です。
`draftId` ( `ID!` ) `required`	サブスクリプションディスカウントを更新するサブスクリプション契約ドラフトの ID。
`input` ( `SuptibleFersippingDiscountInput!` ) `required`	サブスクリプション送料無料割引で更新するプロパティです。

SubscriptionFreeShippingDiscountInput フィールド

recurringCycleLimit (Int)
定期購入の送料無料割引が注文に適用される最大回数です。

title (String)
定期購入型送料無料サービスに関連するタイトルです。

Return のフィールド

discountUpdated (SubscriptionManualDiscount)
更新されたサブスクリプション割引。

draft (SubscriptionDraft)
サブスクリプション契約ドラフトオブジェクトです。

userErrors ([SubscriptionDraftUserError!]!)
ミューテーションを実行して発生したエラーのリストです。

`subscriptionDraftLineAdd` (`mutations`)

サブスクリプションドラフトにサブスクリプションラインを追加します。

このページについて

インタラクティブな例

これは、ミューテーションクエリの例です。このクエリを編集するには、以下の埋め込みインタラクティブツールを使用します。

ヒント: フィールドを自動補完するには「Ctrl + Space」を使用します。

mutation subscriptionDraftLineAdd($draftId: ID!, $input: SubscriptionLineInput!) {
  subscriptionDraftLineAdd(draftId: $draftId, input: $input) {
    draft {
      id
    }
    lineAdded {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

{
  "draftId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "input": {
    "productVariantId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
    "quantity": 1,
    "currentPrice": "placeholder"
  }
}

引数

引数	説明
`draftId` ( `ID!` ) `required`	サブスクリプションラインを追加するサブスクリプション契約ドラフトの gid。
`input` ( `SubscriptionLineInput!` ) `required`	新しいサブスクリプションラインのプロパティ。

SubscriptionLineInput フィールド

currentPrice ( Decimal! ) required
製品の価格です。

customAttributes ([AttributeInput!])
このサブスクリプションラインのカスタム属性です。

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

productVariantId (ID!) required
サブスクリプションラインが参照する製品バリアントの ID です。

quantity (Int!) required
製品の数量を表します。

sellingPlanId (ID)
サブスクリプションラインの販売プランです。

sellingPlanName (String)
サブスクリプションラインの販売プラン名。

指定されていない場合は、販売計画の現在の名前を使用するというデフォルトになります。

Return フィールド

draft (SubscriptionDraft)
サブスクリプション契約ドラフトオブジェクト。

lineAdded (SubscriptionLine)
追加されたサブスクリプションラインです。

userErrors ([SubscriptionDraftUserError!]!)
ミューテーションを実行して発生したエラーのリストです。

`subscriptionDraftLineRemove` (`mutations`)

サブスクリプションドラフトからサブスクリプションラインを削除します。

このページについて

インタラクティブな例

これは、ミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使用します。

ヒント: フィールドの自動補完には「Ctrl + Space」を使います。

mutation subscriptionDraftLineRemove($draftId: ID!, $lineId: ID!) {
  subscriptionDraftLineRemove(draftId: $draftId, lineId: $lineId) {
    discountsUpdated {
      id
    }
    draft {
      id
    }
    lineRemoved {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

{
  "draftId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "lineId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数	説明
`draftId` ( `ID!` ) `required`	購読行を削除するための購読契約ドラフトの gid。
`lineId` ( `ID!` ) `required`	削除するサブスクリプションラインの gid。

Return フィールド

discountsUpdated ([SubscriptionManualDiscount!])
削除されたラインによって影響を受ける、更新されたサブスクリプション割引のリストです。

draft (SubscriptionDraft)
サブスクリプション契約ドラフトオブジェクトです。

lineRemoved (SubscriptionLine)
削除されたサブスクリプションラインです。

userErrors ([SubscriptionDraftUserError!]!)
ミューテーションを実行して発生したエラーのリストです。

`subscriptionDraftLineUpdate` (`mutations`)

購読ドラフトの購読行を更新します。

このページについて

インタラクティブな例

これは、ミューテーションクエリの例です。このクエリを編集するには、以下の埋め込みインタラクティブツールを使用します。

ヒント：フィールドの自動補完にはCtrl + Spaceを使用します。

mutation subscriptionDraftLineUpdate(
  $draftId: ID!
  $lineId: ID!
  $input: SubscriptionLineUpdateInput!
) {
  subscriptionDraftLineUpdate(draftId: $draftId, lineId: $lineId, input: $input) {
    draft {
      id
    }
    lineUpdated {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

{
  "draftId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "lineId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "input": {}
}

引数

引数	説明
`draftId` ( `ID!` ) `required`	購読行を更新するための、購読契約ドラフトの ID。
`input` ( `SubscriptionLineUpdateInput!` ) `required`	新しいサブスクリプションラインのプロパティです
`lineId` ( `ID!` ) `required`	更新するサブスクリプションラインの gid です。

SubscriptionLineUpdateInput フィールド

currentPrice (Decimal)
製品の価格です。

customAttributes ([AttributeInput!])
このサブスクリプションラインのカスタム属性です。

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

productVariantId (ID)
このサブスクリプションラインが参照する製品バリアントの ID です。

quantity (Int)
製品の数量です。

sellingPlanId (ID)
サブスクリプションラインの販売プラン。

sellingPlanName (String)
サブスクリプションラインの販売プラン名。

Return フィールド

draft (SubscriptionDraft)
サブスクリプション契約ドラフトオブジェクト。

lineUpdated (SubscriptionLine)
更新されたサブスクリプションライン。

userErrors ([SubscriptionDraftUserError!]!)
ミューテーションを実行して発生したエラーのリストです。

`subscriptionDraftUpdate` (`mutations`)

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

このページについて

インタラクティブな例

これは、ミューテーションクエリの例です。このクエリを編集するには、以下の埋め込みインタラクティブツールを使用します。

ヒント: フィールドを自動補完するには、Ctrl + Space を使用します。

mutation subscriptionDraftUpdate($draftId: ID!, $input: SubscriptionDraftInput!) {
  subscriptionDraftUpdate(draftId: $draftId, input: $input) {
    draft {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

{
  "draftId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "input": {}
}

引数

引数	説明
`draftId` ( `ID!` ) `required`	更新するサブスクリプションドラフトの gid。
`input` ( `SubscriptionDraftInput!` ) `required`	新しいサブスクリプション契約のプロパティです。

SubscriptionDraftInput フィールド

billingPolicy (SubscriptionBillingPolicyInput)
サブスクリプション契約の課金ポリシーを指定します。

deliveryMethod (SubscriptionDeliveryMethodInput)
サブスクリプション契約の配信方法です。

deliveryPolicy (SubscriptionDeliveryPolicyInput)
サブスクリプション契約の配信ポリシーを指定します。

deliveryPrice (Decimal)
サブスクリプション契約の各更新の配送価格です。

nextBillingDate (DateTime)
サブスクリプション契約の次回請求日です。

paymentMethodId (ID)
サブスクリプション契約に使用される支払方法の ID。

status (SubscriptionContractSubscriptionStatus)
サブスクリプション契約の現在のステータスを表します。

Return フィールド

draft (SubscriptionDraft)
Subscription Draft オブジェクト。

userErrors ([SubscriptionDraftUserError!]!)
ミューテーションを実行して発生したエラーのリストです。

`voidSessionReject` (`mutations`)

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

このページについて

インタラクティブな例

これは、ミューテーションクエリの例です。このクエリを編集するには、以下の埋め込みインタラクティブツールを使用します。

ヒント: フィールドを自動補完するには「Ctrl + Space」を使用します。

mutation voidSessionReject($id: ID!, $reason: VoidSessionRejectionReasonInput!) {
  voidSessionReject(id: $id, reason: $reason) {
    userErrors {
      code
      field
      message
    }
    voidSession {
      id
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "reason": {
    "code": "placeholder"
  }
}

引数

引数	説明
`id` ( `ID!` ) `required`	ボイドセッション ID です。
`reason` ( `VoidSessionRejectionReasonInput!` ) `required`	拒否理由を指定します。

VoidSessionRejectionReasonInput フィールド

code (VoidSessionStatusReasonRejectionCode!) required
拒絶理由のコードです。

merchantMessage(String)
マーチャント用にローカライズされたカスタムメッセージです。

Return フィールド

userErrors ([VoidSessionRejectUserError!]!)
ミューテーションを実行した際に発生したエラーのリストです。

voidSession (VoidSession)
更新された void セッションです。

`voidSessionResolve` (`mutations`)

オープンなボイドセッションを解決します。voidSessionResolve mutation が与えられた void セッションで完了した後、voidSessionReject mutation の試みは失敗します。後続のvoidSessionResolveミューテーションの試みは成功しますが、Details引数は無視されます。

このページについて

インタラクティブな例

これは、ミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使用します。

ヒント：フィールドを自動補完するにはCtrl + Spaceを使います。

mutation voidSessionResolve($id: ID!) {
  voidSessionResolve(id: $id) {
    userErrors {
      code
      field
      message
    }
    voidSession {
      id
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数	説明
`id` ( `ID!` ) `required`	ボイドのセッション ID です。

Return フィールド

userErrors ([VoidSessionResolveUserError!]!)
ミューテーションを実行して発生したエラーのリストです。

voidSession (VoidSession)
更新されたボイドセッションです。

INPUTS

`AttributeInput` (`input`)

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

Input フィールド

key (String!) required
属性のキーまたは名前です。

value (String!) required
属性の値を指定します。

`CaptureSessionRejectionReasonInput` (`input`)

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

Input フィールド

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

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

CustomPaymentMethodInput`(` inputobject `)` (`input`)

カスタムペイメントプロバイダの作成または更新に必要な情報を指定します。

Input フィールド

instructions (String!) required
注文状況ページで提供される詳細です。

message (String!) required
購入者に提供するメッセージ。

`DraftOrderAppliedDiscountInput` (`input`)

注文レベルの割引をドラフトオーダーに適用するための入力フィールドです。

Input フィールド

amount (Money)
割引の適用金額です。

description (String)
値引きの理由

title (String)
割引のタイトル

value (Float!) required
割引の値です。割引のタイプが固定額の場合、これは固定のドル金額です。タイプがパーセンテージであれば、これはパーセンテージです。

valueType (DraftOrderAppliedDiscountType!) required
割引のタイプです。

`DraftOrderDeleteInput` (`input`)

削除するドラフトオーダーを、その ID で指定します。

入力フィールド

id (ID!) required
削除するドラフトオーダーの ID です。

`DraftOrderInput` (`input`)

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

入力フィールド

appliedDiscount (DraftOrderAppliedDiscountInput)
ドラフトオーダーに適用される割引です。1 つのドラフトオーダーのラインアイテムは、1 つの割引を持つことができます。また、ドラフトオーダーは 1 つのオーダーレベルの割引を持つことができます。

billingAddress (MailingAddressInput)
支払い方法に関連付けられた郵送先住所です。

customAttributes ([AttributeInput!])
顧客に追加される追加情報。

customerId (ID)
下書き注文に関連付けられた顧客。

email (String)
顧客の電子メールアドレス。

lineItems ([DraftOrderLineItemInput!])
注文の草稿に関連付けられた製品バリアントのラインアイテムまたはカスタムラインアイテム。各ドラフトオーダーは少なくとも 1 つのラインアイテムを含まなければならない。

localizationExtensions ([LocalizationExtensionInput!])
ドラフトオーダーに関連付けられたローカリゼーションエクステンション。例えば、Tax ID などです。

metafields ([MetafieldInput!])
注文書ドラフトに添付されるメタフィールド。

note (String)
ショップオーナーが発注書ドラフトに添付できるオプションのメモのテキスト。

privateMetafields ([PrivateMetafieldInput!])
注文の草稿に添付されるプライベートメタフィールド。

shippingAddress (MailingAddressInput)
注文品を発送する際の郵送先住所です。

shippingLine (ShippingLineInput)
使用する配送方法の詳細を示す配送ラインオブジェクトです。

tags ([String!])
注文の草稿に追加されたタグのコンマ区切りリストです。

taxExempt (Boolean)
注文の草稿に対して、税金が免除されているかどうか。false の場合、Shopify は各ラインアイテムの課税対象フィールドを参照します。もし注文の草稿に顧客が適用されている場合、Shopify は顧客の非課税フィールドを代わりに使用します。

useCustomerDefaultAddress (Boolean)
顧客の配送情報をロードするために、ドラフトオーダーオブジェクトの一部として送信される。

`DraftOrderLineItemInput` (`input`)

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

入力フィールド

appliedDiscount (DraftOrderAppliedDiscountInput)
行項目に適用される割引額を入力します。

customAttributes ([AttributeInput!])
キーと値のペアを使用して一般的なカスタム属性を表現する。

grams (Int)
バリアント ID が指定されている場合は無視されます。この引数は推奨されません。代わりに重量を使用してください。

originalUnitPrice (Money)
バリアント ID が指定されている場合は無視されます。

quantity (Int!) required
購入された商品の数です。

requiresShipping (Boolean)
バリアント ID が指定されている場合は無視されます。

sku (String)
バリアント ID が提供されている場合は無視されます。

taxable (Boolean)
バリアント ID が指定されている場合は無視されます。

title (String)
variant ID が提供されている場合は無視されます。

variantId (ID)
ラインアイテムに対応する製品バリアントの ID。カスタムラインアイテムの場合は Null。製品バリアントのラインアイテムの場合は必須。

weight (WeightInput)
重量単位と値の入力を指定します。バリアント ID が指定されている場合は無視されます。

`EmailInput` (`input`)

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

入力フィールド

bcc ([String!])
電子メールの bcc 受信者を指定します。

body (String)
電子メールの本文を指定します。

customMessage (String)
電子メールに含めるカスタムメッセージを指定します。

from (String)
電子メールの送信者を指定します。

subject (String)
電子メールの件名を指定します。

to (String)
電子メールの受信者を指

`OrderCaptureInput` (`input`)

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

入力フィールド

amount (Money!) required
キャプチャする金額です。

currency (CurrencyCode)
注文を取り込む際に使用する通貨（ISO 形式）。これは予約通貨（お客様が使用する通貨）でなければならず、通貨と予約通貨が異なる注文では必須フィールドです。

id (ID!) required
キャプチャする注文の ID です。

parentTransactionId (ID!) required
キャプチャする認証済みトランザクションの ID です。

`OrderCloseInput` (`input`)

閉じるオープンオーダーを指定します。

入力フィールド

id (ID!) required
閉じる注文の ID です。

`OrderEditAppliedDiscountInput` (`input`)

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

入力フィールド

description (String)
割引の説明です。

fixedValue (MoneyInput)
固定額としての割引の値です。

purcentValue (Float)
割引額をパーセントで表した値です。

`OrderInput` (`input`)

要求された注文について更新される情報を指定します。

入力フィールド

customAttributes ([AttributeInput!])
注文に追加するカスタム情報で、キーと値のペアとして表されます。ノート属性とも呼ばれる。

email (String)
注文に関連付けられた電子メールアドレス。

id (ID!) required
更新する注文の ID です。

localizationExtensions ([LocalizationExtensionInput!])
注文に添付されたlocalization extensionsで、キーと値のペアで表されます。例えば、タックス ID などです。

metafields ([MetafieldInput!])
この注文に関連付けるメタフィールド。

note (String)
注文のメモです。

shippingAddress (MailingAddressInput)
この注文に関連付けられた配送先住所です。

tags ([String!])
注文に追加されたタグのコンマ区切りリストです。

`OrderMarkAsPaidInput` (`input`)

支払い済みとしてマークするオーダーを指定します。

入力フィールド

id (ID!) required
支払い済みとしてマークする注文の ID です。

`OrderOpenInput` (`input`)

開くクローズドオーダーを指定します。

入力フィールド

id (ID!) required
開く注文の ID です。

`OrderTransactionInput` (`input`)

注文トランザクションの作成に必要な情報を指定します。

入力フィールド

amount (Money!) required
このトランザクションの金額を指定します。

gateway (String!) required
このトランザクションに使用する支払いゲートウェイ。

kind (OrderTransactionKind!) required
トランザクションの種類です。

orderId (ID!) required
トランザクションに関連付けられた注文の ID です。

parentId (ID)
任意の親トランザクションの ID。例えば、キャプチャの承認など。

`PaymentMethodConfigurationInput` (`input`)

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

入力フィールド

enabled (Boolean)
決済方法が有効であるかどうか。

name (String!) required
決済方法の識別子。

paymentExperienceConfigurationId (UnsignedInt64)
支払い体験構成の ID です。

`PaymentProviderChurnReasonInput` (`input`)

ペイメントプロバイダーの更新の理由と詳細を表します。

入力フィールド

details (String)
マーチャントがペイメントプロバイダーを無効にする理由の詳細です。

reason (PaymentProviderDisableReason)
マーチャントがペイメントプロバイダーを無効にする理由です。

`PaymentProviderConfigurationInput` (`input`)

更新可能なペイメントプロバイダーコンフィグレーションパラメターです。

入力フィールド

attachment (String)
プロバイダの添付ファイルです。

credentials ([PaymentProviderCredentialInput!])
マーチャントが提供するペイメントプロバイダーのクレデンシャル。

enabledCurrencies ([CurrencyCode!])
有効化されたプレセンテーション通貨。

extraSettings ([AttributeInput!])
チェックボックスやラジオボタンのようなプロバイダの追加設定。

instructions (String)
手動プロバイダの指示。

message (String)
支払いページでユーザーに表示する追加の詳細です。

paymentMethods ([PaymentMethodConfigurationInput!])
支払い方法の更新されたリストです。

testModeEnabled (Boolean)
マーチャントがテストモードを有効にしているかどうか。

threeDSecureSetting (ThreeDSecureSetting)
プロバイダの 3DS 設定です。

`PaymentProviderCredentialInput` (`input`)

ペイメントプロバイダーのクレデンシャルを設定するために使用されるフィールドです。

入力フィールド

index (Int!) required
クレデンシャルのインデックス。

value (String!) required
クレデンシャルの値。機密性の高いクレデンシャルは null が返されることに注意してください。

`PaymentProviderFraudSettingsInput` (`input` `object`)

支払いアカウントの不正設定

入力フィールド

DicronChageOnAvsFailure (Boolean)
AVS の失敗があった場合、充電を拒否する。

declineChargeOnCvcFailure (Boolean)
CVC の失敗があった場合、課金を拒否する。

`PaymentProviderNotificationSettingsInput` (`input`)

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

入力フィールド

payouts (Boolean!) required
新しいペイアウトが送信されたとき、またはペイアウトが失敗したときにメール通知を受け取ります。

`PaymentProviderOptionsInput` (`input`)

アップデート時の支払いプロバイダのオプションです。

入力フィールド

churnReason (PaymentProviderChurnReasonInput)
マーチャントがペイメントプロバイダーを無効にする理由と詳細です。

enabledPaymentConfigurations ([Int!])
有効化された決済設定。

fraudSettings (PaymentProviderFraudSettingsInput)
Shopify Payments アカウントの不正設定です。

notificationSettings (PeationsProviderNotificationSettingsInput)
このアカウントの通知設定です。

`PaymentSessionRejectionReasonInput` (`input`)

支払いステータスの理由

入力フィールド

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

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

`RefundDutyInput` (`input`)

払い戻しの際に関税を戻すのに必要なフィールドを指定します。

入力フィールド

dutyId (ID!) required
払い戻しの義務の ID です。

refundType (RefundDutyRefundType)
この義務の払い戻しのタイプです。

`RefundInput` (`input`)

リファンドを作成するフィールドを指定します。

入力フィールド

currency (CurrencyCode)
注文の返金に使用される通貨（ISO 形式）。これは予約通貨（顧客が使用する通貨）でなければならず、通貨と予約通貨が異なる注文では必須フィールドです。

note (String)
返金に添付するオプションのメモです。

notify (Boolean)
お客様に返金通知を送信するかどうか。

orderId (ID!) required
返金を作成する対象の注文 ID。

refundDuties ([RefundDutyInput!])
払い戻しを行う職務のリストです。

refundLineItems ([RefundLineItemInput!])
払い戻しを行うラインアイテムのリストです。

shipping (ShippingRefundInput)
返金する配送料の金額を指定します。

transactions ([OrderTransactionInput!])
返金に関わるトランザクションのリストです。

`RefundLineItemInput` (`input`)

リファンドのラインアイテムを返すために必要なフィールドを指定します。

入力フィールド

lineItemId (ID!) required
払い戻しのラインアイテムの ID です。

locationId (ID)
refundType が NO_RESTOCK ではない場合、再入荷のための意図された場所。

quantity (Int!) required
返金された関連ライン・アイテムの数量です。

restockType (RefundLineItemRestockType)
このラインアイテムの再ストックのタイプです。

`RefundSessionRejectionReasonInput` (`input`)

払い戻しステータスの理由

入力フィールド

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

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

`ShippingLineInput` (`input`)

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

入力フィールド

price (Money)
配送料の価格です。

shippingRateHandle (String)
配送料金の一意の識別子。

title (String)
配送料金のタイトル。

`ShippingRefundInput` (`input`)

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

入力フィールド

amount (Money)
返すべき送料の金銭的価値です。

fullRefund (Boolean)
全額返金されるかどうか。

`ShopifyPaymentsAccountInput` (`input`)

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

入力フィールド

billingDetails (ShopifyPaymentsBillingDetailsInput)
Shopify Payments アカウントの請求明細です。

payoutSchedule (ShopifyPaymentsPayoutScheduleInput)
アカウントのペイアウトスケジュール。

`ShopifyPaymentsBillingDetailsInput` (`input`)

Shopify payments アカウントの請求書の詳細です。

入力フィールド

chargeStatementDescriptor (String!) required
請求に使用されるデフォルトの明細書記述子（日本を除くすべての国）。これは購入者が購入する際にクレジットカードや銀行の明細書に表示されるものです。

kanaChargeStatementDescriptor (String) required
料金に使用されるカナ表記の記述子（日本のみ）。これは、購入者が購入する際にクレジットカードや銀行の明細書に表示されるものです。

kanjiChargeStatementDescriptor (String)
料金に使用される漢字表記の記述子（日本国内のみ）。これは、購入者が購入する際にクレジットカードや銀行の明細書に表示されるものです。

payoutStatementDescriptor (String!) required
ペイアウトに使用される記述子です。これは、マーチャントがペイアウトを受け取る際に銀行の明細書に表示されるものです。

phoneNumber (String!) required
法人の電話番号です。

`ShopifyPaymentsPayoutScheduleInput` (`input`)

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

入力フィールド

interval (PayoutSchedulePayoutInterval!) required
接続された銀行口座にペイアウトが送信される間隔です。

monthlyAnchor (Int)
資金が払い出される月の曜日です。

値は 1 日から 31 日までの任意の日を指定できます。支払い間隔が毎月に設定されている場合は、この値が使用されます。月の 29 日から 31 日に予定されている支払いは、短い月の最終日に送信されます。

weeklyAnchor (DayOfTheWeek)
資金が支払われる曜日を指定します。

月曜から金曜までの任意の曜日を指定します。支払い間隔が weekly に設定されている場合は、この値が使用されます。

`SubscriptionBillingAttemptInput` (`input` `object`)

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

入力フィールド

idempotencyKey (String!) required
支払いの重複を避けるためにクライアントが生成する一意のキーです。詳細については、Idempotent requests を参照してください。

`SubscriptionBillingPolicyInput` (`input` `object`)

入力フィールド

anchors ([SellingPlanAnchorInput!])
請求間隔の計算が行われるべき特定のアンカーの日付。

interval ([SellingPlanInterval!]) required
このスケジュールに関連する間隔の種類（例：月単位、週単位など）。

intervalCount (Int!) required
請求書の発行間隔の数です。

maxCycles (Int)
サブスクリプションに必要なサイクルの最大量。

minCycles (Int)
サブスクリプションに必要なサイクルの最小量。

`SubscriptionContractCreateInput` (`input`)

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

入力フィールド

contract (SubscriptionDraftInput!) required
サブスクリプションドラフトの入力として使用される属性です。

currencyCode (CurrencyCode!) required
サブスクリプション契約に使用する通貨です。

customerId (ID!) required
サブスクリプション契約に関連付ける顧客の ID。

nextBillingDate (DateTime!) required
サブスクリプション契約の次回請求日。

`SubscriptionDeliveryMethodInput` (`input`)

購読ドラフトの配信方法フィールドを指定します。これは入力組合であり、提供できるフィールドは 1 つだけです。提供されたフィールドによって、どの配信方法を使用するかが決まります。

注：現時点では shipping のみがサポートされていますが、その他の入力項目が定期購入でサポートされるようになれば追加される予定です。

入力フィールド

shipping (SubscriptionDeliveryMethodShippingInput)
配送方法の入力です。

`SubscriptionDeliveryMethodShippingInput` (`input`)

配送方法のフィールドを指定します。

この入力は、部分的な入力を受け付けます。フィールドが提供されていない場合、その前の値は変更されません。

入力フィールド

address (MailingAddressInput)
配送先の住所を指定します。

shippingOption (SubscriptionDeliveryMethodShippingOptionInput)
使用する配送方法の詳細です。

`SubscriptionDeliveryMethodShippingOptionInput` (`input`)

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

入力フィールド

carrierServiceId (ID)
配送オプションのキャリアサービス ID です。

code (String)
配送オプションのコード。

description (String)
配送オプションの説明です。

presentmentTitle (String)
配送オプションの予約タイトル。

title (String)
配送オプションのタイトルです。

`SubscriptionDeliveryPolicyInput` (`input`)

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

入力フィールド

anchhors ([SellingPlanAnchorInput!])
配信間隔の計算の基準となる特定のアンカー日を指定します。

interval (SellingPlanInterval!) required
このスケジュールに関連付けられている間隔の種類（例：月単位、週単位など）。

intervalCount (Int!) required
請求書間の請求間隔の数。

`SubscriptionDraftInput` (`input`)

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

入力フィールド

billingPolicy (SubscriptionBillingPolicyInput)
サブスクリプション契約の課金ポリシーです。

deliveryMethod (SubscriptionDeliveryMethodInput)
サブスクリプション契約の配信方法を指定します。

deliveryPolicy (SubscriptionDeliveryPolicyInput)
サブスクリプション契約の配信ポリシーを指定します。

deliveryPrice (Decimal)
サブスクリプション契約の各更新の配送価格です。

nextBillingDate (DateTime)
サブスクリプション契約の次回請求日です。

paymentMethodId (ID)
サブスクリプション契約に使用される支払方法の ID。

status (SubscriptionContractSubscriptionStatus)
サブスクリプション契約の現在のステータス。

`SubscriptionFreeShippingDiscountInput` (`input`)

契約書に記載されている定期購入の送料無料割引の入力フィールドを指定します。

入力フィールド

recurringCycleLimit (Int)
定期購入の送料無料割引が注文に適用される最大回数です。

title (String)
定期購入割引に関連するタイトル。

`SubscriptionLineInput` (`input` `object`)

契約に新しいサブスクリプションラインを追加するために必要な入力フィールドを指定します。

入力フィールド

currentPrice (Decimal!) required
製品の価格です。

customAttributes ([AttributeInput!])
このサブスクリプションラインのカスタム属性です。

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

productVariantId (ID!) required
サブスクリプションラインが参照する製品バリアントの ID です。

quantity (Int!) required
製品の数量を表します。

sellingPlanId (ID)
サブスクリプションラインの販売プランです。

sellingPlanName (String)
サブスクリプションラインの販売プラン名。

指定されていない場合は、販売計画の現在の名前を使用するのがデフォルトです。

`SubscriptionLineUpdateInput` (`input`)

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

入力フィールド

currentPrice (Decimal)
製品の価格です。

customAttributes ([AttributeInput!])
このサブスクリプションラインのカスタム属性を指定します。

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

productVariantId (ID)
このサブスクリプションラインが参照する製品バリアントの ID です。

quantity (Int)
製品の数量です。

sellingPlanId (ID)
サブスクリプションラインの販売プラン。

sellingPlanName (String)
サブスクリプションラインの販売プラン名。

`SubscriptionManualDiscountEntitledLinesInput` (`input`)

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

入力フィールド

all (Boolean)
サブスクリプション割引をすべてのサブスクリプションラインに適用するかどうかを指定します。

lines (SubscriptionManualDiscountLinesInput)
サブスクリプション割引に追加する、またはサブスクリプション割引から削除するラインの ID。

`SubscriptionManualDiscountFixedAmountInput` (`input`)

回線の割引と分配の固定額の値を指定します。

入力フィールド

amount (Float)
固定額の値です。

appliesOnEachItem (Boolean)
金額をラインアイテムごとに意図するか、サブスクリプションごとに 1 回適用するかを指定します。

`SubscriptionManualDiscountInput` (`input`)

契約上のサブスクリプション割引の入力フィールドを指定します。

入力フィールド

entitledLines (SubscriptionManualDiscountEntitledLinesInput)
契約上のサブスクリプション割引を適用するために使用されるタイトル付き行項目。

recurringCycleLimit (Int)
注文にサブスクリプション割引を適用する最大回数。

title (String)
定期購入割引に関連するタイトル。

value (SubscriptionManualDiscountValueInput)
割引のパーセンテージまたは固定額の値

`SubscriptionManualDiscountLinesInput` (`input`)

割引が適用されるラインアイテム。

入力フィールド

add ([ID!])
サブスクリプション割引に追加するラインの ID。

remove ([ID!])
割引対象から除外する行の ID。

`SubscriptionManualDiscountValueInput` (`input`)

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

入力フィールド

fixedAmount (SubscriptionManualDiscountFixedAmountInput)
サブスクリプションで定義された通貨での固定額入力です。

percentage (Int)
割引のパーセンテージ値です。値は 0 ～ 100 の間でなければなりません。

`SubscriptionPricingPolicyCycleDiscountsInput` (`input`)

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

入力フィールド

adjustmentType (SellingPlanPricingPolicyAdjustmentType!) required
価格調整のタイプです。

adjustmentValue (SellingPlanPricingPolicyValueInput!) required
価格調整値です。

afterCycle (Int!) required
価格設定ポリシーが適用される後のサイクル。

computedPrice (Decimal!) required
調整が適用された後の計算された価格。

`SubscriptionPricingPolicyInput` (`input`)

サブスクリプションラインの時間経過に伴う予想される価格変動について説明します。

入力フィールド

basePrice (Decimal!) required
サブスクリプションラインの 1 ユニットあたりの基本価格（契約の通貨）。

cycleDiscounts ([SubscriptionPricingPolicyCycleDiscountsInput!]) required
各請求サイクルのすべての価格変更を含む配列です。

`VoidSessionRejectionReasonInput` (`input`)

ボイドステータスの理由

入力フィールド

code (VoidSessionStatusReasonRejectionCode!) required
理由コードを指定します。

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

ENUMS

`CaptureSessionStatusCode` (`enum`)

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

Values

REJECTED
キャプチャーが拒否されました。

RESOLVED
キャプチャーが解決されたことを示します。

CaptureSessionStatusCode を返すタイプ

CaptureSessionStatus.code

`CaptureSessionStatusReasonRejectionCode` (`enum`)

キャプチャー拒否の理由コード。

Values

AUTHORIZATION_EXPIRED
認証の有効期限が切れました。

PROCESSING_ERROR
キャプチャー処理の失敗

CaptureSessionStatusReasonRejectionCode を返すタイプ

CaptureSessionStatusReason.code

`DiscountApplicationAllocationMethod` (`enum`)

割引の値が権利のある行に割り当てられる方法です。

Values

ACROSS
値はすべての権利付きラインに分散されます。

EACH
値はすべての権利付きラインに適用されます。

ONE deprecated
値が特定のラインに適用されます。

DiscountApplicationAllocationMethod を返すタイプ

`DiscountApplicationLevel` (`enum`)

割引の値が権利のある行に割り当てられる方法です。

Value

LINE
割引がラインレベルで適用された。ラインレベルの割引は、ラインアイテムの DiscountedUnitPriceSet に反映されます。

ORDER
割引はオーダーレベルで適用されました。注文レベルの割引は、行アイテムの discountedUnitPriceSet には反映されません。

DiscountApplicationLevel を返すタイプ

`DiscountApplicationTargetSelection` (`enum`)

v.2021-07 最新
割引アプリケーションの target_type で定義されたタイプの、割引が適用されるオーダー上のどの行を対象とするかを示します。

Values

ALL
すべての行に割引が適用されます。

ENTITLED
割引は権利のあるラインのみに適用されます。

EXPLICIT
明示的に選択されたラインに割引が適用されます。

DiscountApplicationTargetSelection を返すタイプ

`DiscountApplicationTargetType` (`enum`)

v.2021-07 最新
割引が適用される注文上のラインのタイプ（例：ラインアイテムまたは配送ライン）。

Values

LINE_ITEM
割引はラインアイテムに適用されます。

SHIPPING_LINE
割引は配送ラインに適用されます。

DiscountApplicationTargetType を返すタイプ

`DiscountTargetType` (`enum`)

契約割引が適用される回線のタイプ。

Values

LINE_ITEM
ラインアイテム。

SHIPPING_LINE
配送ライン。

DiscountTargetType を返すタイプ

SubscriptionManualDiscount.TargetType

`DiscountType` (`enum`)

割引のオリジナルタイプ。

Values

CODE_DISCOUNT
コードの割引タイプ。

MANUAL
マニュアル割引タイプ。

DiscountType を返すタイプ

SubscriptionManualDiscount.Type

`DraftOrderAppliedDiscountType` (`enum`)

ドラフトオーダーに適用可能な有効な割引タイプです。

Values

FIXED_AMOUNT
ストアの通貨での固定額です。

PERCENTAGE
注文の小計に対するパーセンテージ。

DraftOrderAppliedDiscountType を返すタイプ

DraftOrderAppliedDiscount.valueType

`DraftOrderSortKeys` (`enum`)

DraftOrder クエリの有効なソートキーのセット。

Value

CUSTOMER_NAME
customer_name の値でソートします。

ID
ID の値でソートします。

NUMBER
number の値でソートします。

RELEVANCE
検索時（接続時にquery・パラメータが指定されている場合）に、検索語との関連性で結果をソートします。検索クエリが指定されていない場合、このソートキーは決定論的ではないため、使用しないでください。

STATUS
statusの値でソートします。

TOTAL_PRICE
total_priceの値でソートします。

UPDATED_AT
updated_atの値でソートします。

`DraftOrderStatus` (`enum`)

ドラフトオーダーの有効なステータスです。

Value

COMPLETED
ドラフトオーダーの支払いが完了しました。

INVOICE_SENT
注文の草稿に対する請求書が顧客に送信されました。

OPEN
注文の草稿は未完成です。支払われておらず、請求書も送信されていません。

DraftOrderStatus を返すタイプ

DraftOrder.status

`OrderActionType` (`enum`)

販売契約で可能な注文アクションタイプ。

Values

ORDER
購入または請求。

ORDER_EDIT
注文の編集

REFUND
注文の払い戻し

UNKNOWN
不明な契約行為。将来のバージョンで追加される可能性のある新しいアクションを表します。

OrderActionType を返すタイプ

`OrderAdjustmentKind` (`enum`)

注文調整の異なる種類。

Values

REFUND_DISCREPANCY
計算された返金額と実際の返金額の不一致を表す注文調整。

SHIPPING_REFUND
顧客に返金される配送料を表す注文調整。

OrderAdjustmentKind を返すタイプ

OrderAdjustment.kind

`OrderCancelReason` (`enum`)

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

Velue

CUSTOMER
お客様が注文のキャンセルを希望されました。

DECLINED
支払いが拒否されました。

FRAUN
注文が不正に行われました。

INVENTORY
在庫が不足していました。

OTHER
記載されていないその他の理由。

OrderCancelReason を返すタイプ

order.cancelReason

`OrderDisplayFinancialStatus` (`enum`)

オーダーの現在の財務状況を表します。

VALUE

AUTHORIZED
Authorized として表示されます。

EXPIRED
Expired（期限切れ）と表示されます。

PAID
支払い済みとして表示されます。

PARIALLY_PAID
一部支払い済みとして表示されます。

PARTIALLY_REFUNDED
部分的に返金されたと表示される。

PENDING
保留中と表示される。

REFUNDED
返金済みと表示されます。

VOIDED
無効になったと表示されます。

OrderDisplayFinancialStatus を返すタイプ

Order.displayFinancialStatus

`OrderDisplayFulfillmentStatus` (`enum`)

オーダーの現在のフルフィルメントステータスを表します。

Values

FULFILLED
フルフィルドとして表示されます。

IN_PROGRESS
進行中と表示される。

ON_HOLD
保留中と表示されます。

OPEN
開いていると表示されます。

PARTYALLY_FULFILLED
部分的に満たされていると表示される。

PENDING_FULFILLMENT
保留中と表示される。

RESTOCKED
再入荷したと表示される。

RESTOCKED
予約済みと表示されています。

UNFULFILLED
Unfulfilled として表示されます。

OrderDisplayFulfillmentStatus を返すタイプ

Order.displayFulfillmentStatus

`OrderRiskLevel` (`enum`)

注文が詐欺的である可能性。

Values

HIGH
この注文が不正である可能性が高いです。

LOW
この注文が不正であるリスクは低いレベルです。

MEDIUM
この注文が不正であるリスクは中程度です。

OrderRiskLevel を返すタイプ

`OrderSortKeys` (`enum`)

Order クエリの有効なソートキーのセット。

Values

CREATED_AT
created_atの値でソートします。

CUSTOMER_NAME
customer_nameの値でソートします。

FINANCIAL_STATUS
funancial_statusの値でソートします。

FULFILLMENT_STATUS
fulfillment_status の値でソートします。

ID
ID値でソートします。

ORDER_NUMBER
ORDER_NUMBER の値でソートします。

PROCESSED_AT
processed_atの値でソートします。

RELEVANCE
検索時（接続時にquery・パラメータが指定されている場合）に、検索語との関連性で結果をソートします。検索クエリが指定されていない場合、このソートキーは確定的ではないため、使用しないでください。

TOTAL_PRICE
total_priceの値でソートします。

UPDATED_AT
updated_atの値でソートします。

`OrderTransactionKind` (`enum`)

注文トランザクションの異なる種類を表します。

Values

AUTHORIZATION
カード所有者の資金源に対して予約された金額。オーソリがキャプチャされるまでお金は動きません。

CAPTURE
オーソリゼーションの段階で予約されたお金の移動。

CHANGE
支払いが多すぎた場合に顧客に戻されるお金。

EMV_AUTHORIZATION
EMV クレジットカードリーダーで行われた支払いの承認。

REFUND
取り込んだ資金の一部または全部をカード所有者に戻すこと。払い戻しは、キャプチャが処理された後にのみ行われる。

SALE
オーソリゼーションとキャプチャを 1 つのステップで実行すること。

SUGGESTED_REFUND
払い戻しを行う際に使用される、提案された払い戻しトランザクション。

VOID
保留中のオーソリゼーションやキャプチャーをキャンセルします。

OrderTransactionKind を返すタイプ

OrderTransaction.kind

`OrderTransactionStatus` (`enum`)

Transaction status' は、トランザクションのステータスを記述します。

Values

AWAITING_RESPONSE
応答を待っています。

ERROR
トランザクションの処理中にエラーが発生しました。

FAILURE
トランザクションが失敗しました。

PENDING
トランザクションは保留中です。

SUCCESS
トランザクションは成功しました。

UNKNOWN
トランザクションのステータスは不明です。

OrderTransactionStatus を返すタイプ

OrderTransaction.status

`PaymentMethodConfigurationMessage` (`enum`)

支払い方法の無効化の理由

Value

PENDING_ONBOARDING
無効になった理由は、pending.onboarding です。

PENDING_REVIEW
無効になった理由は、pending.review です。

REJECTED_FRUD
無効になった理由は: rejected.fraud です。

REJECTED_OTHER
無効になった理由は：rejected.other です。

REJECTED_OTHER
無効になった理由は、requirements.fields_needed です。

PaymentMethodConfigurationMessage を返すタイプ

CapabilityParams.message

`PaymentMethods` (`enum`)

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

Values

AMERICAN_EXPRESS
BITCOIN
BOGUS
DANKORT
DINERS_CLUB
DISCOVER
DOGECOIN
FORBRUGSFORENINGEN
JCB
LITECOIN
MAESTRO
MASTERCARD
PAYPAL
VISA

`PaymentProcessingMethod` (`enum`)

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

Values

AUTO
注文に対して自動的に支払いを捕捉します。

MANUAL
手動で注文のための支払いをキャプチャします。

PaymentProcessingMethod を返すタイプ

PaymentAuthorizationSettings.processingMethod

`PaymentProviderDisableReason` (`enum`)

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

Values

FRAUD_TOOLS_DON_T_SUPPORT_BUSINESS_NEEDS
詐欺ツールはビジネスニーズをサポートしません。

INTEGRATION_WITH_THIRD_PARTY_SYSTEMS_IS_NOT_POSSIBLE
サードパーティのシステムとの統合は不可能です。

IN_PERSON_SELLING_IS_NOT_SUPPORTED
対面販売はサポートされていません。

OTHER
その他です。

PAYOUT_TIMES_ARE_TOO_SLOW
ペイアウトタイムが遅すぎる。

PREFERRED_CURRENCY_IS_NOT_AVAILABLE
ご希望の通貨が利用できません。

PRODUCT_IS_PROHIBITED
製品の使用が禁止されています。

RATES_ARE_TOO_EXPENSIVE
料金が高すぎます。

`PaymentSessionNextActionAction` (`enum`)

パートナーの支払いアクション。

Values

REDIRECT
顧客を次のチェックアウトステップにリダイレクトします。

PaymentSessionNextActionAction を返すタイプ

PaymentSessionNextAction.action

`PaymentSessionStatusCode` (`enum`)

支払いステータスコード。

Values

REJECTED
支払いが拒否されました。

RESOLVED
支払いが解決されたことを示します。

PaymentSessionStatusCode を返すタイプ

PaymentSessionStatus.code

`PaymentSessionStatusReasonRejectionCode` (`enum`)

支払い拒否の理由コード。

Values

PROCESSING_ERROR
支払い処理の失敗。

RISKY
リスクコントロールによって拒否されました。

PaymentSessionStatusReasonRejectionCode を返すタイプ

PaymentSessionStatusReason.code

`PayoutSchedulePayoutInterval` (`enum`)

接続されている銀行口座にペイアウトが送信される間隔です。

Values

DAILY
各営業日。

MONTHLY
毎月、monthlyAnchor で指定された月の曜日に送信。

WEEKLY
毎週、weeklyAnchor で指定された曜日に表示されます。

`PaypalExpressActivationStatus` (`enum`)

PayPal Express のアクティベーションステータス。

Values

ACTIVATION_REQUIRED_POST_ORDER
注文後に PayPal Express が自動プロビジョニングされました。

ACTIVATION_REQUIRED_POST_ORDER
注文の前に PayPal Express が自動プロビジョニングされました。

DISABLED
PayPal Express が無効になっています。

ENABLED
PayPal Express の統合は完全に有効で機能しています。

PaypalExpressActivationStatus を返すタイプ

PaymentProviderConfiguration.paypalExpressActivationStatus

`ProviderGroup` (`enum`)

支払いに使用される、オルタナティブやその他のプロバイダーグループ。

Values

ALTERNATIVE
AMAZON_PAYMENTS
GIFT_CARD
GOOGLE
MANUAL
OTHER
PAYPAL
POS_ONLY
WALLET

ProviderGroup を返すタイプ

PaymentProvider.group

`RefundDutyRefundType` (`enum`)

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

Values

FULL
義務は完全に返金されます。

PROPORTIONAL
返金されたラインアイテムの数量に基づいて、義務が比例的に返金されます。

`RefundLineItemRestockType` (`enum`)

特定の返金ラインアイテムに対して行われた再入荷のタイプ。

Values

CANCEL
リファンドラインアイテムがキャンセルされました。

LEGACY_RESTOCK
返金ラインアイテムは再入荷されましたが、特に返品またはキャンセルとして識別されていません。

NO_RESTOCK
返金ラインアイテムは再入荷されませんでした。

RETURN
返金ラインアイテムは返品された。

返却するタイプ RefundLineItemRestockType

RefundLineItem.restockType

`RefundSessionStatusCode` (`enum`)

払い戻しのステータスコード。

Values

REJECTED
返金が拒否されました。

RESOLVED
返金が解決された。

RefundSessionStatusCode を返すタイプ

RefundSessionStatus.Code

`RefundSessionStatusReasonRejectionCode` (`enum`)

払い戻しの拒絶理由コード。

Values

PROCESSING_ERROR
返金処理の失敗。

RefundSessionStatusReasonRejectionCode を返すタイプ

RefundSessionStatusReason.code

`ResourceAlertIcon` (`enum`)

リソースアラートに利用可能なアイコン。

Values

CHECKMARK_CIRCLE
円の中のチェックマーク

INFORMATION_CIRCLE
円の中に小文字の i を入れたもの

ResourceAlertIcon を返すタイプ

ResourceAlert.icon

`ResourceAlertSeverity` (`enum`)

リソースアラートで可能な重大度のレベル。

Values

CRITICAL
重大な警告を示します。

DEFAULT
中立的な警告を示します。

INFO
情報的な警告を示す。

SUCCESS
成功を示す警告を示す。

WARNING
警告を示す。

ERROR deprecated

ResourceAlertSeverity を返すタイプ

ResourceAlert.severity

`SaleActionType` (`enum`)

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

Values

ORDER
購入またはチャージ。

RETURN
削除または返品。

UNKNOWN
不明なオーダーアクション。将来のバージョンで追加される可能性のある新しいアクションを表す。

UPDATE
以前に購入した商品の価格、税金、または割引の変更。

SaleActionType を返すタイプ

`SaleLineType` (`enum`)

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

Values

ADJUSTMENT
セールの調整。

DUTY
デューティチャージ。

GIFT_CARD
ギフトカード。

PRODUCT
購入、返品または交換された製品。

SHIPPING
配送料です。

TIP
お客様が追加したチップ。

UNKNOWN
不明な販売品目。将来のバージョンで追加される可能性のある新しいタイプを表します。

SaleLineType を返すタイプ

`SubscriptionContractLastPaymentStatus` (`enum`)

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

Values

FAILED
サブスクリプション課金の試みが失敗しました。

SUCCEEDED
サブスクリプション課金の試みが成功しました。

SubscriptionContractLastPaymentStatus を返すタイプ

SubscriptionContract.lastPaymentStatus

`SubscriptionContractSubscriptionStatus` (`enum`)

サブスクリプションの可能なステータス値。

Values

ACTIVE
アクティブなサブスクリプション契約。

CANCELLED
サブスクリプション契約がキャンセルされました。

EXPIRED
契約期間が終了したサブスクリプション。

FAILED
サブスクリプション契約に失敗しました。

PAUSED
一時停止中のサブスクリプション契約。

SubscriptionContractSubscriptionStatus を返すタイプ

`SubscriptionDiscountRejectionReason` (`enum`)

サブスクリプションドラフトの割引が拒否された理由。

Values

CURRENTLY_INACTIVE
割引は非アクティブです。

CUSTOMER_NOT_ELIGIBLE
顧客は割引を受ける資格がありません。

CUSTOMER_USAGE_LIMIT_REACHED
お客様のご利用限度額に達しました。

CUSTOMER_USAGE_LIMIT_REACHED
購入タイプが割引の対象になっていません。

INTERNAL_ERROR
割引コードの検証中に内部エラーが発生しました。

NOT_FOUND
割引コードが見つかりません。

NO_ENTITLED_LINE_ITEMS
指定されたラインアイテムには割引が適用されません。

NO_ENTITLED_SHIPPING_LINES
適用可能な配送ラインがありません。

NO_ENTITLED_LINE_ITEMS
商品の購入金額が割引の対象にならない

NO_ENTITLED_LINE_ITEMS
商品の数量が割引対象外であること。

USAGE_LIMIT_REACHED
割引利用の上限に達しています。

SubscriptionDiscountRejectionReason を返すタイプ

`SuggestedOrderTransactionKind` (`enum`)

提案された注文トランザクションの種類を指定します。

Values

SUGGESTED_REFUND
提案された注文の返金トランザクション。

SuggestedOrderTransactionKind を返すタイプ

SuggestedOrderTransaction.kind

`ThreeDSecureSetting` (`enum`)

ゲートウェイの 3D セキュア設定値。

Values

DISABLED
3D セキュアはオフ。

ENABLED
3D セキュアがオンです。

ThreeDSecureSetting を返すタイプ

PaymentProviderConfiguration.threeDSecureSetting

`TransactionSupportedRefundType` (`enum`)

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

Values

CARD_NOT_PRESENT_REFUND
物理的なカードのない払い戻し。

CARD_PRESENT_REFUND
カード提示データ（物理的なカードとリーダー）を必要とする返金。

TransactionSupportedRefundType を返すタイプ

SuggestedOrderTransaction.supportedRefundType

`VoidSessionStatusCode` (`enum`)

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

Values

REJECTED
ボイドが拒否されました。

RESOLVED
無効の解決

VoidSessionStatusCode を返すタイプ

VoidSessionStatus.Code

`VoidSessionStatusReasonRejectionCode` (`enum`)

ボイドの棄却理由コードです。

Values

PROCESSING_ERROR
Void の処理の失敗。

VoidSessionStatusReasonRejectionCode を返すタイプ

VoidSessionStatusReason.code

Shopify アプリのご紹介

Discussion

ログインするとコメントできます

この記事について

Shopify アプリのご紹介

Orders（続き）

subscriptionDraftFreeShippingDiscountAdd (mutations)

このページについて

インタラクティブな例

引数

SubscriptionFreeShippingDiscountInput フィールド

Return フィールド

subscriptionDraftFreeShippingDiscountUpdate (mutations)

このページについて

インタラクティブな例

引数

SubscriptionFreeShippingDiscountInput フィールド

Return のフィールド

subscriptionDraftLineAdd (mutations)

このページについて

インタラクティブな例

引数

SubscriptionLineInput フィールド

Return フィールド

subscriptionDraftLineRemove (mutations)

このページについて

インタラクティブな例

引数

Return フィールド

subscriptionDraftLineUpdate (mutations)

このページについて

インタラクティブな例

引数

SubscriptionLineUpdateInput フィールド

Return フィールド

subscriptionDraftUpdate (mutations)

このページについて

インタラクティブな例

引数

SubscriptionDraftInput フィールド

Return フィールド

voidSessionReject (mutations)

このページについて

インタラクティブな例

引数

VoidSessionRejectionReasonInput フィールド

Return フィールド

voidSessionResolve (mutations)

このページについて

インタラクティブな例

引数

Return フィールド

INPUTS

AttributeInput (input)

Input フィールド

CaptureSessionRejectionReasonInput (input)

Input フィールド

CustomPaymentMethodInput`(` inputobject ) (input)

Input フィールド

DraftOrderAppliedDiscountInput (input)

Input フィールド

DraftOrderDeleteInput (input)

入力フィールド

DraftOrderInput (input)

入力フィールド

DraftOrderLineItemInput (input)

入力フィールド

EmailInput (input)

入力フィールド

OrderCaptureInput (input)

入力フィールド

OrderCloseInput (input)

入力フィールド

OrderEditAppliedDiscountInput (input)

入力フィールド

OrderInput (input)

入力フィールド

OrderMarkAsPaidInput (input)

入力フィールド

OrderOpenInput (input)

入力フィールド

OrderTransactionInput (input)

入力フィールド

`subscriptionDraftFreeShippingDiscountAdd` (`mutations`)

`subscriptionDraftFreeShippingDiscountUpdate` (`mutations`)

`subscriptionDraftLineAdd` (`mutations`)

`subscriptionDraftLineRemove` (`mutations`)

`subscriptionDraftLineUpdate` (`mutations`)

`subscriptionDraftUpdate` (`mutations`)

`voidSessionReject` (`mutations`)

`voidSessionResolve` (`mutations`)

`AttributeInput` (`input`)

`CaptureSessionRejectionReasonInput` (`input`)

CustomPaymentMethodInput`(` inputobject `)` (`input`)

`DraftOrderAppliedDiscountInput` (`input`)

`DraftOrderDeleteInput` (`input`)

`DraftOrderInput` (`input`)

`DraftOrderLineItemInput` (`input`)

`EmailInput` (`input`)

`OrderCaptureInput` (`input`)

`OrderCloseInput` (`input`)

`OrderEditAppliedDiscountInput` (`input`)

`OrderInput` (`input`)

`OrderMarkAsPaidInput` (`input`)

`OrderOpenInput` (`input`)

`OrderTransactionInput` (`input`)

`PaymentMethodConfigurationInput` (`input`)

`PaymentProviderChurnReasonInput` (`input`)

`PaymentProviderConfigurationInput` (`input`)

`PaymentProviderCredentialInput` (`input`)

`PaymentProviderFraudSettingsInput` (`input` `object`)

`PaymentProviderNotificationSettingsInput` (`input`)

`PaymentProviderOptionsInput` (`input`)

`PaymentSessionRejectionReasonInput` (`input`)

`RefundDutyInput` (`input`)

`RefundInput` (`input`)

`RefundLineItemInput` (`input`)

`RefundSessionRejectionReasonInput` (`input`)

`ShippingLineInput` (`input`)

`ShippingRefundInput` (`input`)

`ShopifyPaymentsAccountInput` (`input`)

`ShopifyPaymentsBillingDetailsInput` (`input`)

`ShopifyPaymentsPayoutScheduleInput` (`input`)

`SubscriptionBillingAttemptInput` (`input` `object`)

`SubscriptionBillingPolicyInput` (`input` `object`)

`SubscriptionContractCreateInput` (`input`)

`SubscriptionDeliveryMethodInput` (`input`)

`SubscriptionDeliveryMethodShippingInput` (`input`)

`SubscriptionDeliveryMethodShippingOptionInput` (`input`)

`SubscriptionDeliveryPolicyInput` (`input`)

`SubscriptionDraftInput` (`input`)

`SubscriptionFreeShippingDiscountInput` (`input`)

`SubscriptionLineInput` (`input` `object`)

`SubscriptionLineUpdateInput` (`input`)

`SubscriptionManualDiscountEntitledLinesInput` (`input`)

`SubscriptionManualDiscountFixedAmountInput` (`input`)

`SubscriptionManualDiscountInput` (`input`)

`SubscriptionManualDiscountLinesInput` (`input`)

`SubscriptionManualDiscountValueInput` (`input`)

`SubscriptionPricingPolicyCycleDiscountsInput` (`input`)

`SubscriptionPricingPolicyInput` (`input`)