【Shopify.dev和訳】AdminAPI/GraphQL reference/Discounts④
この記事について
この記事は、AdminAPI/GraphQL reference/Discountsの記事を和訳したものです。
記事内で使用する画像は、公式ドキュメント内の画像を引用して使用させていただいております。
Shopify アプリのご紹介
Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。
Shopify アプリである、「らくらく日本語フォント設定|リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。
Discount APIs (INPUTS, ENUMS)
INPUTS
DiscountAmountInput
(input
object
)
割引の値とその適用方法を指定します。
Input fields
amount
(Decimal
)
割引の値です。
appliesOnEachItem
(Boolean
)
true の場合、割引は権利のあるアイテムのそれぞれに適用されます。false の場合、割引額は権利のあるすべてのアイテムに分割されます。
DiscountAutomaticBasicInput
(input
object
)
自動基本割引を作成または更新するための入力フィールドを指定します。
Input fields
customerGets
(DiscountCustomerGetsInput
)
注文に含まれる対象アイテム、それぞれの数量、および割引の合計金額を指定します。
endsAt
(DateTime
)
割引が終了する日時を指定します。期限のない割引の場合は、null
を使用します。
minimumRequirement
(DiscountMinimumRequirementInput
)
割引が適用されるために必要な最小の小計または数量です。
startsAt
(DateTime
)
割引を開始する日時を指定します。
title
(String
)
割引のタイトルです。
DiscountAutomaticBxgyInput
(input
object
)
自動 bogo 割引を作成または更新するための入力フィールドを指定します。
Input fields
customerBuys
(DiscountCustomerBuysInput
)
割引の対象となるために顧客が購入しなければならない対象アイテムとその数量。
customerGets
(DiscountCustomerGetsInput
)
注文内の対象商品、それぞれの数量、および割引の合計金額。
endsAt
(DateTime
)
割引が終了する日時を指定します。期限のない割引の場合は、null
を使用します。
startsAt
(DateTime
)
割引が開始される日時。
title
(String
)
割引のタイトルです。
usesPerOrderLimit (UnsignedInt64
)
1 つの注文に割引を適用できる最大回数です。
DiscountCodeBasicInput
(input
object
)
コードの基本割引を作成または更新するための入力フィールドを指定します。
Input fields
appliesOncePerCustomer
(Boolean
)
割引を顧客ごとに一度だけ適用できるかどうか。
code
(String
)
割引を使用するためのコード。
customerGets
(DiscountCustomerGetsInput
)
注文内の対象商品、それぞれの数量、および割引の合計金額。
customerSelection
(DiscountCustomerSelectionInput
)
割引を使用できる顧客を指定します。
endsAt
(DateTime
)
割引が終了する日時を指定します。期限付きの割引の場合は、null
を使用します。
minimumRequirement
(DiscountMinimumRequirementInput
)
割引を適用するために必要な最小の小計または数量を指定します。
recurringCycleLimit
(Int
)
定期的な購入(サブスクリプション)に割引を適用する回数。
startsAt
(DateTime
)
割引が開始される日付と時刻。
title
(String
)
割引のタイトルです。
usageLimit
(Int
)
割引を使用できる最大回数。制限のない割引の場合は、null
を使用します。
DiscountCodeBxgyInput
(input
object
)
BXGY コード割引を作成または更新するための入力フィールドを指定します。
Input fields
appliesOncePerCustomer
(Boolean
)
割引を顧客ごとに一度だけ適用できるかどうか。
code
(String
)
割引を使用するためのコード。
customerBuys
(DiscountCustomerBuysInput
)
割引の対象となるために顧客が購入しなければならない対象アイテムとそれぞれの数量。
customerGets
(DiscountCustomerGetsInput
)
注文に含まれる対象商品、それぞれの数量、および割引の合計金額。
customerSelection
(DiscountCustomerSelectionInput
)
割引を使用できる顧客を指定します。
endsAt
(DateTime
)
割引が終了する日時を指定します。期限のない割引の場合は、null
を使用します。
startsAt
(DateTime
)
割引が開始される日付と時刻。
title
(String
)
割引のタイトル。
usageLimit
(Int
)
割引を使用できる最大回数。制限のない割引の場合は、null
を使用します。
usesPerOrderLimit
(Int
)
1 つの注文に適用できる割引の最大回数。
DiscountCodeFreeShippingInput
(input
object
)
送料無料コード割引を作成または更新するための入力フィールドを指定します。
Input fields
appliesOnOneTimePurchase
(Boolean
)
通常の 1 回限りの購入商品に割引を適用するかどうか。
appliesOnSubscription
(Boolean
)
割引が定期購入商品に適用されるかどうか。
appliesOncePerCustomer
(Boolean
)
割引が顧客ごとに一度だけ適用されるかどうか。
code
(String
)
割引を使用するためのコード。
customerSelection
(DiscountCustomerSelectionInput
)
割引を使用できる顧客。
destination
(DiscountShippingDestinationSelectionInput
)
割引が適用される配送先のリストです。
endsAt
(DateTime
)
割引が終了する日時を指定します。期限のない割引の場合は、null
を使用します。
maximumShippingPrice
(Decimal
)
割引の対象となる最大出荷価格。
minimumRequirement
(DectionMinimumRequirementInput
)
割引を適用するために必要な最小の小計または数量です。
recurringCycleLimit
(Int
)
定期購入(サブスクリプション)に割引を適用する回数を指定します。
startsAt
(DateTime
)
割引が開始される日付と時刻。
title
(String
)
割引のタイトルです。
usageLimit
(Int
)
割引を使用できる最大回数。制限のない割引の場合は、null
を使用します。
DiscountCollectionsInput
(input
object
)
割引に添付されているコレクションを指定します。
Input fields
add
([ID!]
)
追加するコレクション ID のリストを指定します。
remove
([ID!]
)
削除するコレクション ID のリストを指定します。
DiscountCountriesInput
(input
object
)
送料無料割引に追加または削除する国のリストを指定します。
Input fields
add
([CountryCode!]
)
割引が適用される国のリストに追加する国コードを指定します。
includeRestOfWorld
(Boolean
)
割引コードが、ショップの配送ゾーンに定義されていない国にも適用されるかどうかを指定します。
remove
([CountryCode!]
)
ディスカウントが適用される国のリストから削除する国コードです。
DiscountCustomerBuysInput
(input
object
)
前提条件項目と前提条件数量を指定します。
Input fields
items
(DiscountItemsInput
)
顧客が購入したアイテムの ID です。アイテムはコレクションでも商品でもよい。
value
(DiscountCustomerBuysValueInput
)
前提となるアイテムの数量です。
DiscountCustomerBuysValueInput
(input
object
)
割引の前提条件数量を指定します。
Input fields
amount
(Decimal
)
割引を適用するために必要な前提となる購入金額です。
quantity
(UnsignedInt64
)
前提条件となるアイテムの数量です。
DiscountCustomerGetsInput
(input
object
)
割引されるアイテム、割引されるアイテムの数量、および割引の値を指定します。
Input fields
appliesOnOneTimePurchase
(Boolean
)
通常の 1 回限りの購入商品に割引を適用するかどうか。
appliesOnOneTimePurchase
(Boolean
)
割引を定期購入アイテムに適用するかどうか。
items
(DiscountItemsInput
)
顧客が取得するアイテムの ID。アイテムはコレクションでも商品でもよい。
value
(DiscountCustomerGetsValueInput
)
割引対象となるアイテムの数量と割引額です。
DiscountCustomerGetsValueInput
(input
object
)
割引されるアイテムの数量と割引値を指定します。
Input fields
discountAmount
(DiscountAmountInput
)
割引額を指定します。
discountOnQuantity
(DiscountOnQuantityInput
)
割引対象となるアイテムの数量と割引額を入力します。
percentage
(Float
)
割引額のパーセント値です。値は 0.00 ~ 1.00 の間でなければなりません。
DiscountCustomerSavedSearchesInput
(input
object
)
割引に追加または割引から削除する検索を保存した顧客を指定します。
Input fields
add
([ID!]
)
現在のカスタマーセーブサーチのリストに追加するカスタマーセーブサーチのリストです。
remove
([ID!]
)
顧客保存検索の現在のリストから削除する顧客保存検索のリストです。
DiscountCustomerSelectionInput
(input
object
)
この割引を利用できる顧客を指定します。
Input fields
all
(Boolean
)
すべての顧客がこの割引を使用できるかどうか。
customerSavedSearches
(DiscountCustomerSavedSearchesInput
)
顧客の保存済み検索リストに追加または削除する顧客の保存済み検索 ID のリストです。
customers
(DiscountCustomersInput
)
カスタマリストに追加または削除するカスタマ ID のリスト。
DiscountCustomersInput
(input
object
)
割引に追加または割引から削除する顧客を指定します。
Input fields
add
([ID!]
)
割引を利用できる現在の顧客リストに追加する顧客のリストです。
remove
([ID!]
)
割引を利用できるお客様の現在のリストから削除するお客様のリストを指定します。
DiscountEffectInput
(input
object
)
割引の適用方法を指定します。現在、パーセントオフのみ対応しています。
Input fields
percentage
(Float
)
ディスカウントのパーセンテージを指定します。値は 0.00 ~ 1.00 の間でなければなりません。
DiscountItemsInput
(input
object
)
割引に添付されるアイテムを指定します。
Input fields
all
(Boolean
)
すべてのアイテムを選択するかどうか。
collections
(DiscountCollectionsInput
)
割引に添付されるコレクションです。
products
(DiscountProductsInput
)
割引に適用される製品および製品のバリエーションです。
DiscountMinimumQuantityInput
(input
object
)
割引の数量最小要件を指定します。
Input fields
greaterThanOrEqualToQuantity
(UnsignedInt64
)
割引が適用されるために必要なアイテムの最小数量です。
DiscountMinimumRequirementInput
(input
object
)
割引の数量または小計の最小要件を指定します。
Input fields
quantity
(DiscountMinimumQuantityInput
)
最低限必要な数量を指定します。
subtotal
(DiscountMinimumSubtotalInput
)
必要な最小小計を入力します。
DiscountMinimumSubtotalInput
(input
object
)
割引の小計最小要件を指定します。
Input fields
greaterThanOrEqualToSubtotal
(Decimal
)
割引を適用するために必要な小計の最小値です。
DiscountOnQuantityInput
(input
object
)
割引されるアイテムの数量と割引値を指定します。
Input fields
effect
(DiscountEffectInput
)
割引のパーセンテージ値です。
quantity
(UnsignedInt64
)
割引対象となるアイテムの数量です。
DiscountProductsInput
(input
object
)
割引に添付されている製品と製品バリアントを指定します。
Input fields
productVariantsToAdd
([ID!]
)
追加する製品バリアント ID のリストを指定します。
productVariantsToRemove
([ID!]
)
削除する製品バリアント ID のリストを指定します。
productsToAdd
([ID!]
)
追加する製品 ID のリストを指定します。
productsToRemove
([ID!]
)
削除する製品 ID のリストを指定します。
DiscountRedeemCodeInput
(input
object
)
割引に添付されているコードを指定します。
Input fields
code
(String!
) required
割引のコードです。
DiscountShippingDestinationSelectionInput
(input
object
)
送料無料割引が適用される宛先を指定します。
Input fields
all
(Boolean
)
割引コードがすべての国に適用されるかどうかを指定します。
countries
(DiscountCountriesInput
)
割引コードが適用される国のリスト。
MarketingActivityBudgetInput
(input
object
)
このタイプは、予算額とそのマーケティング予算タイプを組み合わせたものです。
Input fields
budgetType
(MarketingBudgetBudgetType
)
マーケティング活動の予算タイプです。
total
(MoneyInput
)
マーケティング活動の予算の金額です。
MarketingActivityCreateInput
(input
object
)
マーケティング活動を作成するために必要な入力フィールドを指定します。
Input fields
budget
(MarketingActivityBudgetInput
)
このマーケティング活動の予算です。
context
(String
)
マーケティングキャンペーン ID を含むエンコードされたコンテキスト。
formData
(String
)
文字列としてシリアライズされた JSON のフォームデータ。
marketingActivityExtensionId
(ID!
) required
マーケティング活動エクステンションの ID。
marketingActivityTitle
(String
)
マーケティング活動のタイトルです。
status
(MarketingActivityStatus!
) required
マーケティング活動の現在の状態です。
utm
(UTMInput
)
関連するマーケティング キャンペーンに関連付けられている Urchin Traffic Module (UTM) パラメータを指定します。UTMInput は Storefront App を除くすべての Marketing tactics で必要です。
MarketingActivityUpdateInput
(input
object
)
マーケティング活動を更新するために必要な入力フィールドを指定します。
Input fields
adSpend
(MoneyInput
)
このマーケティング活動に費やされた累積金額。この引数は非推奨です。広告費を送信するには、MarketingEngagementCreate.MarketingEngagementInput.adSpend
GraphQL を使用してください。
budget
(MarketingActivityBudgetInput
)
このマーケティング活動の予算です。
context
(String
)
マーケティング活動の更新コールバック中に Shopify が提供するエンコードされたコンテキスト。この引数は非推奨です。このコンテキストは、コールバック中に Shopify によって必要とされなくなりました。
errors
(JSON
)
アプリがこのアクティビティを完了させようとしたときに生成されたエラーメッセージ。
formData
(String
)
マーケティング活動のフォームデータです。
id
(ID!
) required
このマーケティング活動の ID です。
marketedResources
([ID!]
)
このマーケティング活動で販売されたアイテムのリストです。これらのアイテムの有効なタイプは次のとおりです。
Product
-
Shop
(現在のショップでなければなりません。)
marketingRecommendationId
(ID
)
このマーケティング活動が作成されたレコメンデーションの ID(存在する場合)。
status
(MarketingActivityStatus
)
マーケティング活動の現在の状態です。
targetStatus
(MarketingActivityStatus
)
マーケティング活動の目標状態。
title
(String
)
このマーケティング活動のタイトルです。
utm
(UTMInput
)
関連するマーケティング キャンペーンに関連付けられている Urchin Traffic Module (UTM) パラメータを指定します。UTMInput は、Storefront App を除くすべてのマーケティング戦術に必要です。この utm パラメーターは一度だけ設定でき、決して変更できません。
MarketingEngagementInput
(input
object
)
このオブジェクトは、マーケティングエンゲージメントのマーケティングエンゲージメント入力フィールドを表します。
Input fields
adSpend
(MoneyInput
)
マーケティングイベントが 1 日あたりの消費額が決まっている有料広告の場合、その日の広告費の合計。
clicksCount
(Int
)
その日のマーケティングイベントの総クリック数。
commentsCount
(Int
)
その日のコメント数の合計。
complaintsCount
(Int
)
その日のクレーム総数。
failsCount
(Int
)
その日の失敗数の合計です。
favoritesCount
(Int
)
その日のお気に入りの総数。
fetchedAt
(DateTime
)
データがフェッチされた日付時間。
impressionsCount
(Int
)
その日のインプレッション数の合計。
isCumulative
(Boolean
)
エンゲージメントを日ごとの合計ではなく、ライフタイムの値として報告するかどうか。
occurredOn
(Date!
) required
これらのエンゲージメントが発生した日付です。
sendsCount
(Int
)
その日の送信数の合計です。
sharesCount
(Int
)
その日のシェア数の合計。
uniqueClicksCount
(Int
)
その日のユニーククリック数の合計。
uniqueViewsCount
(Int
)
その日のユニークビュー数の合計です。
unsubscribesCount
(Int
)
その日の配信停止数の合計です。
utcOffset
(UtcOffset
)
支出を割り当てる日付を決定するためにアプリが使用している UTC オフセットです。
viewsCount
(Int
)
その日のビュー数の合計です。
PriceRuleCustomerSelectionInput
(input
object
)
価格ルールの顧客選択を更新するための入力フィールドを指定します。
Input fields
customerIdsToAdd
([ID!]
)
価格ルールが適用される顧客の現在のリストに追加する顧客のリスト。savedSearchIds は空でなければなりません。
customerIdsToRemove
([ID!]
)
価格規則が適用される顧客の現在のリストから削除する顧客のリストです。
forAllCustomers
(Boolean
)
価格規則がすべての顧客に適用されるかどうか。
savedSearchIds
([ID!]
)
価格規則が適用される顧客を含む、顧客の保存された検索のリスト。単一の顧客 ID が存在することはありません。
PriceRuleDiscountCodeInput
(input
object
)
割引コードを操作するための入力フィールドを指定します。
Input fields
code
(String
)
割引を利用するためのコードです。
PriceRuleEntitlementToPrerequisiteQuantityRatioInput
(input
object
)
資格のあるアイテムの数量と比較して、価格ルールを適用するために必要な前提条件アイテムの数量を指定します。
Input fields
entitlementQuantity
(Int
)
比率のエンタイトルメントの数量です。
prerequisiteQuantity
(Int
)
比率に含まれる前提条件の量。
PriceRuleInput
(input
object
)
価格ルールを操作するための入力フィールドを指定します。
Input fields
allocationLimit
(Int
)
価格ルールを 1 つの注文に割り当てることができる最大回数です。
allocationMethod
(PriceRuleAllocationMethod
)
価格ルールの値をその権利アイテムに割り当てる方法。
customerSelection
(PriceRuleCustomerSelectionInput
)
この価格ルールを使用できる顧客。
entitlementToPrerequisiteQuantityRatio
(PriceRuleEntitlementToPrerequisiteQuantityRatioInput
)
価格ルールを適用するために必要な前提条件アイテムの数量と、権利付きアイテムの数量を比較します。この引数は非推奨です。代わりに prerequisiteToEntitlementQuantityRatio
を使用してください。
itemEntitlements
(PriceRuleItemEntitlementsInput
)
価格ルールが適用されるアイテム。
itemPrerequisites
(PriceRuleItemPrerequisitesInput
)
価格規則が適用されるために必要な項目です。
oncePerCustomer
(Boolean
)
価格ルールを顧客ごとに 1 回だけ適用できるかどうか。
prerequisiteQuantityRange
(PriceRuleQuantityRangeInput
)
価格ルールが適用されるためには、権利のあるアイテムの数がこの範囲内に入る必要があります。
prerequisiteShippingPriceRange
(PriceRuleMoneyRangeInput
)
価格ルールが適用されるためには、送料がこの範囲内に収まっていなければなりません。
prerequisiteSubtotalRange
(PriceRuleMoneyRangeInput
)
価格規則が適用されるためには、権利付き商品の小計の価格の合計がこの範囲内に収まっていなければなりません。
prerequisiteToEntitlementQuantityRatio
(PriceRulePrerequisiteToEntitlementQuantityRatioInput
)
価格ルールを適用するために必要な前提条件アイテムの数量と、権利アイテムの数量との比較。
shippingEntitlements
(PriceRuleShippingEntitlementsInput
)
価格ルールが適用される出荷ラインです。
target
(PriceRuleTarget
)
価格ルールが適用されるラインの種類(line_item または shipping_line)。
title
(String
)
価格ルールのタイトル。
usageLimit
(Int
)
価格ルールの最大使用回数。
validityPeriod
(PriceRuleValidityPeriodInput
)
価格ルールの有効期間を指定します。
value
(PriceRuleValueInput
)
価格ルールの値です。
PriceRuleItemEntitlementsInput
(input
object
)
価格ルールのラインアイテムの資格を更新するための入力フィールドを指定します。
Input fields
collectionIds
([ID!]
)
価格ルールが適用されるコレクションです。
productIds
([ID!]
)
価格規則が適用される製品。
productVariantIds
([ID!]
)
価格規則が適用される製品バリアント。
targetAllLineItems
(Boolean
)
価格規則がすべてのアイテムに適用されるかどうか。
PriceRuleItemPrerequisitesInput
(input
object
)
価格ルールのアイテムの前提条件を更新するための入力フィールドを指定します。
Input fields
collectionIds
([ID!]
)
価格ルールを適用するために必要なコレクションです。
productIds
([ID!]
)
価格ルールを適用するために必要な製品。
productVariantIds
([ID!]
)
価格ルールを適用するために必要な製品バリアント。
PriceRuleMoneyRangeInput
(input
object
)
価格ルールが適用される金額範囲を更新するための入力フィールドを指定します。
Input fields
greaterThan
(Money
)
マネーレンジの下限値。
greaterThanOrEqualTo
(Money
)
お金の範囲の下限値または同値。
lessThan
(Money
)
お金の範囲の上限です。
lessThanOrEqualTo
(Money
)
お金の範囲の上限値または同値。
PriceRulePrerequisiteToEntitlementQuantityRatioInput
(input
object
)
資格のあるアイテムの数量と比較して、価格ルールを適用するために必要な前提条件アイテムの数量を指定します。
Input fields
entitlementQuantity
(Int
)
比率のエンタイトルメントの数量です。
prerequisiteQuantity
(Int
)
比率に含まれる前提条件の量。
PriceRuleQuantityRangeInput
(input
object
)
価格ルールが適用される数量範囲を更新するための入力フィールドを指定します。
Input fields
greaterThan
(Int
)
数量の範囲の下限です。
greaterThanOrEqualTo
(Int
)
数量の範囲の下限または同等の値です。
lessThan
(Int
)
数量の範囲の上限です。
lessThanOrEqualTo
(Int
)
量の範囲の上限または同等の値です。
PriceRuleShippingEntitlementsInput
(input
object
)
価格ルールの出荷資格を更新するための入力フィールドを指定します。
Input fields
countryCodes
([CountryCode!]
)
価格ルールが適用される国のコードです。
includeRestOfWorld
(Boolean
)
価格規則が、ショップの出荷ゾーンで定義されていない国に適用されるかどうか。
targetAllShippingLines
(Boolean
)
価格ルールがすべての配送ラインに適用されるかどうかを指定します。
PriceRuleValidityPeriodInput
(input
object
)
価格ルールの有効期間を更新するための入力フィールドを指定します。
Input fields
end
(DateTime
)
価格ルールが無効になるまでの時間。
start
(DateTime!
) required
価格ルールが有効になる以降の時間。
PriceRuleValueInput
(input
object
)
価格ルールを更新するための入力フィールドを指定します。
Input fields
fixedAmountValue
(Money
)
価格ルールの固定金額値。
percentageValue
(Float
)
プライス・ルールのパーセンテージ値。
UTMInput
(input
object
)
関連するマーケティングキャンペーンに関連付けられているUrchin トラフィックモジュール(UTM)パラメーターを指定します。
Input fields
campaign
(String!
) required
UTM キャンペーンの名前です。
medium
(String!
) required
UTM キャンペーンの媒体です。
source
(String!
) required
紹介リンクが存在する Web サイトやアプリケーションの名前です。
ENUMS
AutomaticDiscountSortKeys
(enum
)
AutomaticDiscount クエリの有効なソートキーのセット。
Values
CREATED_AT
created_at
の値でソートします。
ID
id
の値でソートします。
RELEVANCE
検索時(接続時に query
パラメータが指定されている場合)に、検索語との関連性で結果をソートします。検索クエリが指定されていない場合、このソートキーは確定的ではないため、使用しないでください。
CodeDiscountSortKeys
(enum
)
CodeDiscount クエリの有効なソートキーのセット。
Values
CREATED_AT
created_at
の値でソートします。
ENDS_AT
end_at
の値でソートします。
ID
id
の値でソートします。
RELEVANCE
検索時(接続時に query
パラメータが指定されている場合)に、検索語との関連性で結果をソートします。検索クエリが指定されていない場合、このソートキーは決定性がないので使用しないでください。
STARTS_AT
starts_at
の値でソートします。
TITLE
title
の値でソートします。
UPDATED_AT
updated_at
の値でソートします。
DiscountCodeSortKeys
(enum
)
DiscountCode クエリの有効な並べ替えキーのセット。
Values
CODE
code
の値でソートします。
CREATED_AT
created_at
の値でソートします。
ID
id
の値でソートします。
RELEVANCE
検索時(接続時に query
パラメータが指定されている場合)に、検索語との関連性で結果をソートします。検索クエリが指定されていない場合、このソートキーは確定的ではないため、使用しないでください。
DiscountShareableUrlTargetType
(enum
)
共有可能な URL が表示されるページタイプ。
Values
COLLECTION
コレクションのページタイプ。
HOME
ホーム画面のタイプ。
PRODUCT
製品ページのタイプ。
DiscountStatus
(enum
)
割引の状況。
Values
ACTIVE
割引が有効であることを示します。
EXPIRED
割引が無効になっています。
SCHEDULED
割引が予定されています。
DiscountStatus を返すタイプ
DiscountAutomaticBasic.status
DiscountAutomaticBxgy.status
DiscountCodeBasic.status
DiscountCodeBxgy.status
DiscountCodeFreeShipping.status
MarketingActivitySortKeys
(enum
)
MarketingActivity クエリの有効な並べ替えキーのセット。
Values
CREATED_AT
created_at
の値でソートします。
ID
id
の値でソートします。
RELEVANCE
検索時(接続時に query
パラメータが指定されている場合)に、検索語との関連性で結果をソートします。検索クエリが指定されていない場合、このソート・キーは決定論的ではないので使用しないでください。
TITLE
title
の値でソートします。
MarketingActivityStatus
(enum
)
ステータスは、このマーケティングアクティビティが完了したか、キューに入れられたか、失敗したかなどを識別するのに役立ちます。
Values
ACTIVE
このマーケティング活動は現在実行中です。
DELETED
このマーケティング活動は永久に利用できません。
DELETED_EXTERNALLY
このマーケティング活動は削除されましたが、Shopify の外部からトリガされました。
DISCONNECTED
このマーケティング活動は切断されており、編集できなくなっています。
DRAFT
このマーケティング活動は開始されていますが、まだ作成されていません。
FAILED
このマーケティング活動は実行できません。
INACTIVE
このマーケティング活動は実行が完了しました。
PAUSED
このマーケティング活動は現在実行されていません。
PENDING
このマーケティング活動は、アプリのプラットフォーム上で作成が保留されています。
SCHEDULED
このマーケティング活動は、実行が予定されています。
UNDEFINED
外部のマーケティング活動のステータスが定義されていません。
MarketingActivityStatus を返すタイプ
MarketingActivityStatusBadgeType
(enum
)
StatusBadgeType は、ステータスバッジの色を識別するのに役立ちます。
Values
ATTENTION
このステータスバッジのタイプは attention です。
DEFAULT
このステータスバッジのタイプは default です。
INFO
このステータスバッジのタイプは info です。
SUCCESS
このステータスバッジのタイプは success です。
WARNING
このステータスバッジのタイプは warning です。
MarketingActivityStatusBadgeType を返すタイプ
MarketingBudgetBudgetType
(enum
)
マーケティング活動の予算タイプ。
Values
DAILY
毎日の予算です。
LIFETIME
マーケティング活動の有効期間中の予算。
MarketingBudgetBudgetType を返すタイプ
MarketingChannel
(enum
)
マーケティング活動またはイベントに利用可能なマーケティングチャネル。マーケティングチャネルは、マーケティングの幅広いカテゴリであり、集計のレポートに使用されます。
Values
DISPLAY
表示された広告
EMAIL
メールアドレス
REFERRAL
紹介リンク
SEARCH
有料検索
SOCIAL
ソーシャルメディア
MarketingChannel を返すタイプ
MarketingEventSortKeys
(enum
)
MarketingEvent クエリの有効なソートキーのセット。
Values
ID
id
の値でソートします。
RELEVANCE
検索時(接続時に query
パラメータが指定されている場合)に、検索語との関連性で結果をソートします。検索クエリが指定されていない場合、このソートキーは確定的ではないため、使用しないでください。
STARTED_AT
start_at
の値でソートします。
MarketingTactic
(enum
)
利用可能なマーケティングイベントの種類。
Values
ABANDONED_CART
放置されたカートの回収メール。
AD
Facebook 広告などの広告のこと。
AFFILIATE
アフィリエイトリンク。
DIRECT
オンラインストアへの直接アクセス。
LINK
リンク。
LOYALTY
ロイヤルティプログラム。
MESSAGE
Facebook Messenger などのメッセージングアプリ。
NEWSLETTER
ニュースレター。
NOTIFICATION
Shopify の管理画面に表示される通知。
POST
ブログの投稿。
RETARGETING
リターゲティング広告です。
SEO
SEO。
STOREFRONT_APP
オンラインストアに表示されるポップアップ。
TRANSACTIONAL
トランザクショナルメール。
DISPLAY
(deprecated
)
表示された広告。
FOLLOW_UP
(deprecated
)
フォローアップメール。
RECEIPT
(deprecated
)
プロモーションレシート。
SEARCH
(deprecated
)
有料検索。
MarketingTactic を返すタイプ
PriceRuleAllocationMethod
(enum
)
価格ルールの値をその資格のあるアイテムに割り当てる方法。
Values
ACROSS
値は、権利のあるアイテム全体に一度だけ適用されます。
EACH
権利のあるアイテムのそれぞれに適用されます。
PriceRuleAllocationMethod を返すタイプ
PriceRuleFeature
(enum
)
価格ルールで使用される機能のリスト。
Values
BULK
価格ルールが一括割引をサポートしている。
BUY_ONE_GET_ONE
価格ルールが数量 BXGY 割引に対応している。
BUY_ONE_GET_ONE_WITH_ALLOCATION_LIMIT
価格ルールが BXGY 割引をサポートしている。
QUANTITY_DISCOUNTS
価格ルールが数量割引をサポートしている。
SPECIFIC_CUSTOMERS
価格ルールが特定の顧客をサポートしている。
PriceRuleFeature を返すタイプ
PriceRuleShareableUrlTargetType
(enum
)
共有可能な URL が表示されるページタイプ。
Values
COLLECTION
HOME
PRODUCT
PriceRuleShareableUrlTargetType を返すタイプ
PriceRuleSortKeys
(enum
)
PriceRule クエリの有効なソートキーのセット。
Values
CREATED_AT
created_at
の値でソートします。
ENDS_AT
ends_at
の値でソートします。
ID
id
の値でソートします。
RELEVANCE
検索時(接続時に query
パラメータが指定されている場合)に、検索語との関連性で結果をソートします。検索クエリが指定されていない場合、このソートキーは決定性がないので使用しないでください。
STARTS_AT
starts_at
の値でソートします。
TITLE
title
の値でソートします。
UPDATED_AT
updated_at
の値でソートします。
PriceRuleStatus
(enum
)
価格ルールのステータス。
Values
ACTIVE
EXPIRED
SCHEDULED
PriceRuleStatus を返すタイプ
PriceRuleTarget
(enum
)
価格ルールが適用されるラインのタイプ(line_item または shipping_line)。
Values
LINE_ITEM
価格ルールはラインアイテムに適用されます。
SHIPPING_LINE
価格ルールは配送ラインに適用されます。
PriceRuleTarget を返すタイプ
PriceRuleTrait
(enum
)
価格ルールで使用される機能のリスト。
Values
BULK
価格ルールが一括割引をサポートしている。
BUY_ONE_GET_ONE
価格ルールが数量 BXGY 割引をサポートしている。
BUY_ONE_GET_ONE_WITH_ALLOCATION_LIMIT
価格ルールが、カスタム割り当て制限を使用した BXGY 割引をサポートしている。
QUANTITY_DISCOUNTS
価格ルールが、数量割引をサポートしている。
SPECIFIC_CUSTOMERS
価格ルールが、特定の顧客をサポートしている。
Shopify アプリのご紹介
Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。
Shopify アプリである、「らくらく日本語フォント設定|リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。
Discussion