📈

Admin API/GraphQL reference/Orders③

2021/10/01に公開約77,500字

この記事について

この記事は、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(続き)

Order (object)

注文とは、ショップから 1 つまたは複数の商品を購入するための顧客の要求です。Order オブジェクトを使って、注文の取得や更新ができます。Admin API で既存の注文を編集する方法については、こちらをご覧ください。

このページについて

コネクション

agreements (SalesAgreementConnection!)
注文に関連する販売契約のページングされたリスト。

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

discountApplications (DiscountApplicationConnection!)
注文に適用されているディスカウント。

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

events (EventConnection!)
順番に関連する内部イベントのリスト。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルより前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
query ( String ) サポートされるフィルタパラメータ。
comments
created_at
subject_type
verb
フィルターの使い方の詳細は、詳細な検索構文を参照してください。
reverse ( Boolean ) 対象となるリストの順序を逆にします。
デフォルト値:false
sortKey ( EventSortKeys ) 基礎となるリストを、与えられたキーでソートします。
デフォルトの値は ID

fulfillmentOrders (FulfillmentOrderConnection!)
ページネーション付きのフルフィルメントオーダーのリスト。

引数 説明
after ( String ) 指定されたカーソルの後にある要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返す。
displayable ( Boolean ) リクエストされたフルフィルメントオーダーをマーチャントに表示するかどうか。
デフォルト値:false
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返す。
query ( String ) サポートされているフィルタパラメータです。
assigned_location_id
status
詳細な検索構文を参照してください。
reverse ( Boolean ) 対象となるリストの順序を逆にします。
デフォルト値:false

lineItems (LineItemConnection!)
注文のラインアイテムのリスト。

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

localizationExtensions (LocalizationExtensionConnection!)
リソースのローカリゼーション拡張のリスト。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返す。
countryCodes ( [CountryCode!] ) 拡張子の国コードです。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
purposes ( [LocalizationExtensionPurpose!] ) 拡張機能の目的です。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false

metafields (MetafieldConnection!)
リソースに属するメタフィールドのリスト。

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

nonFulfillableLineItems (LineItemConnection!)
満たすことができないラインアイテム。たとえば、アイテムの一部または全部が返金されていたり、チップのようにアイテムが履行できないものであったりするためです。これらのラインアイテムは、ドラフトフルフィルメントまたはフルフィルメントのラインアイテムのみを考慮した場合、「失われる」ことになります。

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

privateMetafields (PrivateMetafieldConnection!)
リソースに属しているプライベート・メタフィールドのリスト。

引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返す。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
namespace ( String ) プライベート メタフィールドを名前空間でフィルタリングします。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。
デフォルト値:false

shippingLines (ShippingLineConnection!)
配送費を含むラインアイテムのリスト。

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

フィールド

alerts ([ResourceAlert!]!)
Shopify 管理画面の注文ページの上部に表示される生成されたメッセージです。例えば、これはテスト注文です。

billingAddress (MailingAddress)
お客様から提供された郵送先住所。すべての注文に郵送先住所があるわけではありません。

billingAddressMatchesShippingAddress (Boolean!)
請求先住所が発送先住所と一致するかどうか。

canMarkAsPaid (Boolean)
注文を手動で支払い済みとすることができるかどうか。

canNotifyCustomer (Boolean)
顧客に通知を送信できるかどうか。

cancelReason (OrderCancelReason)
注文がキャンセルされた理由。注文がキャンセルされなかった場合は null を返します。

cancelledAt (DateTime)
注文がキャンセルされた日付と時間です。注文がキャンセルされていない場合は null を返します。

capturable (Boolean!)
注文の支払いがキャプチャ可能かどうか。顧客のクレジットカードが支払いを承認されており、承認期間が満了していない場合は true を返します。

cartDiscountAmountSet (MoneyBag)
注文レベルのディスカウントの金額で、ラインアイテムのディスカウントは含まれていません。

clientIp (String)
この注文に関連付けられているクライアントの IP アドレス。

closed (Boolean!)
注文が閉じているかどうか。

closedAt (DateTime)
注文が閉じた日時。注文が閉じていない場合、このフィールドは NULL を返します。

confirmed (Boolean!)
注文に対して在庫が確保されているかどうか。

createdAt (DateTime!)
注文が Shopify で作成された日付と時間。

currencyCode (CurrencyCode!)
注文時のお店の通貨です。支払いが発生していない場合、このフィールドは null を返します。

currentCartDiscountAmountSet (MoneyBag!)
注文レベルの割引額から、返品されたラインアイテムの金額を差し引いた金額です。これには、ラインアイテムの割引は含まれません。

currentSubtotalLineItemsQuantity (Int!)
注文の小計に貢献するラインアイテムの数量の合計です。これには返品された数量は含まれません。

currentSubtotalPriceSet (MoneyBag!)
ラインアイテムとその割引の小計から、返品されたラインアイテムを差し引いた値です。taxesIncludedtrue の場合、この小計の金額には税金が含まれます。

currentTaxLines ([TaxLine!]!)
注文に対して請求された税金から、返品または削除されたラインアイテムの税金を差し引いた金額。

currentTotalDiscountsSet (MoneyBag!)
注文から割引された合計金額(注文レベルの割引とラインアイテムの割引を含む)から、返品されたアイテムの金額を引いたもの。

currentTotalDutiesSet (MoneyBag)
返品された品目の金額を差し引いた、注文の業務の合計金額。職務が適用されない場合は、この値は NULL です。

currentTotalPriceSet (MoneyBag!)
注文の合計金額(税金と割引を含む)から、返品された行項目の金額を引いたもの。

currentTotalTaxSet (MoneyBag!)
注文に適用されたすべての税金の合計から、返品された行アイテムの税金を差し引いた金額です。

currentTotalWeight (UnsignedInt64!)
注文に適用されたすべての税金の合計から、返されたラインアイテムの重さを引いたもの。

customAttributes ([Attribute!]!)
お客様によって注文に追加されたカスタム情報(ノート属性とも呼ばれます)。

customer (Customer)
注文をしたお客様です。すべての注文にカスタマーが関連付けられているわけではありません。

customerAcceptsMarketing (Boolean!)
顧客がマーケティング資料を受け取ることに同意したかどうか。

customerJourneySummary (CustomerJourneySummary)
注文に至るまでのお客様の店舗での体験についての説明。

customerLocale (String)
2 文字または 3 文字の言語コードで、必要に応じて地域を示す修飾語が続きます。値の例としては、'en'、'en-CA'、'en-PIRATE'などがあります。

discountCode (String)
お客様が提供した割引コード。

displayAddress (MailingAddress)
注文時に表示される、お客様の主な住所。

displayFinancialStatus (OrderDisplayFinancialStatus)
マーチャントに表示可能なオーダーの財務状況。このフィールドは、注文の財務状態の可能な全ての詳細を捕捉しておらず、表示サマリーの目的で のみ使用されるべきである。

displayFulfillmentStatus (OrderDisplayFulfillmentStatus!)
マーチャントに表示することができるオーダーのフルフィルメントステータス。このフィールドは、注文のフルフィルメント状態の可能なすべての詳細を捕捉するものではない。これは表示概要の目的でのみ使用されるべきである。

紛争 ([OrderDisputeSummary!]!)
注文に関連する各紛争の概要。

edited (Boolean!)
注文が編集されたかどうか。

email (String)
顧客に関連する電子メールアドレス。

estimatedTaxes (Boolean!)
注文にかかる税金が見積もられているかどうか。お客様が注文をしてから出荷されるまでの間に多くの要因が変化し、税金の計算に影響を与える可能性があります。このフィールドは、注文の税金が確定しており、変更の対象とならない場合は、false を返します。)

fulfillable (Boolean!)
フルフィルド可能なアイテムがあるかどうか。注文が完全に履行された後、または履行されずに完全に返金された後に、このフィールドは false を返します。

fulfillments ([Fulfillment!]!)
注文の出荷数のリスト。

引数 説明
first ( Int ) 配列の結果をこのサイズに切り詰める。

fullyPaid (Boolean!)
注文が完全に支払われたかどうか。

hasTimelineComment (Boolean!)
マーチャントが注文にタイムラインコメントを追加したかどうか。

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

legacyResourceId (UnsignedInt64!)
REST Admin API の対応するリソースの ID。

merchantEditable (Boolean!)
注文をマーチャントが編集できるかどうか。

merchantEditableErrors ([String!]!)
注文の編集ができない理由のリスト。

metafield (Metafield)
リソースに属する、名前空間とキーによるメタフィールドを返します。

引数 説明
key ( String! ) required メタフィールドのキーです。
namespace ( String! ) required メタフィールドの名前空間です。

name (String!)
注文に表示される注文の一意の識別子。例えば、#1000 や_Store1001 などです。この値は、複数のストア間で一意ではありません。

netPaymentSet (MoneyBag!)
受け取った合計金額から返金された合計金額を差し引いた、注文の正味支払額です。

note (String)
注文に関連するノートの内容。

originalTotalDutiesSet (MoneyBag)
注文作成時の関税の合計額。職務が適用されない場合は、この値は NULL です。

originalTotalPriceSet (MoneyBag)
注文作成時の合計金額です。

paymentCollectionDetails (OrderPaymentCollectionDetails!)
追加の支払いを必要とする注文の支払いコレクション詳細です。

paymentGatewayNames ([String!]!)
注文に使用されたすべての支払いゲートウェイのリスト。例えば、authorize_net や COD(Cash on Delivery)などです。

phone (String)
お客様に関連する電話番号。

physicalLocation (Location)
注文が Shopify POS を使って処理された場合は、その場所を返します。

presentmentCurrencyCode (CurrencyCode!)
この注文に対する顧客の支払い通貨です。

privateMetafield (PrivateMetafield)
リソースに属する、名前空間とキーによるプライベートメタフィールドを返します。

引数 説明
key ( String! ) required プライベート・メタフィールドのキーです。
namespace ( String! ) required プライベート・メタフィールドのための名前空間。

processedAt (DateTime!)
注文が処理された日付と時間。注文がアプリからインポートされた場合、この日時は、注文が作成された日時と一致しないことがあります。

publication (Publication)
注文を作成したパブリケーションです。

refundDiscrepancySet (MoneyBag!)
提案された返金額と実際の返金額の差です。正の値はマーチャントに有利な差を示し、負の値はカスタマーに有利な差を示します。

refundable (Boolean!)
注文を返金できるかどうか。

refunds ([Refund!]!)
注文に適用された返金のリスト。

引数 説明
first ( Int ) 配列の結果をこのサイズに切り詰めます。

requiresShipping (Boolean!)
注文のラインアイテムが物理的な出荷を必要とするかどうか。

restockable (Boolean!)
注文上の任意のラインアイテムが再入荷可能かどうか。

riskLevel (OrderRiskLevel!)
注文の不正リスクレベル。

risks ([OrderRisk!]!)
このオーダーに関連するオーダーリスク。

引数 説明
first ( Int ) 配列の結果をこのサイズに切り詰めます。

shippingAddress (MailingAddress)
注文の商品を発送するための郵送先住所。

shippingLine (ShippingLine)
注文上の送料の概要です。

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

subtotalPriceSet (MoneyBag)
送料や送料割引を含まない、ラインアイテムとその割引の小計。

suggestedRefund (SuggestedRefund)
提案された返金の詳細です。このレスポンスは RefundCreate ミューテーションの提出に使用できます。

引数 説明
refundDuties ( [RefundDutyInput!] ) 返金に含める注文からの職務です。
refundLineItems ( [RefundLineItemInput!] ) 返金の対象となる注文のラインアイテム。
refundShipping ( Boolean ) 送料の全額を返金するかどうかを指定します。
shippingAmount ( Money ) 送料を返金する金額。refundShipping をオーバーライドします。
suggestFullRefund ( Boolean ) 注文上のすべての返金可能なラインアイテムに対する返金を提案すべきかどうか。true の場合、提案された払い戻しは、すべての払い戻し可能なラインアイテムから形成され、 refundLineItems で渡されたものは無視されます。
デフォルト値:false

tags ([String!]!)
注文に関連するタグのコンマ区切りリスト。タグを更新すると、以前に注文に追加されていた既存のタグはすべて上書きされます。既存のタグを上書きせずに新しいタグを追加するには、tagsAdd ミューテーションを使用します。

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

taxesIncluded (Boolean!)
注文の小計の価格に税金が含まれているかどうか。

test (Boolean!)
この注文がテストであるかどうか。テスト注文は、Shopify Bogus Gateway またはテストモードが有効になっている支払いプロバイダを使用して行われます。テスト注文を実際の注文に変換することはできませんし、その逆も同様です。

totalCapturableSet (MoneyBag!)
注文に対して承認された金額で、捕捉されていない、または捕捉されていない状態。

totalDiscountsSet (MoneyBag)
注文から割引された合計金額。これには、注文レベルの割引とラインアイテムの割引が含まれます。合計額は返品や取り外しのために調整されていません。返品または削除を含む合計については、currentTotalDiscountsSet を使用してください。

totalOutstandingSet (MoneyBag!)
注文に対してまだ取引されていないお金の合計額。正の値は、マーチャントに利益をもたらす差額(お客様からマーチャントへの支払い)を示し、負の値は、お客様に利益をもたらす差額(マーチャントからお客様への返金)を示します。

totalPriceSet (MoneyBag!)
注文の合計金額(税金や割引を含む)。合計金額には、返品や取り外しの調整がされていません。返品や削除を考慮した合計は、currentTotalPriceSet を使用してください。

totalReceivedSet (MoneyBag!)
注文に対してお客様が受け取った合計金額です。この合計は、返品や削除に対して調整されません。

totalRefundedSet (MoneyBag)
注文に対して返金された合計金額です。

totalRefundedShippingSet (MoneyBag!)
送料として返金された合計金額。

totalShippingPriceSet (MoneyBag!)
注文の配送にかかった合計金額。この合計金額は、返品や削除のために調整されることはありません。

totalTaxSet (MoneyBag)
注文に適用されるすべての税金の合計です。この合計額は、返品または削除のために調整されません。返品または除去を含む合計については、currentTotalTaxSet を使用してください。

totalTipReceivedSet (MoneyBag!)
注文に対して受け取ったチップの合計です。

totalWeight (UnsignedInt64)
注文の総重量をグラム単位で指定します。合計値は返品や取り外しのために調整されていません。返品や除去を含む合計については、currentTotalWeightSet を使用してください。

transactions ([OrderTransaction!]!)
注文に関連する全てのトランザクションのリスト。

引数 説明
capturable ( Boolean ) トランザクションがキャプチャ可能であるかどうかでフィルタリングします。true の場合は、キャプチャ可能な承認された支払いを表すトランザクションのみを返します。false の場合は、全てのトランザクションを返す。
first ( Int ) 配列の結果をこのサイズに切り詰めます。
manuallyResolvable ( Boolean ) 手動での支払いであるかどうかによって、トランザクションをフィルタリングします。true の場合は、手動での支払いであるトランザクションのみを返します。false の場合は、すべてのトランザクションを返します。

unpaid (Boolean!)
注文に対して支払いが行われていないかどうか。

updatedAt (DateTime!)
注文が最後に変更された日付と時間。

Order を返す型

Order のミューテーション

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

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

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

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

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

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

orderEditCommit
ステージングされた変更をオーダーに適用し、保存する。ミューテーションは OrderEdit で行われる。すべてのオーダーエディットは orderEditBegin で始まり、任意の数の orderEdit* ミューテーションが行われ、orderEditCommit で終了します。

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

OrderEditSetQuantity
注文の商品の数量を設定する。

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

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

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

インプリメント

非推奨のフィールド

cartDiscountAmount (Money)
注文レベルの割引の金額(ラインアイテムの割引は含まれません)。

channel (Channel)
注文を作成したチャンネル。

customerJourney (CustomerJourney)
注文に至るまでの顧客の店舗での体験についての説明。

draftFulfillments ([DraftFulfillment!]!)
注文に対して可能なフルフィルメントのリスト(部分的にフルフィルメントが可能なラインアイテムを含む)。

landingPageDisplayText (String)
顧客が注文を送信する前に訪れたオンラインストアの最初のページ(人間に表示するため)。

landingPageUrl (URL)
顧客が注文を送信する前に訪れたオンラインストアの最初のページ。

lineItemsMutable (LineItemMutableConnection!)
あらゆる編集後の注文のラインアイテムのリスト。開発者プレビューでのみ利用可能です。

| ([a-z].+) ( (.+) )

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

location (String)
注文が Shopify POS を使用して処理された場合、これはマーチャントによって提供されたそのロケーションです。

netPayment (Money!)
注文の正味支払額は、受領した合計金額 - 返金した合計金額に基づいています。

referralCode (String)
顧客があなたのストアを訪問するためにクリックしたリンクからのマーケティングリファラルコード。次の URL 属性をサポートしています:ref、source、または r。たとえば、URL が myshopifystore.com/products/slide?ref=j2tj1tn2 の場合、この値は j2tj1tn2 となります。

referrerDisplayText (String)
顧客をあなたのオンラインストアに送ったウェブサイト。

referrerUrl (URL)
顧客がリンクをクリックしてあなたのオンラインストアに送ったウェブページ。たとえば、Google や randomblog.com/page1 などです。

subtotalPrice (Money)
ラインアイテムとその割引の小計で、送料と送料割引は含まれません。taxesIncludedtrue の場合、この小計の金額には税金が含まれます。

totalCapturable (Money!)
キャプチャされていない、またはキャプチャされていない注文に対して承認された金額です。合計は、返品や削除のために調整されていません。

totalDiscounts (Money)
注文から割引された合計金額(注文レベルの割引と明細書の割引を含む)。

totalPrice (Money!)
注文の合計金額 (税金と割引を含む)。

totalReceived (Money!)
注文に対して顧客が受け取った合計金額。

totalRefunded (Money!)
注文に対する払い戻しの合計金額。

totalShippingPrice (Money!)
注文の配送にかかった合計金額。

totalTax (Money)
注文に適用されたすべての税金の合計。

totalTipReceived (MoneyV2!) 旧式になります。
注文に対して受け取ったチップの合計額。

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

このページについて

フィールド

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

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

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

このページについて

フィールド

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

node (Order!)
OrderEdge の末尾の項目。

OrderEdge を返す型

サンプル

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

OrderAdjustment (object)

注文調整は、返金された送料、または計算された返金額と実際の返金額の差を計上するものです。

このページについて

フィールド

amountSet (MoneyBag!)
ショップ通貨とプレセンテーション通貨での注文調整額。

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

kind (OrderAdjustmentKind!)
注文調整の種類。

taxAmountSet (MoneyBag!)
ショップ通貨とプレセンテーション通貨での注文調整の税額。

OrderAdjustment を返すタイプ

インプリメント

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

このページについて

フィールド

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

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

OrderAdjustment を返すタイプ

ページネーションの際に 1 つの OrderAdjustment とカーソルを保持する自動生成タイプです。

このページでは

フィールド

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

node (OrderAdjustment!)
OrderAdjustmentEdge の末尾の項目。

OrderAdjustment を返すタイプ

OrderAgreement (object)

配置された注文に関連する契約書。

このページについて

コネクション

sales (SaleConnection!)
契約に関連するすべての個別の販売

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

フィールド

app (App)
契約を作成したアプリ。

happenedAt (DateTime!)
契約が発生した日付と時間。

id (ID!)
契約書の一意の識別子。

order (Order!)
契約に関連する注文。

reason (OrderActionType!)
アグリーメントが作成された理由です。

インプリメント

OrderApp オブジェクト (object)

オーダーを作成したアプリケーションです。

このページについて

フィールド

icon (Image!)
アプリのアイコンです。

name (String!)
アプリの名前です。

OrderApp を返すタイプ (object)

OrderEditAgreement (object)

オーダーの編集に関連する合意事項です。

このページについて

コネクション

sales (SaleConnection!)
契約に関連するすべての個別の販売

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

フィールド

app (app)
契約を作成したアプリ。

happenedAt (DateTime!)
契約が発生した日付と時間。

id (ID!)
契約書の一意の識別子。

reason (OrderActionType!)
アグリメントが作成された理由です。

インプリメント s

OrderPaymentCollectionDetails (object)

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

このページについて

フィールド

additionalPaymentCollectionUrl (URL)
注文時に追加の支払いを収集するための URL。

OrderPaymentCollectionDetails を返すタイプ

OrderRisk (object)

注文の不正チェックを表す。

このページについて

フィールド

display (Boolean!)
リスクレベルが Shopify 管理画面に表示されるかどうか。false の場合、Shopify が注文の全体的なリスクレベルを決定する際に、この注文リスクは無視されます。

level (OrderRiskLevel)
この注文リスクに基づいて、注文が詐欺的である可能性です。

このレベルは、Shopify のリスク分析またはアプリによって設定できます。

message (String)
Shopify 管理画面でマーチャントに表示されるリスクメッセージです。

OrderRisk を返すタイプ

OrderStagedChange (object)

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

このページでは

フィールド

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

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

ページネーションの際に 1 つの OrderStagedChange とカーソルを保持する自動生成タイプ。

このページでは

フィールド

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

node (OrderStagedChange!)
OrderStagedChangeEdge の末尾の項目。

OrderStagedChangeEdge を返すタイプ

あるオーダーに適用された変更点。

可能なタイプ

OrderStagedChangeAddCustomItem (object)

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

このページについて

フィールド

originalUnitPrice (MoneyV2!)
割引が適用されていない個々の商品の価格です。

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

title (String!)
アイテムのタイトル。

OrderStagedChangeAddLineItemDiscount (object)

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

このページについて

フィールド

description (String!)
割引の説明。

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

value (PricingValue!)
割引の金額です。

OrderStagedChangeAddShippingLine (object)

注文編集の一部として追加された新しい配送ライン。

このページについて

フィールド

phone (String)
配送先の電話番号

presentmentTitle (String)
出荷ラインのプレセンテーションタイトル。

price (MoneyV2!)
配送ラインの価格

title (String)
配送ラインのタイトルです。

OrderStagedChangeAddVariant (object)

既存の製品バリアントから作成された新しいアイテムです。

このページについて

フィールド

quantity (Int!)
商品の数です。

variant (ProductVariant!)
追加されたアイテムの製品バリアント。

OrderStagedChangeDecrementItem (object)

オーダーの既存のラインアイテムからのアイテムの削除。

このページについて

delta (Int!)
削除されたアイテムの数。

lineItem (LineItem!)
元のラインアイテム。

restock (Boolean!)
削除されたアイテムの再入荷の意思。

OrderStagedChangeIncrementItem (object)

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

このページについて

フィールド

delta (Int!)
追加されたアイテムの数。

lineItem (LineItem!)
元のラインアイテム。

OrderTransaction (object)

トランザクションは、注文の一部としてのお金のやり取りを表します。

このページについて

フィールド

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

amountSet (MoneyBag!)
トランザクションの金額と通貨(ショップ通貨とプレセント通貨)。

authorizationCode (String)
トランザクションに関連付けられた認証コード。

authorizationExpiresAt (DateTime)
オーソリゼーションが失効する時間。このフィールドは Shopify Plus プランの店舗のみが利用可能で、Shopify Payments のオーソリゼーションのためだけに入力されます。

createdAt (DateTime!)
トランザクションが作成された日付と時間。

errorCode (OrderTransactionErrorCode)
ペイメントプロバイダーに依存しない、標準化されたエラーコードです。

fees ([TransactionFee!]!)
オーダートランザクションに請求されたトランザクションフィー。

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

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

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

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

manuallyCapturable (Boolean!)
トランザクションが手動でキャプチャできるかどうか。

maximumRefundableV2 (MoneyV2)
ゲートウェイで返金できる通貨付きの利用可能額を指定します。SuggestedRefund 内でのみ利用可能です。

order (Order)
関連する注文です。

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

paymentIcon (Image)
このトランザクションに表示する支払いアイコンを指定します。

引数 説明
crop ( CropRegion ) 指定された領域に従って、画像をクロップします。この引数は、非推奨です。代わりに Image.transformedSrccrop を使用する。
maxHeight ( Int ) 画像の高さを 1 から 2048 までのピクセル数で指定します。この引数は推奨されません。代わりに Image.transformedSrcmaxHeight を使用してください。
maxWidth ( Int ) 1 から 2048 までのピクセル単位での画像の幅。この引数は推奨されません。代わりに Image.transformedSrcmaxWidth を使用してください。
scale ( Int ) 高解像度の Retina ディスプレイ用の画像サイズの乗数。1 から 3 までの値でなければなりません。この引数は推奨されません。代わりに Image.transformedSrcscale を使用する。
デフォルト値:1

paymentProvider (PaymentProvider)
トランザクションのペイメントプロバイダーを返します。

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

settlementCurrency (CurrencyCode)
決済通貨。

settlementCurrencyRate (Decimal)
トランザクションの金額を決済通貨に変換する際に使用されるレート。

shopifyPaymentsSet (ShopifyPaymentsTransactionSet)
注文取引に関連するすべての Shopify Payments 情報を含みます。このフィールドは、Shopify Plus プランの店舗のみが利用可能です。

status (OrderTransactionStatus!)
このトランザクションのステータスです。

test (Boolean!)
この取引がテスト取引であるかどうか。

totalUnsettledSet (MoneyBag)
ショップ通貨とプレセント通貨でゲートウェイ上に捕捉可能な通貨付き金額を指定します。金額がキャプチャ可能な場合、または手動で支払い済みとマークした場合のみ利用可能です。

OrderTransaction を返すタイプ

インプリメント

非推奨のフィールド

  • amount (Money!) deprecated
    お金の量です。
  • amountV2 (MoneyV2!) deprecated
    トランザクションの金額と通貨を指定します。
  • maximumRefundable (Money) deprecated
    ゲートウェイで返金可能な金額を指定します。SuggestedRefund 内でのみ使用できます。
  • paymentMethod (PaymentMethods) deprecated
    このトランザクションの支払いに使用されたクレジットカード会社を指定します。

receipt (String) deprecated
ゲートウェイによってトランザクションに添付されたトランザクション・レシートです。このフィールドの値は、どのゲートウェイがトランザクションを処理したかによって異なります。

  • totalUnsettled (Money) deprecated
    ゲートウェイでキャプチャ可能な金額を指定します。このフィールドの値は、どのゲートウェイで処理されたかによって異なります。
  • totalUnsettledV2 (MoneyV2) deprecated
    ゲートウェイでキャプチャ可能な通貨の金額を指定します。金額がキャプチャ可能な場合、または手動で支払い済みとマークした場合にのみ使用できます。

複数の OrderTransaction をページ分割して表示するための自動生成型です。

このページについて

フィールド (object)

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

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

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

このページについて

フィールド

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

node (OrderTransaction!)
OrderTransactionEdge の末尾の項目。

OrderTransactionEdge を返すタイプ

OrderTransactionConnection.edges

サンプル

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

PaymentAuthorizationSettings (object)

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

このページについて

フィールド

enableExpiryNotifications (Boolean!)
認証の有効期限が近づいたときにメール通知を有効にします。

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

processingMethod (PaymentProcessingMethod!)
すべての支払いのための処理方法です。

PaymentAuthorizationSettings を返すタイプ

インプリメント

PaymentMethod (object)

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

このページについて

フィールド

name (String!)
支払方法の名前。

PaymentMethod を返すタイプ

非推奨のフィールド

PaymentMethodConfiguration (object)

支払い方法の設定の詳細を表します。

このページについて

フィールド

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

enabled(Boolean!
支払い方法が有効であるかどうか。

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

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

PaymentMethodConfiguration を返すタイプ

PaymentMethodRate (object)

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

このページについて

フィールド

flatFee (MoneyV2!)
クレジットカードの定額料金。

rate (Float!)
クレジット・カードのレート。

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

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