【Shopify.dev和訳】AdminAPI/GraphQL reference/Discounts①

この記事について

この記事は、AdminAPI/GraphQL reference/Discountsの記事を和訳したものです。

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

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

Discount APIs (OBJECTS 前半)

マーチャントが柔軟な割引を提供し、マーケティング活動を管理できるように支援します。

• AllDiscountItems — カート内のすべてのアイテムが割引を受ける資格があるかどうか。

• AutomaticDiscountSortKeys — AutomaticDiscount クエリの有効なソートキーのセット。

• CodeDiscountSortKeys — CodeDiscount クエリの有効なソートキーのセット。

• CustomerJourney — ショップのオンラインストアでの顧客の活動を表します。

• CustomerJourneySummary — ショップのオンラインストアでの顧客の活動を表します。

• CustomerMoment — 複数の CustomerMoments を介してページングするための自動生成されたタイプ。

• CustomerVisit — ショップのオンラインストアでの顧客のセッションに関する情報。

• DiscountAmount — 固定された割引金額。

• DiscountAmountInput — 割引の値とその適用方法を指定します。

• DiscountAutomatic — 複数の DiscountAutomatics を介してページングするための自動生成されたタイプ。

• DiscountAutomaticBasic — 自動基本割引。

• DiscountAutomaticBasicInput — 自動基本割引を作成または更新するための入力フィールドを指定します。

• DiscountAutomaticBxgy — 自動 BXGY 割引。

• DiscountAutomaticBxgyInput — 自動 bogo 割引を作成または更新するための入力フィールドを指定します。

• DiscountAutomaticNode — 自動割引ラッパーノード。

• DiscountCode — コード割引。

• DiscountCodeBasic — 基本的なコード割引。

• DiscountCodeBasicInput — コードの基本割引を作成または更新するための入力フィールドを指定します。

• DiscountCodeBxgy — BXGY コードの割引。

• DiscountCodeBxgyInput — BXGY コード割引を作成または更新するための入力フィールドを指定します。

• DiscountCodeFreeShipping — 送料無料コード割引。

• DiscountCodeFreeShippingInput — 送料無料コード割引を作成または更新するための入力フィールドを指定します。

• DiscountCodeNode — コード割引ラッパーノード。

• DiscountCodeSortKeys — DiscountCode クエリの有効な並べ替えキーのセット。

• DiscountCollections — 割引が前提条件または資格として持つことができるコレクションのリスト。

• DiscountCollectionsInput — 割引に添付されているコレクションを指定します。

• DiscountCountries — 割引が適用される配送先。

• DiscountCountriesInput — 送料無料割引に追加または削除する国のリストを指定します。

• DiscountCountryAll — 割引がすべての国に適用されるかどうか。

• DiscountCustomerAll — 割引がすべての顧客に適用されるかどうか。

• DiscountCustomerBuys — 前提条件項目と前提条件値。

• DiscountCustomerBuysInput — 前提条件項目と前提条件数量を指定します。

• DiscountCustomerBuysValue — 割引を適用するために必要な前提条件の数量。

• DiscountCustomerBuysValueInput — 注文の対象アイテム、各アイテムの数量、および割引の合計値。

• DiscountCustomerGets — 割引の前提条件数量を指定します。

• DiscountCustomerGetsInput — 割引されるアイテムの数量と割引値を指定します。

• DiscountCustomerGetsValue — 割引の価値とその適用方法。

• DiscountCustomerGetsValueInput — 割引されるアイテムの数量と割引値を指定します。

• DiscountCustomerSavedSearches — 割引が適用される顧客を含む、顧客が保存した検索のリスト。

• DiscountCustomerSavedSearchesInput — 割引に追加または割引から削除する検索を保存した顧客を指定します。

• DiscountCustomerSelection — この割引を利用できるお客様の選択。

• DiscountCustomerSelectionInput — この割引を利用できる顧客を指定します。

• DiscountCustomers — 割引が適用される顧客のリスト。

• DiscountCustomersInput — 割引に追加または割引から削除する顧客を指定します。

• DiscountEffect — 適用される割引の種類。現在、割引率のみがサポートされています。

• DiscountEffectInput — 割引の適用方法を指定します。現在、割引率のみがサポートされています。

• DiscountItems — 割引の資格のあるアイテムまたは前提条件のアイテム。アイテムは、collection、product、または product_variant のいずれかです。

• DiscountItemsInput — 割引に添付されるアイテムを指定します。

• DiscountMinimumQuantity — 割引を適用するために必要なアイテムの最小数量。

• DiscountMinimumQuantityInput — 割引の数量最小要件を指定します。

• DiscountMinimumRequirement — 割引の最小小計または数量要件。

• DiscountMinimumRequirementInput — Specifies the quantity or subtotal minimum requirements for a discount.

• DiscountMinimumSubtotal — 割引を適用するために必要な最小小計。

• DiscountMinimumSubtotalInput — 割引の小計最小要件を指定します。

• DiscountOnQuantity — 割引されるアイテムの数量、割引値、および割引の適用方法。

• DiscountOnQuantityInput — 割引されるアイテムの数量と割引値を指定します。

• DiscountPercentage — 割引のパーセンテージ値。

• DiscountProducts — 割引のための資格のあるまたは前提条件の製品および製品バリアント。

• DiscountProductsInput — 割引に関連付けられている製品と製品バリアントを指定します。

• DiscountPurchaseAmount — 割引を適用するために必要な、前提となる購入金額です。

• DiscountQuantity — 割引対象となるアイテムの数量です。

• DiscountRedeemCode — コード割引のためのリディームコードです。

• DiscountRedeemCodeBulkCreation — 割引引き換えコードの一括作成を表します。

• DiscountRedeemCodeBulkCreationCode — 一括作成で作成された割引還元コードを表します。

• DiscountRedeemCodeInput — 割引に付随するコードを指定します。

• DiscountShareableUrl — 割引コードの共有可能な URL です。

• DiscountShareableUrlTargetType — シェア可能な URL が掲載されているページタイプです。

• DiscountShippingDestinationSelection — この割引を適用する出荷国の選択。

• DiscountShippingDestinationSelectionInput — 送料無料の割引が適用される配送先を指定します。

• DiscountStatus — ディスカウントの状態です。

• KitSkillLocale — キットスキルで許可されているロケール言語です。

• MarketingActivity — マーケティング活動とは、マーチャントに代わってアプリが作成するマーケティングを表します。

• MarketingActivityBudgetInput — このタイプは、予算額とそのマーケティング予算タイプを組み合わせたものです。

• MarketingActivityCreateInput — マーケティング活動の作成に必要な入力項目を指定します。

• MarketingActivitySortKeys — MarketingActivity クエリで有効なソートキーのセットです。

• MarketingActivityStatus — ステータスは、このマーケティング活動が完了したか、キューに入っているか、失敗したかなどを識別するのに役立ちます。

• MarketingActivityStatusBadgeType — StatusBadgeType は、ステータスバッジの色を識別するのに役立ちます。

• MarketingActivityUpdateInput — マーケティング活動の更新に必要な入力フィールドを指定します。

• MarketingBudget — このタイプは、予算額とそのマーケティング予算タイプを組み合わせたものです。

• MarketingBudgetBudgetType — マーケティング活動の予算タイプです。

• MarketingChannel — マーケティング活動やイベントで利用可能なマーケティングチャネル。マーケティングチャネルとは、マーケティングの広範なカテゴリーであり、レポートの集計に使用されます。

• MarketingEngagement — マーケティング・エンゲージメントは、マーケティング・イベントに参加したお客様の活動を表します。

• MarketingEngagementInput — このオブジェクトは、マーケティング・エンゲージメントの入力フィールドを表します。

• MarketingEvent — マーチャントのストアや製品をマーケティングするアクションを表します。

• MarketingEventSortKeys — MarketingEvent クエリの有効なソート・キーのセットです。

• MarketingTactic — 利用可能なマーケティングイベントの種類

• PriceRule — 価格ルールとは、割引コードを適用するために満たさなければならない、資格や前提条件などの条件のことです。

• PriceRuleAllocationMethod — 価格ルールの価値をその権利を持つアイテムに割り当てる方法。

• PriceRuleCustomerSelection — 価格ルールが適用される顧客の選択。

• PriceRuleCustomerSelectionInput — 価格ルールのカスタマーセレクションを更新するための入力フィールドを指定します。

• PriceRuleDiscountCode — 価格ルールの割引コードです。

• PriceRuleDiscountCodeInput — 割引コードを操作するための入力フィールドを指定します。

• PriceRuleEntitlementToPrerequisiteQuantityRatio — 価格ルールを適用するために必要な前提条件となるアイテムの数量と、権利を有するアイテムの数量との比較。

• PriceRuleEntitlementToPrerequisiteQuantityRatioInput — 価格ルールを適用するために必要な前提条件アイテムの数量を、権利アイテムの数量と比較して指定する。

• PriceRuleFeature — 価格ルールで使用される機能の一覧です。

• PriceRuleFixedAmountValue — 定額制の価格ルールの値です。

• PriceRuleInput — 価格ルールを操作するための入力フィールドを指定します。

• PriceRuleItemEntitlements — この価格ルールが適用されるアイテム。これは、複数の製品、製品のバリエーション、コレクション、または前述の組み合わせである可能性があります。

• PriceRuleItemEntitlementsInput — 価格ルールのラインアイテム権限を更新するための入力フィールドを指定します。

• PriceRuleItemPrerequisitesInput — 価格ルールのアイテム前提条件を更新するための入力フィールドを指定します。

• PriceRuleLineItemPrerequisites — 価格ルールを適用するために必要な、単一または複数のラインアイテム製品、製品バリアント、コレクションを組み合わせて提供することもできます。

• PriceRuleMoneyRange — 価格ルールが適用されるお金の範囲

• PriceRuleMoneyRangeInput — 価格ルールが適用されるお金の範囲を更新するための入力フィールドを指定します。

• PriceRulePercentValue — パーセントの価格ルールの値です。

• PriceRulePrerequisiteToEntitlementQuantityRatio — 価格ルールを適用するために必要な前提条件となるアイテムの数量と、権利を有するアイテムの数量との比較。

• PriceRulePrerequisiteToEntitlementQuantityRatioInput — 価格ルールを適用するために必要な前提条件アイテムの数量を、権利アイテムの数量と比較して指定する。

• PriceRuleQuantityRange — 価格ルールが適用される数量範囲。

• PriceRuleQuantityRangeInput — 価格ルールが適用される数量範囲を更新するための入力フィールドを指定します。

• PriceRuleShareableUrl — 価格ルールに関連する割引コードの共有可能な URL。

• PriceRuleShareableUrlTargetType — シェア可能な URL が掲載されているページタイプ

• PriceRuleShippingEntitlementsInput — 価格ルール・シッピングエンタイトルメントを更新するための入力フィールドを指定します。

• PriceRuleShippingLineEntitlements — 価格ルールが適用される出荷ライン

• PriceRuleSortKeys — PriceRule クエリで有効なソートキーのセット。

• PriceRuleStatus — 価格ルールの状況

• PriceRuleTarget — 価格ルールを適用する行の種類（line_item または shiping_line）。

• PriceRuleTrait — 価格ルールで使用される機能の一覧です。

• PriceRuleValidityPeriod — 価格ルールが適用される時間帯のこと。

• PriceRuleValidityPeriodInput — 価格ルールの有効期間を更新するための入力フィールドを指定します。

• PriceRuleValue — 価格ルールの価値

• PriceRuleValueInput — 価格ルールを更新するための入力フィールドを指定します。

• PricingPercentageValue — パーセンテージ・プライシング・オブジェクトの値です。

• PricingValue — プライシングオブジェクトの値です。

• UTMInput — 関連するマーケティングキャンペーンに関連付けられているUrchin Traffic Module（UTM）パラメーターを指定します。

• UTMParameters — UTM パラメータのセットを表します。

• discountAutomaticActivate — 自動割引を有効にします。

• discountAutomaticBasicCreate — 基本的な自動割引を作成します。

• discountAutomaticBasicUpdate — 基本的な自動割引の ID と入力内容を更新します。

• discountAutomaticBulkDelete — 非同期的に、search または saved_search_id 引数が提供された場合、または最大割引閾値（1,000）に達した場合に、自動割引を一括で削除します。それ以外の場合は、インラインで削除されます。警告： 空白の search 引数が提供された場合、すべての自動割引は削除されます。

• discountAutomaticBxgyCreate — BXGY の自動割引を作成します。

• discountAutomaticBxgyUpdate — BXGY の自動割引を ID と入力で更新します。

• discountAutomaticDeactivate — 自動割引を無効にします。

• discountAutomaticDelete — 自動割引を削除します。

• discountCodeActivate — コード割引を有効にします。

• discountCodeBasicCreate — 基本コードの割引を作成します。

• discountCodeBasicUpdate — 基本コードの割引を更新します。

• discountCodeBulkActivate — 検索クエリ、savedSearchId、または ID のリストを使って、コードの割引を一括して非同期的に有効化します。

• discountCodeBulkDeactivate — 検索クエリ、savedSearchIdまたは ID のリストを使って、コードディスカウントを一括して非同期的に無効化します。

• discountCodeBulkDelete — 検索クエリ、savedSearchIdまたは ID のリストを使って、コードディスカウントを一括して非同期的に削除します。

• discountCodeBxgyCreate — BXGY コードの割引を作成します。

• discountCodeBxgyUpdate — BXGY コードの割引を更新します。

• discountCodeDeactivate — コード割引を無効にする。

• discountCodeDelete — コード割引を削除します。

• discountCodeFreeShippingCreate — 送料無料コードの割引を作成します。

• discountCodeFreeShippingUpdate — フリーシッピングコードの割引を更新します。

• discountCodeRedeemCodeBulkDelete — 割引のリディームコードを一括して非同期に削除します。検索クエリ、savedSearchId、またはリダイムコード ID のリストを指定して、削除するリダイムコードを指定します。

• discountRedeemCodeBulkAdd — 非同期的に割引特典コードを一括して追加します。追加するコードと、そのコードが属する割引コード ID を指定します。

• kitSkillTriggerRequest — 開発者から依頼されたアプリやショップ用のキットスキル。

• marketingActivityCreate — 新しいマーケティング活動の作成

• marketingActivityUpdate — マーケティング活動の更新

• marketingEngagementCreate — マーケティング活動のための新しいマーケティングイベントのエンゲージメントを作成します。

• priceRuleActivate — 価格ルールを有効にします。

• priceRuleCreate — 入力された内容をもとに、価格ルールを作成します。

• priceRuleDeactivate — 価格ルールを無効にします。

• priceRuleDelete — 価格ルールの削除

• priceRuleDiscountCodeCreate — 価格ルールの割引コードを作成します。

• priceRuleDiscountCodeUpdate — 価格ルールの割引コードを更新します。

• priceRuleUpdate — ID と入力を使って、価格ルールを更新します。

UNIONS

DiscountCode (union)

コード割引。

可能なタイプ

• DiscountCodeBasic
• DiscountCodeBxgy
• DiscountCodeFreeShipping

DiscountCustomerBuysValue (union)

割引を適用するために必要な前提条件の数量。

可能なタイプ

• DiscountPurchaseAmount
• DiscountQuantity

DiscountCustomerGetsValue (union)

割引の価値とその適用方法。

可能なタイプ

• DiscountAmount
• DiscountOnQuantity
• DiscountPercentage

DiscountCustomerSelection (union)

この割引を利用できるお客様の選択。

可能なタイプ

• DiscountCustomerAll
• DiscountCustomerSavedSearches
• DiscountCustomers

DiscountEffect (union)

適用される割引の種類。現在、割引率のみがサポートされています。

可能なタイプ

• DiscountPercentage

DiscountItems (union)

割引の資格のあるアイテムまたは前提条件のアイテム。アイテムは、collection、product、または product_variant のいずれかです。

可能なタイプ

• AllDiscountItems
• DiscountCollections
• DiscountProducts

DiscountMinimumRequirement (union)

割引の最小小計または数量要件。

可能なタイプ

• DiscountMinimumQuantity
• DiscountMinimumSubtotal

DiscountShippingDestinationSelection (union)

この割引が適用される配送国の選択。

可能なタイプ

• DiscountCountries
• DiscountCountryAll

PriceRuleValue (union)

価格ルールの値。

可能なタイプ

• PriceRuleFixedAmountValue
• PriceRulePercentValue

PricingValue (union)

価格ルールオブジェクトの値。

可能なタイプ

• MoneyV2
• PricingPercentageValue

OBJECTS

AllDiscountItems (object)

カート内のすべてのアイテムが割引を受ける資格があるかどうか。

必要なアクセス
アプリには read_discounts アクセススコープが必要です

Fields

allItems (Boolean!)
すべてのアイテムが選択されているかどうか。この値はハードコードされており、true となっています。

CustomerJourney (object)

ショップのオンラインストアでの顧客のアクティビティを表します。

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

Fields

customerOrderIndex (Int!)
顧客の注文履歴の中での現在の注文の位置です。

daysToConversion (Int!)
最初のセッションから注文作成日までの日数です。最初のセッションとは、最後の注文以降の最初のセッション、または最後の注文から 30 日以上経過している場合は、30 日のアトリビューションウィンドウ内の最初のセッションを表します。

firstVisit (CustomerVisit!)
お客様がお店に入る最初のセッション。

lastVisit (CustomerVisit)
注文がなされる前の最後のセッション。

moments ([CustomerMoment!]!)
ショップのセッションなど、お客様の注文に先立つイベント。

CustomerJourneySummary (object)

ショップのオンラインストアでの顧客のアクティビティを表します。

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

Connections

moments (CustomerMomentConnection)
ショップセッションなど、顧客の注文に先行するイベント。

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

Fields

customerOrderIndex (Int)
顧客の注文履歴内での現在の注文の位置。テスト注文は含まれません。

daysToConversion (Int)
最初のセッションから注文作成日までの日数です。最初のセッションとは、最後の注文以降の最初のセッション、または最後の注文から 30 日以上経過している場合は、30 日のアトリビューションウィンドウ内の最初のセッションを表します。

firstVisit (CustomerVisit)
お客様がお店に入った最初のセッションを表す。

lastVisit (CustomerVisit)
注文をする前の最後のセッション。

momentsCount (Int)
この注文に関連する顧客のモーメントの合計数。注文がまだ帰属する過程にある場合は null を返します。

ready (Boolean!)
この注文の属性付きセッションがまだ作成されていないかどうか。

CustomerJourneySummary を返すタイプ

• Order.customerJourneySummary

CustomerMoment (object)

複数の CustomerMoments を介してページングするための自動生成されたタイプ。

Fields

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

pageInfo (PageInfo!)
ページネーションを補助するための情報。
自動生成されたタイプで、1 つの CustomerMoment とページネーション時のカーソルを保持します。

Fields

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

node (CustomerMoment!)
CustomerMomentEdge の末尾の項目。

CustomerMomentEdge を返すタイプ

• CustomerMomentConnection.edges

ショップセッションなど、顧客の注文に先行するイベントを表します。

Fields

occurredAt (DateTime！)
顧客の瞬間が発生したとき。

CustomerMoment を実装するタイプ

• CustomerVisit

CustomerVisit (object)

ショップのオンラインストアでの顧客のセッションに関する情報。

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

Fields

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

landingPage (URL)
顧客がそのセッションで最初に訪れたページの URL。

landingPageHtml (HTML)
HTML でリンクされた URL を持つランディングページ情報。例えば、お客様が最初に訪れたページは store.myshopify.com/products/1 です。

marketingEvent (MarketingEvent)
商品、コレクション、割引などの Shopify リソースをマーケティングするために、マーチャントに代わってアプリが行ったアクションを表します。

occurredAt (DateTime!)
顧客モーメントが発生した時。

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

referralInfoHtml (FormattedString!)
HTML でリンクされた URL を持つ紹介情報。

referrerUrl (URL)
お客さまがリンクをクリックしてオンラインストアに移動した Web ページ。例えば、https://randomblog.com/page1 や android-app://com.google.android.gm。

source (String!)
プラットフォーム（Facebook、Google）、メール、ダイレクト、ウェブサイトのドメイン、QR コード、不明など、お客様がストアを訪れたソース。

sourceDescription (String)
最初または最後のセッションのソースを明示的に記述します。

sourceType (MarketingTactic)
マーケティング戦術のタイプ。

utmParameters (UTMParameters)
参照元の URL パラメータから集められた UTM パラメータのセット。

CustomerVisit を返すタイプ

• CustomerJourney.firstVisit
• CustomerJourney.lastVisit
• CustomerJourneySummary.firstVisit
• CustomerJourneySummary.lastVisit

実装

• CustomerMoment
• Node

サンプル

サンプル

Query

# Orderオブジェクトを使って特定の顧客の訪問を取得
{
  order(id:"gid://shopify/Order/1248358694934") {
    customerJourney {
      lastVisit {
        id
        landingPage
        landingPageHtml
        occurredAt
        referralCode
        referralInfoHtml
        referrerUrl
        source
        sourceDescription
        sourceType
      }
    }
  }
}

Response

{
  "data": {
    "order": {
      "customerJourney": null
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 3,
      "actualQueryCost": 2,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 998,
        "restoreRate": 50
      }
    }
  }
}

サンプル 2

Query

# 特定の顧客の訪問履歴を `node` フィールドと GraphQL フラグメントを使って取得する
{
  node(id: "gid://shopify/Order/1248358694934") {
    id
    ... on CustomerVisit {
      id
      landingPage
      landingPageHtml
      occurredAt
      referralCode
      referralInfoHtml
      referrerUrl
      source
      sourceDescription
      sourceType
    }
  }
}

Response

{
  "data": {
    "node": {
      "id": "gid://shopify/Order/1248358694934"
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 1,
      "actualQueryCost": 1,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 999,
        "restoreRate": 50
      }
    }
  }
}

DiscountAmount (object)

割引の固定金額。

必要なアクセス
read_discounts アクセススコープが必要です

Fields

amount (MoneyV2!)
ディスカウントの値です。

appliesOnEachItem (Boolean!)
true の場合、割引は権利のあるアイテムのそれぞれに適用されます。false の場合、金額は権利のあるすべてのアイテムに分割されます。

DiscountAutomatic (object)

複数の DiscountAutomatics を介してページングするための自動生成されたタイプ。

Fields

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

pageInfo (PageInfo!)
ページネーションを助けるための情報。
自動生成されたタイプで、ページネーションの際に DiscountAutomatic とカーソルを 1 つずつ保持する。

Fields

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

node (DiscountAutomatic!)
DiscountAutomaticEdge の末尾の項目。

DiscountAutomaticEdge を返すタイプ

• DiscountAutomaticConnection.edges

自動割引。

可能なタイプ

• DiscountAutomaticBasic
• DiscountAutomaticBxgy

DiscountAutomaticBasic (object)

自動基本割引。

必要なアクセス
read_discounts アクセススコープが必要です

Fields

asyncUsageCount (Int!)
割引が使用された回数です。この値は非同期に更新されるため、実際の使用回数とは異なる場合があります。

createdAt (DateTime!)
割引が作成された日付と時間。

customerGets (DiscountCustomerGets!)
注文内の対象商品、それぞれの数量、割引の合計値を示します。

endsAt (DateTime)
割引が終了する日付と時間。オープンエンドの割引の場合は、null を使用します。

minimumRequirement (DiscountMinimumRequirement!)
割引が適用されるために必要な最小の小計または数量。

shortSummary (String!)
割引の短い概要。

startsAt (DateTime!)
割引が開始される日付と時間。

status (DiscountStatus!)
割引のステータス。

summary (String!)
割引の詳細な概要。

title (String!)
ディスカウントのタイトル。

DiscountAutomaticBasic のミューテーション

discountAutomaticBasicCreate
基本的な自動割引を作成します。

discountAutomaticBasicUpdate
基本自動割引の ID と入力内容を更新します。

DiscountAutomaticBxgy (object)

自動 BXGY 割引。

必要なアクセス
read_discounts アクセススコープが必要です

Connection

events (EventConnection!)
ホスト・サブジェクトに関連するイベントのページングされたリスト。

Argument	Description
after ( String )	指定されたカーソルの後に続く要素を返します。
before ( String )	指定されたカーソルの前にある要素を返します。
first ( Int )	リストの最初の n 個の要素までを返します。
last ( Int )	リストの最後の n 個の要素までを返します。
query ( String )	サポートされているフィルターパラメーター： ・comments ・created_at ・subject_type ・verb フィルタの使用の詳細については、詳細な検索構文を参照してください。
reverse ( Boolean )	基になるリストの順序を逆にします。 デフォルト値：false
sortKey ( EventSortKeys )	基になるリストを指定されたキーでソートします。 デフォルト値：ID

Fields

asyncUsageCount (Int!)
割引が使用された回数です。この値は非同期に更新されるため、実際の使用回数とは異なる場合があります。

createdAt (DateTime!)
割引が作成された日付と時間。

customerBuys (DiscountCustomerBuys!)
割引の対象となるために顧客が購入しなければならない対象アイテムとそれぞれの数量。

customerGets (DiscountCustomerGets!)
注文の対象商品、それぞれの数量、および割引の合計金額。

endsAt (DateTime)
割引が終了する日付と時間。期限のない割引の場合は、null を使用します。

startsAt (DateTime!)
割引が開始される日付と時間。

status (DiscountStatus!)
割引のステータス。

summary (String!)
割引の詳細な概要。

title (String!)
ディスカウントのタイトル。

usesPerOrderLimit (Int)
1 つの注文に適用できる割引の最大回数。

DiscountAutomaticBxgy のミューテーション

discountAutomaticBxgyCreate
BXGY の自動割引を作成します。

discountAutomaticBxgyUpdate
BXGY の自動割引を、その ID と入力内容で更新します。

実装

• HasEvents
• Node

非推奨のフィールド

• id (ID!) deprecated
  割引のためのレガシーな一意の識別子。
• usageCount (Int!) deprecated
  割引の使用回数です。

DiscountAutomaticNode (object)

自動割引ラッパーノード。

必要なアクセス
read_discounts アクセススコープが必要です

Connections

events (EventConnection!)
ホスト・サブジェクトに関連するイベントのページングされたリスト。

Argument	Description
after ( String )	指定されたカーソルの後に続く要素を返します。
before ( String )	指定されたカーソルの前にある要素を返します。
first ( Int )	リストの最初の n 個の要素までを返します。
first ( Int )	リストの最後のn個の要素までを返します。
query ( String )	サポートされているフィルタパラメータ。 ・comments ・created_at ・subject_type ・verb フィルターの使い方の詳細は、詳細な検索構文を参照してください。
reverse ( Boolean )	基になるリストの順序を逆にします。 デフォルト値：false
sortKey ( EventSortKeys)	基になるリストを指定されたキーでソートします。 デフォルト値：ID

Fields

automaticDiscount (DiscountAutomatic!)
自動割引のこと。

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

DiscountAutomaticNode を返すタイプ

• QueryRoot.automaticDiscountNode
• QueryRoot.automaticDiscountNodes

Implements

• HasEvents
• Node

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

Fields

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

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

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

DiscountAutomaticNodeEdge を返すタイプ

• DiscountAutomaticNodeConnection.edges

サンプル

サンプル 1

Query

# 自動割引ラッパーノードのIDを取得
{
  automaticDiscountNodes(first: 5) {
    edges {
      node {
        id
      }
    }
  }
}

Response

{
  "data": {
    "automaticDiscountNodes": {
      "edges": []
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 7,
      "actualQueryCost": 2,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 998,
        "restoreRate": 50
      }
    }
  }
}

サンプル 2

Query

# 自動割引ラッパーノードの名前を取得
{
  automaticDiscountNodes(first: 5) {
    edges {
      node {
        automaticDiscount {
          __typename
        }
      }
    }
  }
}

Response

{
  "data": {
    "automaticDiscountNodes": {
      "edges": []
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 12,
      "actualQueryCost": 2,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 998,
        "restoreRate": 50
      }
    }
  }
}

DiscountCodeBasic (object)

基本的なコード割引。

必要なアクセス
read_discounts アクセススコープが必要です

Connections

codes (DiscountRedeemCodeConnection!)
割引のための償還コードのリスト。

Argument	Description
after ( String )	指定されたカーソルの後に来る要素を返します。
before ( String )	指定されたカーソルの前にある要素を返します。
first ( Int )	リストの最初の n 個の要素までを返します。
last ( Int )	リストの最後の n 個の要素までを返します。
query ( String )	サポートされているフィルターパラメーター： ・times_used フィルタの使用の詳細については、詳細な検索構文を参照してください。
reverse ( Boolean )	基になるリストの順序を逆にします。 デフォルト値：false
savedSearchId ( ID )	既存の保存済み検索の ID。検索のクエリ文字列がクエリ引数として使用されます。 SavedSearchを参照してください。
sortKey ( DiscountCodeSortKeys )	基になるリストを指定されたキーでソートします。 デフォルト値：ID

Fields

appliesOncePerCustomer (Boolean!)
割引を顧客ごとに一度だけ適用できるかどうか。

asyncUsageCount (Int!)
割引が使用された回数。

codeCount (Int!)
割引のためのリディームコードの数。

createdAt (DateTime!)
割引が作成された日付と時間。

customerGets (DiscountCustomerGets!)
注文の対象商品、それぞれの数量、そして割引の合計金額。

customerSelection (DiscountCustomerSelection!)
割引を使用できる顧客。

endsAt (DateTime)
割引が終了する日付と時間。期限のない割引の場合は、null を使用します。

hasTimelineComment (Boolean!)
ディスカウントにタイムラインコメントがあるかどうかを示す。

minimumRequirement (DiscountMinimumRequirement)
割引が適用されるために必要な最小の小計または数量。

recurringCycleLimit (Int)
定期的な購入（サブスクリプション）に割引を適用する回数。

shareableUrls ([DiscountShareableUrl!]!)
割引の共有に使用できる URL。

shortSummary (String!)
割引の短い概要。

startsAt (DateTime!)
割引が開始される日付と時間。

status (DiscountStatus!)
割引のステータス。

summary (String!)
割引の詳細な概要。

title (String!)
割引のタイトル。

totalSales (MoneyV2)
割引が使用された注文の売上合計。

usageLimit (Int)
割引を使用できる最大回数。

DiscountCodeBasic のミューテーション

discountCodeBasicCreate
基本コードの割引を作成します。

discountCodeBasicUpdate
基本コード割引の更新を行います。

DiscountCodeBxgy (object)

BXGY コードの割引。

必要なアクセス
read_discounts アクセススコープが必要です

Connections

codes (DiscountRedeemCodeConnection!)
割引の引き換えコードのリスト。

Argument	Description
after ( String )	指定されたカーソルの後に続く要素を返します。
before ( String )	指定されたカーソルの前にある要素を返します。
first ( Int )	リストから最初の n 個の要素までを返します。
last ( Int )	リストから最後の n 個までの要素を返します。
query ( String )	サポートされているフィルタパラメータ ・times_used フィルターの使い方については、詳細な検索構文を参照してください。
reverse ( Boolean )	基になるリストの順序を逆にします。 デフォルト値：false
savedSearchId ( ID )	既存の保存済み検索の ID。検索のクエリ文字列がクエリ引数として使用されます。 SavedSearchを参照してください。
sortKey ( DiscountCodeSortKeys )	基になるリストを指定されたキーでソートします。 デフォルト値：ID

Fields

appliesOncePerCustomer (Boolean!)
割引を顧客ごとに一度だけ適用できるかどうか。

asyncUsageCount (Int!)
割引が使用された回数。

codeCount (Int!)
割引のためのリディームコードの数。

createdAt (DateTime!)
割引が作成された日付と時間。

customerBuys (DiscountCustomerBuys!)
割引の対象となるために顧客が購入しなければならない対象アイテムとそれぞれの数量。

customerGets (DiscountCustomerGets!)
注文内の対象商品、それぞれの数量、および割引の合計金額。

customerSelection (DiscountCustomerSelection!)
割引を使用できる顧客。

endsAt (DateTime)
割引が終了する日付と時間。期限のない割引の場合は、null を使用します。

hasTimelineComment (Boolean!)
ディスカウントにタイムラインコメントがあるかどうかを示す。

shareableUrls ([DiscountShareableUrl!]!)
割引の共有に使用できる URL。

startsAt (DateTime!)
割引が開始される日付と時間。

status (DiscountStatus!)
割引の適用状況。

summary (String!)
割引の詳細な概要。

title (String!)
割引のタイトル。

totalSales (MoneyV2)
割引が使用された注文の売上合計。

usageLimit (Int)
割引を使用できる最大回数です。

usesPerOrderLimit (Int)
1 つの注文に適用できる割引の最大回数。

DiscountCodeBxgy のミューテーション

discountCodeBxgyCreate
BXGY コードの割引を作成します。

discountCodeBxgyUpdate
BXGY コードの割引を更新します。

DiscountCodeFreeShipping (object)

送料無料コード割引。

必要なアクセス
read_discounts アクセススコープが必要です

Connections

codes (DiscountRedeemCodeConnection!)
割引の引き換えコードのリスト。

Argument	Description
after ( String )	指定されたカーソルの後に続く要素を返します。
before ( String )	指定されたカーソルの前にある要素を返します。
first ( Int )	リストから最初の n 個の要素までを返します。
last ( Int )	リストから最後の n 個までの要素を返します。
query ( String )	サポートされているフィルタパラメータ ・times_used フィルターの使い方については、詳細な検索構文を参照してください。
reverse ( Boolean )	基になるリストの順序を逆にします。 デフォルト値：false
savedSearchId ( ID )	既存の保存済み検索の ID。検索のクエリ文字列がクエリ引数として使用されます。 SavedSearchを参照してください。
sortKey ( DiscountCodeSortKeys )	基になるリストを指定されたキーでソートします。 デフォルト値：ID

Fields

appliesOnOneTimePurchase (Boolean!)
定期的な 1 回限りの購入の場合に割引を適用するかどうか。

appliesOnSubscription (Boolean!)
定期購入の場合に割引を適用するかどうか。

appliesOncePerCustomer (Boolean!)
割引が顧客ごとに一度だけ適用されるかどうか。

asyncUsageCount (Int!)
割引が使用された回数です。

codeCount (Int!)
割引のためのリディームコードの数。

createdAt (DateTime!)
割引が作成された日付と時間。

customerSelection (DiscountCustomerSelection!)
割引を使用できる顧客。

destinationSelection (DiscountShippingDestinationSelection!)
割引の対象となる出荷先。

endsAt (DateTime)
割引が終了する日付と時間。期限のない割引の場合は、null を使用します。

hasTimelineComment (Boolean!)
ディスカウントにタイムラインコメントがあるかどうかを示す。

maximumShippingPrice (MoneyV2)
割引の対象となるために受け入れられる最大の配送価格額。

minimumRequirement (DiscountMinimumRequirement)
割引を適用するために必要な、最小の小計または数量。

recurringCycleLimit (Int)
定期的な購入（サブスクリプション）に割引を適用する回数。

shareableUrls ([DiscountShareableUrl!]!)
割引の共有に使用できる URL。

shortSummary (String!)
割引の短い概要。

startsAt (DateTime!)
割引が開始される日付と時間。

status (DiscountStatus!)
割引のステータス。

summary (String!)
割引の詳細な概要。

title (String!)
割引のタイトル。

totalSales (MoneyV2)
割引が使用された注文の売上合計。

usageLimit (Int)
割引を使用できる最大回数。

DiscountCodeFreeShipping のミューテーション

discountCodeFreeShippingCreate
送料無料コードの割引を作成します。

discountCodeFreeShippingUpdate
送料無料コードの割引を更新します。

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