📈

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

2021/10/01に公開

GraphQL

API

Shopify

tech

この記事について

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

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

Shopify アプリのご紹介

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

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

Discount APIs (OBJECTS 後半)

`DiscountCodeNode` (`object`)

コード割引ラッパーノード。

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

codeDiscount (DiscountCode!)
コード割引。

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

DiscountCodeNode を返すタイプ

実装

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

Fields

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

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

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

Fields

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

node (DiscountCodeNode!)
DiscountCodeNodeEdge の末尾の項目。

DiscountCodeNodeEdge を返すタイプ

DiscountCodeNodeConnection.edges

サンプル

サンプル 1

Query

#  code discount wrapper node の Id を取得する
{
  codeDiscountNodes(first: 5) {
    edges {
      node {
        id
      }
    }
  }
}

Response

{
  "data": {
    "codeDiscountNodes": {
      "edges": [
        {
          "node": {
            "id": "gid://shopify/DiscountCodeNode/417007796246"
          }
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 7,
      "actualQueryCost": 3,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 997,
        "restoreRate": 50
      }
    }
  }
}

サンプル 2

Query

# 割引コードのラッパーノードの名前を取得する
{
  codeDiscountNodes(first: 5) {
    edges {
      node {
        codeDiscount {
          __typename
        }
      }
    }
  }
}

Response

{
  "data": {
    "codeDiscountNodes": {
      "edges": [
        {
          "node": {
            "codeDiscount": {
              "__typename": "DiscountCodeBasic"
            }
          }
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 12,
      "actualQueryCost": 4,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 996,
        "restoreRate": 50
      }
    }
  }
}

`DiscountCollections` (`object`)

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

Connections

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

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

`DiscountCountries` (`object`)

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

Fields

countries ([CountryCode!]!)
割引を利用できる国のコード。

includeRestOfWorld (Boolean!)
ショップの配送ゾーンで定義されていない国に割引が適用されるかどうか。

`DiscountCountryAll` (`object`)

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

Fields

allCountries (Boolean!)
このタイプに解決されると、常に true になります。

`DiscountCustomerAll` (`object`)

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

Fields

allCustomers (Boolean!)
このタイプに解決されると、常に true になります。

`DiscountCustomerBuys` (`object`)

前提条件項目と前提条件値。

Fields

items (DiscountItems!)
割引が適用されるために必要なアイテム。

value (DiscountCustomerBuysValue!)
前提条件の値。

DiscountCustomerBuys を返すタイプ

`DiscountCustomerGets` (`object`)

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

Fields

appliesOnOneTimePurchase (Boolean!)
通常の一回限りの購入商品に割引を適用するかどうか。

appliesOnSubscription (Boolean!)
割引が定期購入アイテムに適用されるかどうか。

items (DiscountItems!)
割引が適用されるアイテム。

value (DiscountCustomerGetsValue!)
権利付きの数量と割引値。

DiscountCustomerGets を返すタイプ

`DiscountCustomers` (`object`)

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

Fields

customers ([Customer!]!)
割引が利用できるお客様の一覧です。

`DiscountCustomerSavedSearches` (`object`)

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

Fields

savedSearches ([SavedSearch!]!)
割引を使用できる顧客を含む、顧客が保存した検索のリスト。

`DiscountMinimumQuantity` (`object`)

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

Fields

greaterThanOrEqualToQuantity (UnsignedInt64!)
割引を適用するために必要なアイテムの最小数量。

`DiscountMinimumSubtotal` (`object`)

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

Fields

greaterThanOrEqualToSubtotal (MoneyV2!)
割引を適用するために必要な最小小計。

`DiscountOnQuantity` (`object`)

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

Fields

effect (DiscountEffect!)
対象アイテムに対する割引の効果。

quantity (DiscountQuantity!)
割引されるアイテムの数。

`DiscountPercentage` (`object`)

割引のパーセンテージ値。

Fields

percentage (Float!)
割引のパーセンテージ値。

`DiscountProducts` (`object`)

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

Connections

productVariants (ProductVariantConnection!)
割引が前提条件または資格として持つことができる製品バリアントのリスト。

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

products (ProductConnection!)
割引が前提条件または資格として持つことができる製品のリスト。

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

`DiscountPurchaseAmount` (`object`)

割引を適用するために必要な前提条件の購入金額。

Fields

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

`DiscountQuantity` (`object`)

割引商品の数量。

Fields

quantity (UnsignedInt64!)
アイテムの数量。

DiscountQuantity を返すタイプ

DiscountOnQuantity.quantity

`DiscountRedeemCode` (`object`)

コードをコード割引に交換します。

Fields

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

code (String!)
割引のコードです。

createdBy (App)
割引コードを作成したアプリケーション。

id (ID!)
割引の引き換えコードのグローバルに一意な識別子。

DiscountRedeemCode を返すタイプ

DiscountRedeemCode のミューテーション

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

複数の DiscountRedeemCodes をページングするための自動生成タイプです。

Fields

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

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

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

Fields

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

node (DiscountRedeemCode!)
DiscountRedeemCodeEdge の最後にある項目です。

DiscountRedeemCodeEdge を返すタイプ

DiscountRedeemCodeConnection.edges

`DiscountRedeemCodeBulkCreation` (`object`)

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

Connections

codes (DiscountRedeemCodeBulkCreationCodeConnection!)
一括作成に関連するコード。

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

Fields

codesCount (Int!)
作成するコードの数です。

createdAt (DateTime!)
バルク作成が作成された日付と時間。

discountCode (DiscountCodeNode)
作成されたコードに関連するコード割引。

done (Boolean!)
バルク作成がまだキューに入っているか（false）、実行されたか（true）。

failedCount (Int!)
作成に成功しなかったコードの数。

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

importedCount (Int!)
正常に作成されたコードの数。

DiscountRedeemCodeBulkCreation を返すタイプ

QueryRoot.discountRedeemCodeBulkCreation

実装

Node

`DiscountRedeemCodeBulkCreationCode` (`object`)

一括作成によって作成された割引引き換えコードを表します。

Fields

code (String!)
作成のために送信される割引のコードです。

discountRedeemCode (DiscountRedeemCode)
作成に成功したコードの割引引き換えコードです。
コードが作成できない場合、このフィールドは null になります。

errors ([DiscountUserError!]!)
コードの作成プロセス中のエラーのリスト。

DiscountRedeemCodeBulkCreationCode を返すタイプ

DiscountRedeemCodeBulkCreation.codes

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

Fields

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

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

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

Fields

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

node (DectallReeemCodeBulkCreationCode!)
DiscountRedeemCodeBulkCreationCodeEdge の末尾にある項目です。

DiscountRedeemCodeBulkCreationCodeEdge を返すタイプ

DiscountRedeemCodeBulkCreationCodeConnection.edges

`DiscountShareableUrl` (`object`)

割引コードの共有可能な URL。

Fields

targetItemImage (Image)
割引が適用されるアイテム(製品またはコレクション)のイメージ URL。

targetType (DiscountShareableUrlTargetType!)
URL に関連付けられているページのタイプ。

title (String!)
URL に関連付けられているページのタイトル。

url (URL!)
割引コードの URL です。

DiscountShareableUrl を返すタイプ

`MarketingActivity` (`object`)

マーケティング活動は、マーチャントに代わってアプリによって作成されたマーケティングを表します。

Fields

activityListUrl (URL)
マーケティングセクションにおける、このマーケティング活動の活動一覧ページの URL。

adSpend (MoneyV2)
このマーケティング活動に費やした金額。

app (App!)
このマーケティング活動を作成したアプリ。

appErrors (MarketingActivityExtensionAppErrors)
アプリがこのアクティビティを完了させようとしたときに発生したエラー。

budget (MarketingBudget)
このマーケティング活動の予算。

createdAt (DateTime!)
このマーケティング活動が作成された日付と時間。

formData (String)
マーケティング活動のフォームデータ。

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

marketingChannel (MarketingChannel!)
レポートの集計に使用される、マーケティングの大まかなカテゴリー。

marketingEvent (MarketingEvent)
このマーケティング活動の関連するマーケティングイベント。

sourceAndMedium (String!)
使用されたプラットフォームと戦術に基づく、マーケティング活動の文脈上の説明。

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

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

statusLabel (String!)
マーケティング活動のステータスを説明するステータスラベル。

statusTransitionedAt (DateTime)
アクティビティのステータスが最後に変更された日付と時間。

tactic (MarketingTactic!)
このマーケティング活動に使用されるマーケティングの方法。

targetStatus (MarketingActivityStatus)
非同期操作の前にアプリが設定する期待されるステータス。

title (String!)
このマーケティング活動のタイトル。

updatedAt (DateTime!)
このマーケティング活動が更新された日付と時間。

utmParameters (UTMParameters)
このマーケティング活動で追跡されている UTM パラメータのセット。

MarketingActivity を返すタイプ

MarketingActivity のミューテーション

marketingActivityCreate
新しいマーケティング活動を作成します。

marketingActivityUpdate
マーケティング・アクティビティを更新します。

実装

Node

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

Fields

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

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

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

Fields

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

node (MarketingActivity!)
MarketingActivityEdge の末尾の項目。

MarketingActivityEdge を返すタイプ

MarketingActivityConnection.edges

サンプル

Query

# 最初の 10 個のマーケティング活動の ID を取得する
{
  marketingActivities(first:10) {
    edges {
      node {
        id
      }
    }
  }
}

Response

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

`MarketingBudget` (`object`)

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

Fields

budgetType (MarketingBudgetBudgetType!)
マーケティング活動の予算タイプです。

total (MoneyV2!)
マーケティング活動の予算額。

MarketingBudget を返すタイプ

MarketingActivity.budget

`MarketingEngagement` (`object`)

マーケティングエンゲージメントは、マーケティングイベントで行われる顧客の活動を表します。

Fields

adSpend (MoneyV2)
マーケティングイベントが 1 日の消費額が決まっている有料広告の場合、その日の広告費の合計です。

clicksCount (Int)
その日のマーケティングイベントの総クリック数。

commentsCount (Int)
その日のコメント数の合計。

complaintsCount (Int)
その日のクレーム総数。

failsCount (Int)
その日の失敗数の合計です。

favoritesCount (Int)
その日のお気に入りの総数。

fetchedAt (DateTime)
データがフェッチされた日付時間。

impressionsCount (Int)
その日のインプレッション数の合計。

isCumulative (Boolean)
エンゲージメントが日ごとの合計ではなく生涯値として報告されるかどうか。

marketingActivity (MarketingActivity!)
このエンゲージメントに関連するマーケティング活動。

occurredOn (Date!)
これらのエンゲージメントが発生した日付です。

sendsCount (Int)
その日の総送信数。

sharesCount (Int)
その日のシェア数の合計。

uniqueClicksCount (Int)
その日のユニーククリック数の合計。

uniqueViewsCount (Int)
その日のユニークビュー数の合計です。

unsubscribesCount (Int)
その日の配信停止数の合計です。

utcOffset (UtcOffset)
支出を割り当てる日付を決定するためにアプリが使用している UTC オフセットです。

viewsCount (Int)
その日のビュー数の合計です。

MarketingEngagement のミューテーション

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

`MarketingEvent` (`object`)

マーチャントのストアまたは製品を販売するアクションを表します。

Fields

app (App!)
マーケティングイベントが帰属するアプリです。

channel (MarketingChannel)
マーケティングイベントが使用するマーケティングチャンネル。

description (String)
マーケティングイベントの人間が読める形式の説明。

endedAt (DateTime)
マーケティング・イベントが終了した日付と時間。

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

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

manageUrl (URL)
マーケティングイベントを管理することができる URL。

previewUrl (URL)
マーケティングイベントのプレビューが可能な URL。

remoteId (String)
Shop がエンゲージメントデータを検証するのに役立つオプションの ID です。

scheduledToEndAt (DateTime)
マーケティングイベントが終了する予定の日付と時間。

sourceAndMedium (String!)
MarketingEvent が発生した場所と、どのようなコンテンツが使用されたかを示します。utmSource と utmMedium は互換的に使用されることが多いため、これは marketingChannel、referringDomain、type の組み合わせに基づいており、作成したアプリに関係なく、任意のマーケティングのピースに対して一貫した表現を提供します。

startedAt (DateTime!)
マーケティングイベントが開始された日付と時間。

type (MarketingTactic!)
マーケティングイベントのタイプ。

utmCampaign (String)
マーケティングキャンペーンの名前。

utmMedium (String)
マーケティングキャンペーンが使用している媒体。値の例：cpc, banner

utmSource (String)
マーケティングイベントのリファラー（参照元）。例示の値：google, newsletter

MarketingEvent を返すタイプ

実装

非推奨フィールド

targetTypeDisplayText (String!) deprecated
マーケティングイベントタイプの表示テキスト。

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

Fields

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

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

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

Fields

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

node (MarketingEvent!)
MarketingEventEdge の末尾の項目。

MarketingEventEdge を返すタイプ

MarketingEventConnection.edges

`PriceRule` (`object`)

価格ルールは、資格や前提条件を含む一連の条件であり、割引コードを適用するために満たす必要があります。

Connections

discountCodes (PriceRuleDiscountCodeConnection!)
価格ルールの割引コードのリスト。

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`

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

allocationLimit (Int)
価格ルールを 1 つの注文に割り当てることができる最大回数です。

allocationMethod (PriceRuleAllocationMethod!)
価格ルールの値をその権利アイテムに割り当てる方法。

app (App)
価格ルールを作成したアプリケーションです。

createdAt (DateTime!)
価格ルールが作成された日付と時間。

customerSelection (PriceRuleCustomerSelection!)
この価格ルールを使用できる顧客。

discountCodesCount (Int!)
価格ルールに関連する割引コードの数。

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

features ([PriceRuleFeature!]!)
価格ルールの機能のリスト。

hasTimelineComment (Boolean!)
価格ルールにタイムラインコメントがあるかどうかを示します。

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

itemEntitlements (PriceRuleItemEntitlements!)
価格ルールが適用されるアイテム。

itemPrerequisites (PriceRuleLineItemPrerequisites!)
価格ルールが適用されるために必要なアイテム。

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

oncePerCustomer (Boolean!)
価格ルールを顧客ごとに一度だけ適用できるかどうか。

prerequisiteQuantityRange (PriceRuleQuantityRange)
価格ルールが適用されるためには、権利のあるアイテムの数がこの範囲内に入る必要があります。

prerequisiteShippingPriceRange (PriceRuleMoneyRange)
価格規則が適用されるためには、送料がこの範囲内に収まっていなければならない。

prerequisiteSubtotalRange (PriceRuleMoneyRange)
価格規則が適用されるためには、権利付き商品の小計の価格の合計がこの範囲内に収まっていなければならない。

prerequisiteToEntitlementQuantityRatio (PriceRulePrerequisiteToEntitlementQuantityRatio)
価格ルールが適用されるために必要な前提条件アイテムの量と、権利アイテムの量との比較。

shareableUrls ([PriceRuleShareableUrl!]!)
割引を共有するために使用可能な URL。

shippingEntitlements (PriceRuleShippingLineEntitlements!)
価格ルールが適用される配送ラインを指定します。

startsAt (DateTime!)
価格ルールが開始される日付と時間。

status (PriceRuleStatus!)
価格ルールのステータス。

summary (String)
価格ルールの詳細なサマリー。

target (PriceRuleTarget!)
価格ルールを適用するラインの種類（line_item または shipping_line）。

title (String!)
価格ルールのタイトル。

totalSales (MoneyV2)
価格ルールが使用された注文の売上合計。

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

usageLimit (Int)
価格ルールの合計使用回数の最大値です。

validityPeriod (PriceRuleValidityPeriod!)
価格ルールが適用される期間。

valueV2 (PricingValue!)
価格ルールの値です。

PriceRule を返すタイプ

PriceRule のミューテーション

priceRuleActivate
価格ルールを起動します。

priceRuleCreate
入力された情報をもとに価格ルールを作成します。

priceRuleDeactivate
価格ルールを無効化します。

priceRuleDelete
価格ルールを削除します。

priceRuleUpdate
価格ルールを更新します（ID と入力を使用）。

実装

非推奨フィールド

entitlementToPrerequisiteQuantityRatio (PriceRuleEntitlementToPrerequisiteQuantityRatio) deprecated
資格のあるアイテムの数量と比較した、価格ルールを適用するために必要な前提条件アイテムの数量。

!

警告
代わりに prexidureToEntitlementQuantityRatio を使用してください
traits ([PriceRuleTrait!]!) deprecated
価格ルールの機能のリスト。

!

警告
代わりに features を使用してください
value (PriceRuleValue!) deprecated
価格ルールの値。

!

警告
代わりに features を使用してください

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

Fields

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

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

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

Fields

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

node (PriceRule!)
PriceRuleEdge の末尾の項目。

PriceRuleEdge を返すタイプ

PriceRuleConnection.edges

サンプル

サンプル 1

Query

# 最初の10個の価格ルールのIDを取得する
{
  priceRules(first: 10) {
    edges {
      node {
        id
      }
    }
  }
}

Response

{
  "data": {
    "priceRules": {
      "edges": [
        {
          "node": {
            "id": "gid://shopify/PriceRule/417007796246"
          }
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 12,
      "actualQueryCost": 3,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 997,
        "restoreRate": 50
      }
    }
  }
}

サンプル 2

Query

# IDによる価格ルールの概要取得
{
  priceRule(id: "gid://shopify/PriceRule/417007796246") {
    id
    customerSelection {
      forAllCustomers
    }
    oncePerCustomer
    startsAt
    endsAt
    status
    summary
    title
    totalSales {
      amount
    }
    usageLimit
    validityPeriod {
      start
    }
    valueV2 {
      __typename
    }
  }
}

Response

{
  "data": {
    "priceRule": {
      "id": "gid://shopify/PriceRule/417007796246",
      "customerSelection": {
        "forAllCustomers": true
      },
      "oncePerCustomer": true,
      "startsAt": "2020-09-06T17:22:22Z",
      "endsAt": "2020-10-01T03:59:59Z",
      "status": "EXPIRED",
      "summary": "10% off entire order",
      "title": "SPRINGSALE",
      "totalSales": null,
      "usageLimit": 1,
      "validityPeriod": {
        "start": "2020-09-06T17:22:22Z"
      },
      "valueV2": {
        "__typename": "PricingPercentageValue"
      }
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 4,
      "actualQueryCost": 4,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 996,
        "restoreRate": 50
      }
    }
  }
}

サンプル 3

Query

# 特定の価格ルールを `node` フィールドと GraphQL フラグメントを使って取得する
{
  node(id: "gid://shopify/PriceRule/417007796246") {
    ... on PriceRule {
      customerSelection {
        forAllCustomers
      }
      oncePerCustomer
      startsAt
      endsAt
      status
      summary
      title
      totalSales {
        amount
      }
      usageLimit
      validityPeriod {
        start
      }
      valueV2 {
        __typename
      }
    }
  }
}

Response

{
  "data": {
    "node": {
      "customerSelection": {
        "forAllCustomers": true
      },
      "oncePerCustomer": true,
      "startsAt": "2020-09-06T17:22:22Z",
      "endsAt": "2020-10-01T03:59:59Z",
      "status": "EXPIRED",
      "summary": "10% off entire order",
      "title": "SPRINGSALE",
      "totalSales": null,
      "usageLimit": 1,
      "validityPeriod": {
        "start": "2020-09-06T17:22:22Z"
      },
      "valueV2": {
        "__typename": "PricingPercentageValue"
      }
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 4,
      "actualQueryCost": 4,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 996,
        "restoreRate": 50
      }
    }
  }
}

`PriceRuleCustomerSelection` (`object`)

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

Connections

customers (CustomerConnection!)
価格ルールが適用される顧客のリスト。

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

Fields

forAllCustomers (Boolean!)
価格ルールがすべての顧客に適用されるかどうか。

savedSearches ([SavedSearch!]!)
プライス・ルールを使用できる顧客を含む、顧客の保存された検索のリスト。

PriceRuleCustomerSelection を返すタイプ

PriceRule.customerSelection

`PriceRuleDiscountCode` (`object`)

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

Fields

app (App)
割引コードを作成したアプリケーションです。

code (String!)
割引を利用するためのコードです。

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

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

PriceRuleDiscountCode を返すタイプ

PriceRule.discountCodes

PriceRuleDiscountCode のミューテーション

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

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

実装

Node

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

Fields

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

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

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

Fields

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

node (PriceRuleDiscountCode!)
PriceRuleDiscountCodeEdge の末尾の項目。

PriceRuleDiscountCodeEdge を返すタイプ

PriceRuleDiscountCodeConnection.edges

サンプル

サンプル 1

Query

# 価格ルールで最初の10個の割引コードIDを取得する
{
  priceRule(id: "gid://shopify/PriceRule/417007796246") {
    discountCodes(first:10) {
      edges {
        node {
          id
        }
      }
    }
  }
}

Response

{
  "data": {
    "priceRule": {
      "discountCodes": {
        "edges": [
          {
            "node": {
              "id": "gid://shopify/PriceRuleDiscountCode/4759850319894"
            }
          }
        ]
      }
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 13,
      "actualQueryCost": 4,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 996,
        "restoreRate": 50
      }
    }
  }
}

サンプル 2

Query

# 特定の価格ルールの割引コードを `node` フィールドと GraphQL フラグメントを使って取得する
{
  node(id: "gid://shopify/PriceRuleDiscountCode/4759850319894") {
    ... on PriceRuleDiscountCode {
      code
    }
  }
}

Response

{
  "data": {
    "node": {
      "code": "SPRINGSALE"
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 1,
      "actualQueryCost": 1,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 999,
        "restoreRate": 50
      }
    }
  }
}

サンプル 3

Query

# 価格ルールの割引コードが使用された回数の取得
{
  node(id: "gid://shopify/PriceRuleDiscountCode/4759850319894") {
    ... on PriceRuleDiscountCode {
      code
      usageCount
    }
  }
}

Response

{
  "data": {
    "node": {
      "code": "SPRINGSALE",
      "usageCount": 0
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 1,
      "actualQueryCost": 1,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 999,
        "restoreRate": 50
      }
    }
  }
}

`PriceRuleEntitlementToPrerequisiteQuantityRatio` (`object`)

価格ルールを適用するために必要な前提条件のアイテムの数量と、実態のあるアイテムの数量との比較。

Fields

entitlementQuantity (Int!)
レシオのエンタイトルメントの数量です。

prerequisiteQuantity (Int!)
比率に含まれる前提条件の量。

`PriceRuleFixedAmountValue` (`object`)

定額ルールの値。

Fields

amount (Money!)
価格ルールの金銭的価値。

`PriceRuleItemEntitlements` (`object`)

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

Connections

collections (CollectionConnection!)
価格ルールが適用されるコレクション。

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

productVariants (ProductVariantConnection!)
価格ルールが適用される製品バリアント。

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

products (ProductConnection!)
価格ルールが適用される製品。

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

Fields

targetAllLineItems (Boolean!)
価格ルールをすべてのラインアイテムに適用するかどうか。

PriceRuleItemEntitlements を返すタイプ

PriceRule.itemEntitlements

`PriceRuleLineItemPrerequisites` (`object`)

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

Connections

collections (CollectionConnection!)
価格ルールが適用されるために必要なコレクションです。

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

productVariants (ProductVariantConnection!)
価格ルールを適用するために必要な製品バリアント。

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

products (ProductConnection!)
価格ルールが適用されるために必要な製品。

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

PriceRuleLineItemPrerequisites を返すタイプ

PriceRule.itemPrerequisites

`PriceRuleMoneyRange` (`object`)

価格ルールが適用される金額範囲。

Fields

greaterThan (Money)
金額の範囲の下限値。

greaterThanOrEqualTo (Money)
金額の範囲の下限または同等。

lessThan (Money)
金額の範囲の上限です。

lessThanOrEqualTo (Money)
金額の範囲の上限または同じ値

PriceRuleMoneyRange を返すタイプ

`PriceRulePercentValue` (`object`)

パーセント価格ルールの値。

Fields

percentage (Float!)
価格ルールのパーセント値。

`PriceRulePrerequisiteToEntitlementQuantityRatio` (`object`)

資格のあるアイテムの数量と比較した、価格ルールを適用するために必要な前提条件アイテムの数量。

Fields

entitlementQuantity (Int!)
レシオのエンタイトルメントの数量です。

prerequisiteQuantity (Int!)
比率に含まれる前提条件の量。

PriceRulePrerequisiteToEntitlementQuantityRatio を返すタイプ

PriceRule.prerequisiteToEntitlementQuantityRatio

`PriceRuleQuantityRange` (`object`)

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

Fields

greaterThan (Int)
数量の範囲の下限

greaterThanOrEqualTo (Int)
数量の範囲の下限値または同等値

lessThan (Int)
数量の範囲の上限

lessThanOrEqualTo (Int)
量の範囲の上限値または等しい値

PriceRuleQuantityRange を返すタイプ

PriceRule.prerequisiteQuantityRange

`PriceRuleShareableUrl` (`object`)

価格ルールに関連付けられた割引コードの共有可能な URL。

Fields

targetItemImage (Image)
割引を適用するアイテム（商品またはコレクション）のイメージ URL。

targetType (PriceRuleShareableUrlTargetType!)
URL に関連付けられているページのタイプ。

title (String!)
URL に関連付けられているページのタイトル。

url (URL!)
割引コードの URL です。

PriceRuleShareableUrl を返すタイプ

PriceRule.shareableUrls

`PriceRuleShippingLineEntitlements` (`object`)

価格ルールが適用される配送業者。

Fields

countryCodes ([CountryCode!]!)
価格ルールが適用される国のコードです。

includeRestOfWorld (Boolean!)
価格規則が、ショップの出荷ゾーンで定義されていない国に適用されるかどうか。

targetAllShippingLines (Boolean!)
価格ルールがすべての配送ラインに適用されるかどうか。

PriceRuleShippingLineEntitlements を返すタイプ

PriceRule.shippingEntitlements

`PriceRuleValidityPeriod` (`object`)

価格ルールが適用される期間。

Fields

end (DateTime)
価格ルールが無効になるまでの時間。

start (DateTime!)
価格ルールが有効になるまでの時間。

PriceRuleValidityPeriod を返すタイプ

PriceRule.validityPeriod

`PricingPercentageValue` (`object`)

パーセンテージ価格ルールオブジェクトの値。

Fields

percentage (Float!)
オブジェクトのパーセンテージ値です。

`UTMParameters` (`object`)

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

Fields

campaign (String)
マーケティングキャンペーンの名前です。

content (String)
マーケティングキャンペーンの特定のコンテンツを識別します。マーケティングキャンペーン内の類似したコンテンツやリンクを区別して、どれが最も効果的かを判断するために使用します。

medium (String)
バナーやメールマガジンなど、マーケティングキャンペーンの媒体を示します。

source (String)
Google やメールマガジンなど、マーチャントのストアへのトラフィックのソースです。

term (String)
マーケティングキャンペーンで使用される有料検索用語。

UTMParameters を返すタイプ

Shopify アプリのご紹介

Discussion

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

この記事について

Shopify アプリのご紹介

Discount APIs (OBJECTS 後半)

DiscountCodeNode (object)

Connections

Fields

DiscountCodeNode を返すタイプ

実装

Fields

Fields

DiscountCodeNodeEdge を返すタイプ

サンプル

DiscountCollections (object)

Connections

DiscountCountries (object)

Fields

DiscountCountryAll (object)

Fields

DiscountCustomerAll (object)

Fields

DiscountCustomerBuys (object)

Fields

DiscountCustomerBuys を返すタイプ

DiscountCustomerGets (object)

Fields

DiscountCustomerGets を返すタイプ

DiscountCustomers (object)

Fields

DiscountCustomerSavedSearches (object)

Fields

DiscountMinimumQuantity (object)

Fields

DiscountMinimumSubtotal (object)

Fields

DiscountOnQuantity (object)

Fields

DiscountPercentage (object)

Fields

DiscountProducts (object)

Connections

DiscountPurchaseAmount (object)

Fields

DiscountQuantity (object)

Fields

DiscountQuantity を返すタイプ

DiscountRedeemCode (object)

Fields

DiscountRedeemCode を返すタイプ

DiscountRedeemCode のミューテーション

Fields

Fields

DiscountRedeemCodeEdge を返すタイプ

DiscountRedeemCodeBulkCreation (object)

Connections

Fields

DiscountRedeemCodeBulkCreation を返すタイプ

実装

DiscountRedeemCodeBulkCreationCode (object)

Fields

DiscountRedeemCodeBulkCreationCode を返すタイプ

Fields

Fields

DiscountRedeemCodeBulkCreationCodeEdge を返すタイプ

DiscountShareableUrl (object)

Fields

DiscountShareableUrl を返すタイプ

MarketingActivity (object)

Fields

MarketingActivity を返すタイプ

MarketingActivity のミューテーション

実装

Fields

Fields

MarketingActivityEdge を返すタイプ

サンプル

MarketingBudget (object)

Fields

MarketingBudget を返すタイプ

MarketingEngagement (object)

Fields

`DiscountCodeNode` (`object`)

`DiscountCollections` (`object`)

`DiscountCountries` (`object`)

`DiscountCountryAll` (`object`)

`DiscountCustomerAll` (`object`)

`DiscountCustomerBuys` (`object`)

`DiscountCustomerGets` (`object`)

`DiscountCustomers` (`object`)

`DiscountCustomerSavedSearches` (`object`)

`DiscountMinimumQuantity` (`object`)

`DiscountMinimumSubtotal` (`object`)

`DiscountOnQuantity` (`object`)

`DiscountPercentage` (`object`)

`DiscountProducts` (`object`)

`DiscountPurchaseAmount` (`object`)

`DiscountQuantity` (`object`)

`DiscountRedeemCode` (`object`)

`DiscountRedeemCodeBulkCreation` (`object`)

`DiscountRedeemCodeBulkCreationCode` (`object`)

`DiscountShareableUrl` (`object`)

`MarketingActivity` (`object`)

`MarketingBudget` (`object`)

`MarketingEngagement` (`object`)

`MarketingEvent` (`object`)

`PriceRule` (`object`)

`PriceRuleCustomerSelection` (`object`)

`PriceRuleDiscountCode` (`object`)

`PriceRuleEntitlementToPrerequisiteQuantityRatio` (`object`)

`PriceRuleFixedAmountValue` (`object`)

`PriceRuleItemEntitlements` (`object`)

`PriceRuleLineItemPrerequisites` (`object`)

`PriceRuleMoneyRange` (`object`)

`PriceRulePercentValue` (`object`)

`PriceRulePrerequisiteToEntitlementQuantityRatio` (`object`)

`PriceRuleQuantityRange` (`object`)

`PriceRuleShareableUrl` (`object`)

`PriceRuleShippingLineEntitlements` (`object`)

`PriceRuleValidityPeriod` (`object`)

`PricingPercentageValue` (`object`)

`UTMParameters` (`object`)