📈

Admin API/GraphQL reference/Orders⑥

2021/10/01に公開・約78,300字

GraphQL

API

Shopify

tech

この記事について

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

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

Shopify アプリのご紹介

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

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

Orders（続き）

`orderCapture` (`mutations`)

注文上の許可されたトランザクションの支払いをキャプチャします。

このページについて

インタラクティブな例

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

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

mutation orderCapture($input: OrderCaptureInput!) {
  orderCapture(input: $input) {
    transaction {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "input": {
    "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
    "parentTransactionId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
    "amount": "placeholder"
  }
}

引数

引数	説明
`input` ( `OrderCaptureInput!` ) `required`	ミューテーションのための入力です。

OrderCaptureInput フィールド

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

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

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

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

フィールドを返す

transaction (OrderTransaction)こんにちは、
キャプチャするトランザクションです。

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

`orderClose` (`mutations`)

オープンオーダーをクローズします。

このページについて

インタラクティブな例

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

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

mutation orderClose($input: OrderCloseInput!) {
  orderClose(input: $input) {
    order {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "input": {
    "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
  }
}

引数

引数	説明
`input` ( `OrderCloseInput!` ) `required`	ミューテーションのための入力です。

OrderCloseInput フィールド

id (ID!) required
クローズするオーダーの ID。

Return フィールド

order (Order)
決済された注文です。

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

`orderEditAddCustomItem` (`mutations`)

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

このページについて

インタラクティブな例

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

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

mutation orderEditAddCustomItem($id: ID!, $title: String!, $price: MoneyInput!, $quantity: Int!) {
  orderEditAddCustomItem(id: $id, title: $title, price: $price, quantity: $quantity) {
    calculatedLineItem {
      id
    }
    calculatedOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "title": "placeholder",
  "price": {
    "amount": "placeholder",
    "currencyCode": "placeholder"
  },
  "quantity": 1
}

引数

引数	説明
`id` ( `ID!` ) `required`	アイテムを追加する計算済みの注文の ID です。
`locationId` ( `ID` )	このアイテムが実行されるロケーションの ID。指定されていない場合は、デフォルトが自動的に選択されます。
`price` ( `MoneyInput!` ) `required`	追加するカスタムアイテムの価格です。負の値は入力できません。
`quantity` ( `Int!` ) `required`	追加するカスタムアイテムの数量です。ゼロより大きい値でなければなりません。
`requiresShipping` ( `Boolean` )	アイテムが配送を必要とするかどうかを指定します。デフォルトは `false` です。
`taxable` ( `Boolean` )	アイテムが課税対象であるかどうかを指定します。デフォルトは `true` です。
`title` ( `String！` ) `required`	追加するカスタムアイテムの名前。

MoneyInput フィールド

amount (Decimal!) required
10 進数の金額です。

currencyCode (CurrencyCode!) required
お金の通貨。

Return フィールド

calculatedLineItem (ClculatedLineItem)
追加されたラインアイテム。

calculatedOrder (CalculatedOrder)
エディットが計算されたオーダー。

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

`orderEditAddLineItemDiscount` (`mutations`)

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

このページについて

インタラクティブな例

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

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

mutation orderEditAddLineItemDiscount(
  $id: ID!
  $lineItemId: ID!
  $discount: OrderEditAppliedDiscountInput!
) {
  orderEditAddLineItemDiscount(id: $id, lineItemId: $lineItemId, discount: $discount) {
    addedDiscountStagedChange {
      id
    }
    calculatedLineItem {
      id
    }
    calculatedOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "lineItemId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "discount": {}
}

引数

引数	説明
`discount` ( `OrderEditAppliedDiscountInput!` ) `required`	このラインアイテムに適用する割引
`id` ( `ID!` ) `required`	割引を適用する計算済み注文の ID。
`lineItemId` ( `ID!` ) `required`	この編集中に追加された、割引を適用するラインアイテムの ID です。

OrderEditAppliedDiscountInput フィールド

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

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

パーセント値 (Float)
パーセンテージとしての割引の値です。

Return フィールド

addDiscountStagedChange (OrderStagedChangeAddLineItemDiscount)
このミューテーションで生成されたステージドチェンジ。

calculatedLineItem (CalculatedLineItem)
割引が適用されたラインアイテム。

calculatedOrder (CalculatedOrder)
エディットが計算されたオーダー。

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

`orderEditAddVariant` (`mutations`)

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

このページについて

インタラクティブな例

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

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

mutation orderEditAddVariant($id: `ID!`, $variantId: `ID!`, $quantity: Int!) {
  orderEditAddVariant(id: $id, variantId: $variantId, quantity: $quantity) {
    calculatedLineItem {
      id
    }
    calculatedOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "variantId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "quantity": 1
}

引数

引数	説明
`allowDuplicates` ( `Boolean` )	この突然ミューテーションが、注文にすでに存在するバリアントを持つ行アイテムを作成できるかどうか。デフォルトは false です。
`id` ( `ID!` ) `required`	編集する計算オーダーの ID。
`locationId` ( `ID` )	このアイテムが配送される場所の ID です。指定されていない場合は、自動的にデフォルトが選択されます。
`quantity` ( [`Int!](https://shopify.dev/api/admin/graphql/reference/scalar#int-2021-07) )`required`	注文に追加するアイテムの量。正の値でなければなりません。
`variantId` ( `ID!` ) `required`	追加するバリアントの ID です。

Return フィールド

calculatedLineItem (CalculatedLineItem)
追加されたラインアイテム。

calculatedOrder (CalculatedOrder)
エディットを計算したオーダー。

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

`orderEditBegin` (`mutations`)

オーダーの編集を開始します。ミューテーションは OrderEdit で操作される。すべての注文編集は、orderEditBegin で始まり、任意の数の orderEdit*のミューテーションが行われ、orderEditCommit で終わります。

このページについて

インタラクティブな例

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

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

mutation orderEditBegin($id: ID!) {
  orderEditBegin(id: $id) {
    calculatedOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数	説明
`id` ( `ID!` ) `required`	編集を開始するオーダーの ID です。

Return フィールド

calculatedOrder (CalculatedOrder)
編集される注文です。

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

`orderEditCommit` (`mutations`)

段階的な変更を注文に適用し、保存します。ミューテーションは、orderEdit で操作されます。すべてのオーダーエディットは orderEditBegin で始まり、任意の数の orderEdit* mutation が作成され、orderEditCommit で終了します。

このページについて

インタラクティブな例

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

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

mutation orderEditCommit($id: ID!) {
  orderEditCommit(id: $id) {
    order {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数	説明
`id` ( `ID!` ) `required`	変更が適用される計算オーダーの ID。
`notifyCustomer` ( `Boolean` )	顧客に通知するかどうか。
`staffNote` ( `String` )	スタッフ用のメモ。

Return フィールド

order (Order)
変更を適用したオーダー。

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

`orderEditRemoveLineItemDiscount` (`mutations`)

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

このページについて

インタラクティブな例

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

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

mutation orderEditRemoveLineItemDiscount($id: ID!, $discountApplicationId: ID!) {
  orderEditRemoveLineItemDiscount(id: $id, discountApplicationId: $discountApplicationId) {
    calculatedLineItem {
      id
    }
    calculatedOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "discountApplicationId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数	説明
`discountApplicationId` ( `ID!` ) `required`	削除する割引の ID です。
`id` ( `ID!` ) `required`	割引を削除する計算された注文の ID。

Return フィールド

computedLineItem (ComputedLineItem)
割引が削除されたラインアイテム。

calculatedOrder (CalculatedOrder)
エディットが計算されたオーダー。

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

`orderEditSetQuantity` (`mutations`)

注文上のアイテムの数量を設定します。

このページ内

インタラクティブな例

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

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

mutation orderEditSetQuantity($id: ID!, $lineItemId: ID!, $quantity: Int!) {
  orderEditSetQuantity(id: $id, lineItemId: $lineItemId, quantity: $quantity) {
    calculatedLineItem {
      id
    }
    calculatedOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "lineItemId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "quantity": 1
}

引数

引数	説明
`id` ( `ID!` ) `required`	編集する計算オーダーの ID です。
`lineItemId` ( `ID!` ) `required`	編集するラインアイテムの ID。
`locationId` ( `ID` )	追加されたアイテムを満たすロケーションの ID、または'restock'が true に設定されている場合、再入荷したアイテムが利用可能になるロケーションの ID です。
`quantity` ( `Int!` ) `required`	ラインアイテムの新しい数量です。負の値は指定できません。
`restock` ( `Boolean` )	更新された数量が元の数量よりも少ない場合に、ラインアイテムを再入荷するかどうかを指定します。

Return フィールド

calculatedLineItem (CalculatedLineItem)
変更が計算されたラインアイテム。

calculatedOrder (CalculatedOrder)
編集内容が計算された注文。

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

`orderMarkAsPaid` (`mutations`)

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

このページについて

インタラクティブな例

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

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

mutation orderMarkAsPaid($input: OrderMarkAsPaidInput!) {
  orderMarkAsPaid(input: $input) {
    order {
      id
    }
    userErrors {
      field
      message
    }
  }
}

{
  "input": {
    "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
  }
}

引数

引数	説明
`input` ( `OrderMarkAsPaidInput!` ) `required`	ミューテーションのための入力です。

OrderMarkAsPaidInput フィールド

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

Return フィールド

order (Order)
支払い済みとしてマークされた注文。

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

`orderOpen` (`mutations`)

クローズドオーダーをオープンします。

このページについて

インタラクティブな例

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

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

mutation orderOpen($input: OrderOpenInput!) {
  orderOpen(input: $input) {
    order {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "input": {
    "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
  }
}

引数

引数	説明
`input` ( `OrderOpenInput!` ) `required`	ミューテーションのための入力です。

OrderOpenInput フィールド

id (ID!) required
開くオーダーの ID。

Return フィールド

order (Order)
開いた注文。

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

`orderSetFulfillmentDeadline` (`mutations`)

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

このページについて

インタラクティブな例

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

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

mutation orderSetFulfillmentDeadline($orderId: ID!, $fulfillmentDeadline: DateTime!) {
  orderSetFulfillmentDeadline(orderId: $orderId, fulfillmentDeadline: $fulfillmentDeadline) {
    success
    userErrors {
      code
      field
      message
    }
  }
}

変数

{
  "orderId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "fulfillmentDeadline": "placeholder"
}

引数

引数	説明
`fulfillmentDeadline` ( `DateTime!` ) `required`	注文の新しいフルフィルメント期限
`orderId` ( `ID!` ) `required`	期限が設定されている注文の ID。

戻り値のフィールド

success（Boolean)
フルフィルメント期限の設定が成功したかどうか。

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

`orderUpdate` (`mutations`)

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

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

このページについて

インタラクティブな例

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

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

mutation orderUpdate($input: OrderInput!) {
  orderUpdate(input: $input) {
    order {
      id
    }
    userErrors {
      field
      message
    }
  }
}

引数

引数	説明
`input` ( `OrderInput!` ) `required`	ミューテーションのための入力です。

OrderInput フィールド

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

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

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

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

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

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

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

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

Return フィールド

order (Order)
更新された注文です。

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

`paymentProviderCreate` (`mutations`)

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

このページについて

インタラクティブな例

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

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

mutation paymentProviderCreate($id: ID!, $configuration: PaymentProviderConfigurationInput!) {
  paymentProviderCreate(id: $id, configuration: $configuration) {
    newPaymentProvider {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "configuration": {}
}

引数

引数	説明
`churnReason` ( `PaymentProviderChurnReasonInput` )	解約理由を指定します。
`configuration` ( `PaymentProviderConfigurationInput!` ) `required`	ペイメントプロバイダコンフィギュレーションパラムを指定します。
`enableExpress` ( `Boolean` )	express を有効にするかどうかを指定します。デフォルト値：`false`
`id` ( `ID!` ) `required`	作成するペイメントプロバイダの ID。

PaymentProviderConfigurationInput フィールド

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

credentials ([PeationProviderCredentialInput!])
マーチャントが提供するペイメントプロバイダーの資格情報。

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

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

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

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

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

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

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

Return フィールド

newPaymentProvider (PaymentProvider)
作成されたペイメントプロバイダー。

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

`paymentProviderDisable` (`mutations`)

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

このページについて

インタラクティブな例

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

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

mutation paymentProviderDisable($id: ID!) {
  paymentProviderDisable(id: $id) {
    disabledPaymentProviderId
    userErrors {
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数	説明
`datails` ( `String` )	マーチャントがペイメントプロバイダーを無効にする理由の詳細。
`id` ( `ID!` ) `required`	無効化するペイメントプロバイダーの ID です。
`reason` ( `PaymentProviderDisableReason` )	マーチャントがペイメント・プロバイダーを無効にする理由。

Return フィールド

disabledPaymentProviderId (ID)
無効化されたペイメントプロバイダーのグローバル ID。

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

`paymentProviderEnable` (`mutations`)

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

このページについて

インタラクティブな例

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

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

mutation paymentProviderEnable($id: ID!) {
  paymentProviderEnable(id: $id) {
    paymentProvider {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数	説明
`id` ( `ID!` ) `required`	有効にする支払いプロバイダの ID。

Return フィールド

paymentProvider (PaymentProvider)
有効化されたペイメントプロバイダー。

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

`paymentProviderUpdate` (`mutations`)

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

このページについて

インタラクティブな例

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

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

mutation paymentProviderUpdate($id: ID!, $configuration: PaymentProviderConfigurationInput!) {
  paymentProviderUpdate(id: $id, configuration: $configuration) {
    updatedPaymentProvider {
      id
    }
    userErrors {
      field
      message
    }
  }
}

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "configuration": {}
}

引数

引数	説明
`configuration` ( `PaymentProviderConfigurationInput!` ) `required`	ペイメントプロバイダコンフィグレーションパラムです。
`id` ( `ID!` ) `required`	更新するペイメントプロバイダの ID です。
`options` ( `PaymentProviderOptionsInput` )	ペイメントプロバイダの更新オプションを指定します。

PaymentProviderConfigurationInput フィールド

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

credentials ([PaymentProviderCredentialInput!])
マーチャントが提供するペイメントプロバイダの資格情報。

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

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

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

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

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

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

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

Return フィールド

updatedPaymentProvider（PaymentProvider）
更新されたペイメントプロバイダー。

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

`paymentSessionReject` (`mutations`)

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

このページについて

インタラクティブな例

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

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

mutation paymentSessionReject($id: ID!, $reason: PaymentSessionRejectionReasonInput!) {
  paymentSessionReject(id: $id, reason: $reason) {
    paymentSession {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

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

引数

引数	説明
`id` ( `ID!` ) `required`	ペイメントセッションの ID です。
`reason` ( `PaymentSessionRejectionReasonInput!` ) `required`	拒否の理由。

PaymentSessionRejectionReasonInput フィールド

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

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

Return フィールド

paymentSession (PaymentSession)
更新された支払いセッション。

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

`paymentSessionResolve` (`mutations`)

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

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

このページについて

インタラクティブな例

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

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

mutation paymentSessionResolve($id: ID!) {
  paymentSessionResolve(id: $id) {
    paymentSession {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数	説明
`authorizationExpiresAt` ( `DateTime` )	認可された支払いセッションが期限切れになる日付と時間。
`id` ( `ID!` ) `required`	決済セッション ID。

Return フィールド

paymentSession (PaymentSession)
更新されたペイメントセッション。

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

`refundCreate` (`mutations`)

払い戻しを作成します。

このページについて

インタラクティブな例

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

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

mutation refundCreate($input: RefundInput!) {
  refundCreate(input: $input) {
    order {
      id
    }
    refund {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "input": {
    "orderId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
  }
}

引数

引数	説明
`input` ( `RefundInput!` ) `required`	ミューテーションの入力フィールドです。

RefundInput フィールド

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

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

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

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

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

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

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

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

Return フィールド

order (Order)
作成された返金に関連する注文です。

refund (Refund)
作成された払い戻しです。

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

`refundSessionReject` (`mutations`)

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

このページについて

インタラクティブな例

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

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

mutation refundSessionReject($id: ID!, $reason: RefundSessionRejectionReasonInput!) {
  refundSessionReject(id: $id, reason: $reason) {
    refundSession {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

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

引数

引数	説明
`id` ( `ID!` ) `required`	払い戻しセッション ID
`reason` ( `RefundSessionRejectionReasonInput!` ) `required`	拒否の理由

RefundSessionRejectionReasonInput フィールド

code (RefundSessionStatusReasonRejectionCode!) required
理由となるコード。

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

Return フィールド

refundSession (RefundSession)
更新された返金セッション。

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

`refundSessionResolve` (`mutations`)

未解決の返金セッションを解決します。指定された返金セッションで refundSessionResolve ミューテーションが完了した後、 refundSessionReject ミューテーションの試みは失敗します。後続の refundSessionResolve ミューテーションの試みは成功しますが、Details 引数は無視されます。

このページについて

インタラクティブな例

mutation refundSessionResolve($id: ID!) {
  refundSessionResolve(id: $id) {
    refundSession {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

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

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

引数

引数	説明
`id` ( `ID!` ) `required`	払い戻しのセッション ID です。

戻り値のフィールド

refundSession (RefundSession)
更新された払い戻しセッション。

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

`subscriptionBillingAttemptCreate` (`mutations`)

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

このページについて

インタラクティブな例

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

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

mutation subscriptionBillingAttemptCreate(
  $subscriptionContractId: ID!
  $subscriptionBillingAttemptInput: SubscriptionBillingAttemptInput!
) {
  subscriptionBillingAttemptCreate(
    subscriptionContractId: $subscriptionContractId
    subscriptionBillingAttemptInput: $subscriptionBillingAttemptInput
  ) {
    subscriptionBillingAttempt {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

{
  "subscriptionContractId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "subscriptionBillingAttemptInput": {
    "idempotencyKey": "placeholder"
  }
}

引数

引数	説明
`subscriptionBillingAttemptInput` ( `SubscriptionBillingAttemptInput!` ) `required`	課金の試みとして適用する情報。
`subscriptionContractId` ( `ID!` ) `required`	サブスクリプション契約の ID です。

SubscriptionBillingAttemptInput フィールド

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

Return フィールド

subscriptionBillingAttempt (SubscriptionBillingAttempt)
サブスクリプション課金の試み。

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

`subscriptionContractCreate` (`mutations`)

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

このページについて

インタラクティブな例

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

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

mutation subscriptionContractCreate($input: SubscriptionContractCreateInput!) {
  subscriptionContractCreate(input: $input) {
    draft {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

{
  "input": {
    "customerId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
    "nextBillingDate": "placeholder",
    "currencyCode": "placeholder",
    "contract": {}
  }
}

引数

引数	説明
`input` ( `SubscriptionContractCreateInput!` ) `required`	新しいサブスクリプション契約のプロパティです。

SubscriptionContractCreateInput フィールド

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

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

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

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

Return フィールド

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

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

`subscriptionContractSetNextBillingDate` (`mutations`)

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

このページについて

インタラクティブな例

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

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

mutation subscriptionContractSetNextBillingDate($contractId: ID!, $date: DateTime!) {
  subscriptionContractSetNextBillingDate(contractId: $contractId, date: $date) {
    contract {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

{
  "contractId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "date": "placeholder"
}

`引数` (`mutations`)

引数	説明
`contractId` ( `ID!` ) `required`	次の請求日を設定するサブスクリプション契約の gid。
`date` ( `DateTime!` ) `required`	次の請求書作成日

Return フィールド

contract (SubscriptionContract)
更新された Subscription Contract オブジェクト。

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

`subscriptionContractUpdate` (`mutations`)

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

このページについて

インタラクティブな例

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

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

mutation subscriptionContractUpdate($contractId: ID!) {
  subscriptionContractUpdate(contractId: $contractId) {
    draft {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

{
  "contractId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数	説明
`contractId` ( `ID!` ) `required`	更新するサブスクリプション契約の ID。

Return フィールド

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

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

`subscriptionDraftCommit` (`mutations`)

サブスクリプション契約ドラフトの更新をコミットします。

このページについて

インタラクティブな例

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

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

mutation subscriptionDraftCommit($draftId: ID!) {
  subscriptionDraftCommit(draftId: $draftId) {
    contract {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

{
  "draftId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数	説明
`draftId` ( `ID!` ) `required`	コミットする Subscription Contract ドラフトの gid。

Return フィールド

contract (SubscriptionContract)
更新された Subscription Contract オブジェクト。

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

`subscriptionDraftDiscountAdd` (`mutations`)

購読ドラフトに購読割引を追加します。

このページについて

インタラクティブな例

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

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

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

変数

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

`引数` (`mutations`)

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

SubscriptionManualDiscountInput フィールド

entitledLines (SubscriptionManualDiscountEntitledLinesInput)
サブスクリプションディスカウントを適用するために使用されるタイトル付きラインアイテムです。

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

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

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

Return フィールド

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

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

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

`subscriptionDraftDiscountCodeApply` (`mutations`)

サブスクリプションドラフトにコード割引を適用します。

このページについて

インタラクティブな例

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

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

mutation subscriptionDraftDiscountCodeApply($draftId: ID!, $redeemCode: String!) {
  subscriptionDraftDiscountCodeApply(draftId: $draftId, redeemCode: $redeemCode) {
    appliedDiscount {
      id
    }
    draft {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

{
  "draftId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "redeemCode": "placeholder"
}

引数

引数	説明
`draftId` ( `ID!` ) `required`	サブスクリプションコードによる割引を適用するサブスクリプション契約のドラフトの gid です。
`redeemCode` ( `String!` ) `required`	コード割引の利用コードを指定します。

Retur フィールド

appliedDiscount (SubscriptionAppliedCodeDiscount)
追加されたサブスクリプション割引。

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

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

`subscriptionDraftDiscountRemove` (`mutations`)

購読ドラフトから購読割引を削除します。

このページについて

インタラクティブな例

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

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

mutation subscriptionDraftDiscountRemove($draftId: ID!, $discountId: ID!) {
  subscriptionDraftDiscountRemove(draftId: $draftId, discountId: $discountId) {
    discountRemoved
    draft {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

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

引数

引数	説明
`discountId` ( `ID!` ) `required`	削除するサブスクリプション・ドラフト・ディスカウントの gid です。
`draftId` ( `ID!` ) `required`	割引を解除する契約書ドラフトの ID。

Return フィールド

discountRemoved (SubscriptionDiscount)
削除されたサブスクリプションドラフトの割引。

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

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

`subscriptionDraftDiscountUpdate` (`mutations`)

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

このページについて

インタラクティブな例

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

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

mutation subscriptionDraftDiscountUpdate(
  $draftId: ID!
  $discountId: ID!
  $input: SubscriptionManualDiscountInput!
) {
  subscriptionDraftDiscountUpdate(draftId: $draftId, discountId: $discountId, input: $input) {
    discountUpdated {
      id
    }
    draft {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

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

引数

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

SubscriptionManualDiscountInput フィールド

entitledLines (SubscriptionManualDiscountEntitledLinesInput)
サブスクリプションディスカウントを適用するために使用されるタイトル付きラインアイテムです。

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

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

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

Return フィールド

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

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

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

Shopify アプリのご紹介

Discussion

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

この記事について

Shopify アプリのご紹介

Orders（続き）

orderCapture (mutations)

このページについて

インタラクティブな例

引数

OrderCaptureInput フィールド

フィールドを返す

orderClose (mutations)

このページについて

インタラクティブな例

引数

OrderCloseInput フィールド

Return フィールド

orderEditAddCustomItem (mutations)

このページについて

インタラクティブな例

引数

MoneyInput フィールド

Return フィールド

orderEditAddLineItemDiscount (mutations)

このページについて

インタラクティブな例

引数

OrderEditAppliedDiscountInput フィールド

Return フィールド

orderEditAddVariant (mutations)

このページについて

インタラクティブな例

引数

Return フィールド

orderEditBegin (mutations)

このページについて

インタラクティブな例

引数

Return フィールド

orderEditCommit (mutations)

このページについて

インタラクティブな例

引数

Return フィールド

orderEditRemoveLineItemDiscount (mutations)

このページについて

インタラクティブな例

引数

Return フィールド

orderEditSetQuantity (mutations)

このページ内

インタラクティブな例

引数

Return フィールド

orderMarkAsPaid (mutations)

このページについて

インタラクティブな例

引数

OrderMarkAsPaidInput フィールド

Return フィールド

orderOpen (mutations)

このページについて

インタラクティブな例

引数

OrderOpenInput フィールド

Return フィールド

orderSetFulfillmentDeadline (mutations)

このページについて

インタラクティブな例

引数

戻り値のフィールド

orderUpdate (mutations)

このページについて

インタラクティブな例

引数

OrderInput フィールド

Return フィールド

paymentProviderCreate (mutations)

このページについて

インタラクティブな例

引数

PaymentProviderConfigurationInput フィールド

`orderCapture` (`mutations`)

`orderClose` (`mutations`)

`orderEditAddCustomItem` (`mutations`)

`orderEditAddLineItemDiscount` (`mutations`)

`orderEditAddVariant` (`mutations`)

`orderEditBegin` (`mutations`)

`orderEditCommit` (`mutations`)

`orderEditRemoveLineItemDiscount` (`mutations`)

`orderEditSetQuantity` (`mutations`)

`orderMarkAsPaid` (`mutations`)

`orderOpen` (`mutations`)

`orderSetFulfillmentDeadline` (`mutations`)

`orderUpdate` (`mutations`)

`paymentProviderCreate` (`mutations`)

`paymentProviderDisable` (`mutations`)

`paymentProviderEnable` (`mutations`)

`paymentProviderUpdate` (`mutations`)

`paymentSessionReject` (`mutations`)

`paymentSessionResolve` (`mutations`)

`refundCreate` (`mutations`)

`refundSessionReject` (`mutations`)

`refundSessionResolve` (`mutations`)

`subscriptionBillingAttemptCreate` (`mutations`)

`subscriptionContractCreate` (`mutations`)

`subscriptionContractSetNextBillingDate` (`mutations`)

`引数` (`mutations`)

`subscriptionContractUpdate` (`mutations`)

`subscriptionDraftCommit` (`mutations`)