📈

Admin API/GraphQL reference/Orders⑤

2021/10/01に公開約76,400字

この記事について

この記事は、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

Orders(続き)

SubscriptionDraft (object)

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

このページについて

コネクション

discounts (SubscriptionDiscountConnection!)
サブスクリプション契約に関連づけられるサブスクリプション割引のリスト。

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

discountsAdded (SubscriptionDiscountConnection!)
サブスクリプション契約に追加されるサブスクリプション割引のリストです。

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

discountsRemoved (SubscriptionDiscountConnection!)
サブスクリプション契約から削除されるサブスクリプション割引のリスト。

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

discountsUpdated (SubscriptionDiscountConnection!)
サブスクリプション契約で更新されるサブスクリプション割引のリストです。

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

lines (SubscriptionLineConnection!)
サブスクリプション契約に関連づけられるサブスクリプションラインのリストです。

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

linesAdded (SubscriptionLineConnection!)
加入契約に追加される加入回線のリストです。

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

linesRemoved (SubscriptionLineConnection!)
加入契約から削除される加入回線のリスト。

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

フィールド

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

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

customer (Customer!)
サブスクリプション契約が属する顧客を表します。

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

引数 説明
showRevoked ( Boolean ) 顧客の取り消された支払方法を表示するかどうか。
デフォルト値:false

deliveryMethod (SubscriptionDeliveryMethod)
サブスクリプション契約の各ビリングに対する配信方法です。

deliveryPolicy (SubscriptionDeliveryPolicy!)
サブスクリプション契約の配信ポリシーです。

deliveryPrice (MoneyV2)
サブスクリプション契約の各請求に対する配信価格です。

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

nextBillingDate (DateTime)
サブスクリプション契約の次の請求書発行日。

originalContract (SubscriptionContract)
元のサブスクリプション契約。

shippingOptions (SubscriptionShippingOptionResult)
指定された配送先で利用可能な配送オプション。保留中の要求に対しては NULL を返します。

引数 説明
deliveryAddress ( MailingAddressInput ) サブスクリプション契約を配送する住所。

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

SubscriptionDraft を返すタイプ

SubscriptionDraft に対するミューテーション

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

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

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

subscriptionDraftDiscountRemove
受信料割引を受信料ドラフトから削除します。

subscriptionDraftDiscountUpdate
定期購入ドラフトの割引額を更新します。

subscriptionDraftFreeShippingDiscountAdd
定期購読ドラフトの送料割引を追加します。

subscriptionDraftFreeShippingDiscountUpdate
契約書草稿の送料割引を更新します。

subscriptionDraftLineAdd
定期購入用ドラフトに定期購入ラインを追加します。

subscriptionDraftLineRemove
定期購入用ドラフトから定期購入行を削除します。

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

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

インプリメント

SubscriptionLine (object)

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

このページについて

フィールド

currentPrice (MoneyV2!)
契約通貨でのサブスクリプションラインの 1 ユニットあたりの価格。

customAttributes ([Attribute!]!)
ラインアイテムに関連付けられたカスタム属性のリスト。

discountAllocations ([SubscriptionDiscountAllocation!])!)
割引の割り当て。

id (ID!)
固有の識別子。

lineDiscountedPrice (MoneyV2!)
すべての割引を含む合計ライン価格。

pricingPolicy (SubscriptionPricingPolicy)
時系列でのラインの価格変更を記述します。

productId (ID)
サブスクリプションラインに関連する製品 ID。

quantity (Int!)
サブスクリプションラインに選択されたユニットの数量。

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

sellingPlanId (ID)
ラインに関連付けられた販売計画の ID。

この契約ラインを最初に作成する際にどの販売プランが使用されたかを示します。この販売プラン ID は、関連する配送プロファイルを見つけるためにも使用されます。

加入契約、加入ライン、または販売プランが変更されている可能性があります。その結果、販売プランの属性が契約上の情報と一致しない場合があります。

sellingPlanName (String)
ラインに関連する販売プラン名。この名前は、マーチャントとカスタマーの両方に対して、この契約ラインから作成される注文ラインアイテムを説明します。

この値は、販売計画の名前とは異なる可能性があります。なぜなら、販売計画の名前と予約回線の selling_plan_name 属性は、両方とも独立して更新できるからです。

sku (String)
サブスクリプションラインに関連するアイテムのバリアント SKU 番号。

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

title (String!)
サブスクリプションラインに関連するアイテムの製品タイトル。

variantId (ID)
サブスクリプションラインに関連付けられた製品バリアントの ID。

variantImage (Image)
予約品目のバリアントまたは製品に関連するイメージです。

variantTitle (String)
サブスクリプションラインに関連するアイテムの製品バリアントタイトル。

SubscriptionLine を返すタイプ

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

このページについて

フィールド

edges ([SubscriptionLineEdge!]!)
エッジのリスト。

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

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

このページについて

フィールド

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

node (SubscriptionLine!)
SubscriptionLineEdge の末尾の項目。

SubscriptionLineEdge を返すタイプ

SubscriptionMailingAddress (object)

サブスクリプションの Mailing Address を表します。

このページについて

フィールド

address1 (String)
アドレスの 1 行目。一般的には、住所または私書箱番号。

address2 (String)
住所の 2 行目。典型的には、アパート、スイート、またはユニットの番号です。

city (String)
市、区、村、または町の名前。

company (String)
顧客の会社や組織の名前。

country (String)
国の名前を指定します。

countryCode (CountryCode)
住所の国を表す 2 文字のコードです。

例えば、US です。

firstName (String)
お客様のファーストネームです。

lastName (String)
顧客のラストネーム。

name (String)
firstName と lastName に基づく、顧客のフルネーム。

phone (String)
顧客のユニークな電話番号。E.164 規格に基づいてフォーマットされています。例えば、+16135551111 です。

province (String)
県、州、地区などの住所の地域名。

provinceCode (String)
地域を表す 2 文字のコードです。

例えば、ON です。

zip (String)
住所の郵便番号を指定します。

SubscriptionMailingAddress を返すタイプ

SubscriptionManualDiscount (object)

カスタムのサブスクリプション割引です。

このページについて

フィールド

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

id (ID!)
一意の識別子です。

recurringCycleLimit (Int)
定期購入割引を注文に適用する最大回数。

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

targetType (DiscountTargetType!)
割引が適用される行のタイプ。

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

type (DiscountType!)
サブスクリプション・ディスカウントのタイプ。

usageCount (Int!)
割引が適用された回数。

value (SubscriptionDiscountValue!)
サブスクリプション割引の値。

SubscriptionManualDiscount を返すタイプ

このページについて

フィールド

edges ([SubscriptionManualDiscountEdge!]!)
エッジのリスト。

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

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

このページについて

フィールド

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

node (SubscriptionManualDiscount!)
SubscriptionManualDiscountEdge の末尾の項目。

SubscriptionManualDiscountEdge を返すタイプ

SubscriptionPricingPolicy (object)

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

このページについて

フィールド

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

cycleDiscounts ([SubscriptionCyclePriceAdjustment!]!)
サブスクリプションラインのサイクルごとの調整額。

SubscriptionPricingPolicy を返すタイプ

SubscriptionShippingOption (object)

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

このページについて

フィールド

carrierService (DeliveryCarrierService)
この配送オプションを提供している配送業者のサービス。このフィールドは現在サポートされておらず、null を返します。

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

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

phoneRequired (Boolean)
配送オプションに電話番号が必要な場合。

presentmentTitle (String)
配送オプションの請求書のタイトル。

price (MoneyV2)
配送オプションの価格です。

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

SubscriptionShippingOption を返すタイプ

SubscriptionShippingOptionResultFailure (object)

サブスクリプション契約の配送に利用可能な配送オプションの決定に失敗しました。

このページについて

フィールド

message(String)
失敗の理由。

SubscriptionShippingOptionResultSuccess (object)

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

このページについて

フィールド

shippingOptions ([SubscriptionShippingOption!]!)
利用可能な配送オプション。

SuggestedOrderTransaction (object)

提案されたトランザクションを表します。

このページについて

フィールド

accountNumber (String)
支払い方法に関連するマスクされた口座番号。

amountSet (MoneyBag!)
適用可能な通貨での注文トランザクションの金額。

formattedGateway (String)
トランザクションを処理するために使用される人間が読めるペイメントゲートウェイ名です。

gateway (String)
トランザクションを処理するために使用されるペイメントゲートウェイ

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

maximumRefundableSet (MoneyBag)
ゲートウェイで返金可能な金額をショップ通貨とプレセント通貨で指定します。SuggestedRefund 内でのみ利用可能です。

parentTransaction (OrderTransaction)
関連する親トランザクション(例:キャプチャの承認)。

SuggestedOrderTransaction を返すタイプ

非推奨のフィールド

  • amount (Money!) deprecated
    トランザクションの金額です。
  • maximumRefundable (Money) deprecated
    ゲートウェイで返金可能な金額を指定します。SuggestedRefund 内でのみ使用できます。

SuggestedRefund (object)

返却されるアイテムに基づいて提出される提案された返金額を表します。

このページについて

フィールド

amountSet (ManeyBag!)
返金される合計金額をショップ通貨とプレセント通貨で指定します。

discountedSubtotalSet (MoneyBag!)
返金されるラインアイテムのすべての割引価格の合計です。

maximumRefundableSet (ManeyBag!)
ショップ通貨とプレセント通貨での返金可能な金額の合計です。

refundDuties ([RefundDuty!]!)
お客さまに返金される義務の配列です。

refundLineItems ([RefundLineItem!]!)
顧客に返金されるラインアイテムの配列。

shipping (ShippingRefund!)
お客様が支払った配送料の返金明細。

subtotalSet (MoneyBag!)
返金されるラインアイテムのすべての価格の合計をショップ通貨とプレセント通貨で表したもの。

suggestedTransactions ([SuggestedOrderTransaction!]!)
SuggestedOrderTransaction アイテムの配列。

totalCartDiscountAmountSet (MoneyBag!)
この払い戻しの全行程アイテムに適用されたカート割引額の合計。

totalDutiesSet (MoneyBag!)
ショップ通貨とプレセント通貨で注文から返金されるすべての関税の合計です。正の値でなければなりません。

totalTaxSet (MoneyBag!)
ショップ通貨とプレセント通貨で、注文から払い戻されるすべての税金の合計(正の値でなければなりません)。

totalTips (MoneyV2!)
注文から払い戻されるすべてのチップの合計です。

SuggestedRefund を返すタイプ

非推奨のフィールド

amount (Money!) deprecated
返金される金額の合計です。

maximumRefundable (Money!) deprecated
返金可能な金額の合計。

subtotal (Money!) deprecated
返金されるラインアイテムのすべての価格の合計です。

totalTaxes (Money!) deprecated
注文から払い戻されるすべての税金の合計です (正の値でなければなりません)。

TaxLine (object)

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

このページでは

フィールド

channelLiable (Boolean)
タックスラインを送信したチャネルが送金の責任を負うかどうか。null を指定すると、この TaxLine に対する責任が不明であることを示します。

priceSet (MoneyBag!)
ショップ通貨およびプレセンテーション通貨で請求される税額。

rate (Float)
適用される税率を指定します。

ratePercentage (Float)
税率が表す価格の割合。

title (String!)
税金の名前。

TaxLine を返すタイプ

非推奨のフィールド

price (Money!) deprecated
課金される税金の金額です。

TenderTransaction (object)

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

このページについて

フィールド

amount (MoneyV2!)
テンダー取引の金額と通貨。

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

paymentMethod (String)
このトランザクションに使用された支払い方法に関する情報。

processedAt (DateTime)
トランザクションが処理された日付と時間。

remoteReference (String)
テンダー取引に関連するリモートゲートウェイ参照。

test (Boolean!)
トランザクションがテストトランザクションであるかどうか。

transactionDetails (TenderTransactionDetails)
このトランザクションに使用された支払手段に関する情報。

TenderTransaction を返すタイプ

インプリメンテーション

  • Node
    複数の TenderTransaction をページングするために自動生成される型です。

このページについて

フィールド

edges ([TenderTransactionEdge!]!)
エッジのリスト。

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

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

このページについて

フィールド

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

node (TenderTransaction!)
TenderTransactionEdge の末尾の項目。

TenderTransactionEdge を返すタイプ

サンプル

https://shopify.dev/api/admin/graphql/reference/orders/tendertransaction#samples

TenderTransactionCreditCardDetails (object)

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

このページについて

フィールド

creditCardCompany (String)
顧客のクレジットカードを発行した会社の名前。

creditCardNumber (String)
顧客のクレジットカード番号(先頭の数字はほとんど編集されている)。

TipSale (object)

チップに関連した販売。

このページについて

フィールド

actionType (SaleActionType!)
セールが表す注文アクションのタイプ。

id (ID!)
セールの一意の識別子。

lineItem (LineItem!)
関連するセールのラインアイテムです。

lineType (SaleLineType!)
セールに関連付けられたラインタイプ。

quantity (Int)
注文された、または返却される予定のユニットの数。

taxes ([SaleTax!]!)
セールに関連するすべての個別の税金。

totalAmount (MoneyBag!)
税金と割引後の販売合計金額。

totalDiscountAmountAfterTaxes (MoneyBag!)
ラインアイテムに割り当てられた税引き後の値引き合計額。

totalDiscountAmountBeforeTaxes (MoneyBag!)
税引前の項目に割り当てられた割引の合計額。

totalTaxAmount (MoneyBag!)
販売のための税金の合計額。

インプリメント

TransactionFee オブジェクト (object)

注文取引に関連する取引手数料。

このページについて

フィールド

amount (MoneyV2!)
手数料の金額。

flatFee (MoneyV2!)
トランザクションのフラットレート料金。

flatFeeName (String)
クレジットカードのフラットフィーの名称。

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

rate (Decimal!)
パーセントチャージ。

rateName (String)
クレジットカードのレートの名前。

taxAmount (MoneyV2!)
料金に課される税金の額。

type (String!)
手数料の種類の名前。

TransactionFee を返すタイプ

インプリメント

VoidSession (object)

ボイドセッションを表します。

このページについて

フィールド

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

status (VoidSessionStatus!)
ボイドの状態です。

VoidSession のミューテーション

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

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

VoidSessionStatus (object)

ボイドの状態を表します。

このページについて

フィールド

code (VoidSessionStatusCode!)
Void Status Code です。

reason (VoidSessionStatusReason)
ボイドステータスの理由(該当する場合)。

VoidSessionStatus を返すタイプ

VoidSessionStatusReason (object)

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

このページについて

フィールド

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

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

VoidSessionStatusReason を返すタイプ

MUTATIONS

captureSessionReject (mutations)

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

このページについて

インタラクティブな例

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

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

mutation captureSessionReject($id: ID!, $reason: CaptureSessionRejectionReasonInput!) {
  captureSessionReject(id: $id, reason: $reason) {
    captureSession {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

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

引数

引数 説明
id ( ID! ) required キャプチャーセッション ID です。
reason ( CaptureSessionRejectionReasonInput! ) required 拒否の理由

CaptureSessionRejectionReasonInput フィールド

code (CaptionSsetionStatusReasonRejectionCode!) required
理由となるコードです。

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

Return フィールド

captureSession (CaptureSession)
更新されたキャプチャーセッション。

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

captureSessionResolve (mutations)

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

このページについて

インタラクティブな例

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

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

mutation captureSessionResolve($id: ID!) {
  captureSessionResolve(id: $id) {
    captureSession {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
id ( ID ! ) required キャプチャーセッション ID。

Return フィールド

captureSession (CaptureSession)
更新されたキャプチャセッション。

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

customPaymentMethodCreate (mutations)

カスタムペイメントメソッドを作成します。

このページについて

インタラクティブな例

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

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

mutation customPaymentMethodCreate($name: String!, $paymentMethod: CustomPaymentMethodInput!) {
  customPaymentMethodCreate(name: $name, paymentMethod: $paymentMethod) {
    customPaymentMethod {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "name": "placeholder",
  "paymentMethod": {
    "message": "placeholder",
    "instructions": "placeholder"
  }
}

引数

引数 説明
name ( String! ) required カスタムペイメントメソッドの名前です。
paymentMethod ( CustomPaymentMethodInput! ) required カスタム決済方法のメッセージと指示。

CustomPaymentMethodInput フィールド

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

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

Return フィールド

customPaymentMethod (CustomPaymentMethod)
作成されたカスタムペイメントメソッド。

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

customPaymentMethodDisable (mutations)

カスタムペイメントメソッドを無効にします。

このページについて

インタラクティブな例

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

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

mutation customPaymentMethodDisable($id: ID!) {
  customPaymentMethodDisable(id: $id) {
    disabledCustomPaymentMethodId
    userErrors {
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
id ( ID! ) required 無効にするカスタム決済方法の ID です。

Return フィールド

disabledCustomPaymentMethodId (ID)
無効化されたカスタム決済方法のグローバル ID。

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

customPaymentMethodUpdate (mutations)

カスタムペイメントメソッドを更新します。

このページについて

インタラクティブな例

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

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

mutation customPaymentMethodUpdate($id: ID!, $paymentMethod: CustomPaymentMethodInput!) {
  customPaymentMethodUpdate(id: $id, paymentMethod: $paymentMethod) {
    customPaymentMethod {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "paymentMethod": {
    "message": "placeholder",
    "instructions": "placeholder"
  }
}

引数

引数 説明
id ( ID! ) required カスタムペイメントメソッドの ID です。
paymentMethod ( CustomPaymentMethodInput! ) required カスタム支払方法のメッセージおよび指示。

CustomPaymentMethodInput フィールド

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

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

Return フィールド

customPaymentMethod (CustomPaymentMethod)
更新されたカスタム決済方法。

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

draftOrderCalculate (mutations)

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

このページについて

インタラクティブな例

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

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

mutation draftOrderCalculate($input: DraftOrderInput!) {
  draftOrderCalculate(input: $input) {
    calculatedDraftOrder {
      subtotalPrice
      totalPrice
      totalShippingPrice
      totalTax
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "input": {}
}

引数

引数 説明
input ( DraftOrderInput! ) required ドラフトオーダーのフィールドです。

DraftOrderInput フィールド

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)
顧客の配送情報をロードするために、ドラフトオーダーオブジェクトの一部として送信されます。

Return フィールド

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

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

draftOrderComplete (mutations)

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

このページ内

インタラクティブな例

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

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

mutation draftOrderComplete($id: ID!) {
  draftOrderComplete(id: $id) {
    draftOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
id ( ID ! ) required 完了するドラフトオーダーを指定します。
paymentPending ( Boolean ) 支払いが保留されているかどうかを指定します。
デフォルト値:false

リターンフィールド

draftOrder (DraftOrder)
完了したドラフトオーダーです。

userErrors ([UserError!]!)

ミューテーションを実行した際に発生したエラーのリスト。

draftOrderCreate (mutations)

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

このページについて

インタラクティブな例

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

ヒント:フィールドの自動補完には「Ctrl + Space」を使用してください。

mutation draftOrderCreate($input: DraftOrderInput!) {
  draftOrderCreate(input: $input) {
    draftOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "input": {}
}

引数

引数 説明
input ( DraftOrderInput! ) required ドラフトオーダーの作成に使用されるフィールドです。

DraftOrderInput フィールド

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)
顧客の配送情報をロードするために、ドラフトオーダーオブジェクトの一部として送信されます。

Return フィールド

draftOrder (DraftOrder)
作成されたドラフトオーダーです。

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

draftOrderDelete (mutations)

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

このページについて

インタラクティブな例

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

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

mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
  draftOrderDelete(input: $input) {
    deletedId
    userErrors {
      field
      message
    }
  }
}

変数

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

引数

引数 説明
input ( DraftOrderDeleteInput! ) required 削除するドラフトオーダーを ID で指定します。

DraftOrderDeleteInput フィールド

id (ID!) required
削除するドラフトオーダーの ID を指定します。

Return フィールド

deletedId (ID)
削除されたドラフトオーダーの ID。

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

draftOrderInvoicePreview (mutations)

ドラフトオーダーインボイスのメールをプレビューします。

このページについて

インタラクティブな例

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

ヒント: フィールドの自動補完には 「Ctrl + Space」 を使用してください。

mutation draftOrderInvoicePreview($id: ID!) {
  draftOrderInvoicePreview(id: $id) {
    previewHtml
    userErrors {
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
email ( EmailInput ) ドラフトオーダー請求書のメールフィールドを指定します。
id ( ID! ) required プレビューする注文請書ドラフトの電子メールを指定します。

EmailInput フィールド

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

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

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

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

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

to (String)
E メールの受信者を指定します。

リターンフィールド

previewHtml (HTML)
注文請書ドラフトの E メールをプレビューするための HTML。

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

draftOrderInvoiceSend (mutations)

ドラフトオーダーの請求書をメールで送信します。

このページについて

インタラクティブな例

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

ヒント: フィールドの自動補完には 「Ctrl + Space」 を使用してください。

mutation draftOrderInvoiceSend($id: ID!) {
  draftOrderInvoiceSend(id: $id) {
    draftOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
email ( EmailInput ) ドラフトオーダー請求書のメールフィールドを指定します。
id ( ID! ) required 請求書を送信するドラフトオーダーを指定します。

EmailInput フィールド

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

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

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

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

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

to (String)
E メールの受信者を指定します。

リターンフィールド

draftOrder (DraftOrder)
請求書メールの送信対象となるドラフトオーダー。

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

draftOrderUpdate (mutations)

ドラフトオーダーを更新します。

このページについて

インタラクティブな例

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

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

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

変数

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

引数

引数 説明
id ( ID! ) required 更新するドラフトオーダーを指定します。
input ( DraftOrderInput! ) required 更新するドラフトオーダーのプロパティを指定します。

DraftOrderInput フィールド

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)
顧客の配送情報をロードするために、ドラフトオーダーオブジェクトの一部として送信されます。

Return フィールド

draftOrder (DraftOrder)
更新されたドラフトオーダーです。

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

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

Discussion

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