📈

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

2021/10/01に公開

この記事について

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

MUTATIONS

discountAutomaticActivate (mutation)

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountAutomaticActivate($id: ID!) {
  discountAutomaticActivate(id: $id) {
    automaticDiscountNode {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

Arguments

Argument Description
id ( ID! ) required 有効にする自動割引の ID。

Return fields

automaticDiscountNode (DiscountAutomaticNode)
有効化された自動割引。

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

discountAutomaticBasicCreate (mutation)

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountAutomaticBasicCreate($automaticBasicDiscount: DiscountAutomaticBasicInput!) {
  discountAutomaticBasicCreate(automaticBasicDiscount: $automaticBasicDiscount) {
    automaticDiscountNode {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "automaticBasicDiscount": {}
}

Arguments

Argument Description
automaticBasicDiscount ( DiscountAutomaticBasicInput! ) required 自動割引を行うための入力データです。

DiscountAutomaticBasicInput フィールド

customerGets (DiscountCustomerGetsInput)
注文に含まれる対象アイテム、それぞれの数量、および割引の合計金額を指定します。

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

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

startsAt (DateTime)
割引を開始する日時を指定します。

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

Return fields

automaticDiscountNode (DiscountAutomaticNode)
作成された自動割引です。

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

discountAutomaticBasicUpdate (mutation)

ID と入力を使用して、基本的な自動割引を更新します。

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) {
  discountAutomaticBasicUpdate(
    id: $id
    automaticBasicDiscount: $automaticBasicDiscount
  ) {
    automaticDiscountNode {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "automaticBasicDiscount": {}
}

Arguments

Argument Description
automaticBasicDiscount ( DiscountAutomaticBasicInput! ) required 自動割引の更新に使用される入力データ。
id ( ID! ) required 更新する自動割引の ID。

DiscountAutomaticBasicInput フィールド

customerGets (DiscountCustomerGetsInput)
注文に含まれる対象アイテム、それぞれの数量、および割引の合計金額を指定します。

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

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

startsAt (DateTime)
割引を開始する日時を指定します。

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

Return fields

automaticDiscountNode (DiscountAutomaticNode)
更新された自動割引。

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

discountAutomaticBulkDelete (mutation)

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountAutomaticBulkDelete {
  discountAutomaticBulkDelete {
    job {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}

Arguments

Argument Description
ids ( [ID!] ) 削除する自動割引の ID。
savedSearchId ( ID ) 保存された検索の ID。
search ( String ) 自動割引をフィルタリングするための検索クエリです。

Return fields

job (Job)
自動割引を解除する非同期のジョブです。

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

discountAutomaticBxgyCreate (mutation)

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountAutomaticBxgyCreate($automaticBxgyDiscount: DiscountAutomaticBxgyInput!) {
  discountAutomaticBxgyCreate(automaticBxgyDiscount: $automaticBxgyDiscount) {
    automaticDiscountNode {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "automaticBxgyDiscount": {}
}
Argument Description
automaticBxgyDiscount ( DiscountAutomaticBxgyInput! ) required 自動割引の作成に使用される入力データ。

DiscountAutomaticBxgyInput フィールド

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

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

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

startsAt (DateTime)
割引が開始される日時。

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

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

Return fields

automaticDiscountNode (DiscountAutomaticNode)
作成された自動割引です。

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

discountAutomaticBxgyUpdate (mutation)

ID と入力を使用して BXGY 自動割引を更新します。

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountAutomaticBxgyUpdate($id: ID!, $automaticBxgyDiscount: DiscountAutomaticBxgyInput!) {
  discountAutomaticBxgyUpdate(
    id: $id
    automaticBxgyDiscount: $automaticBxgyDiscount
  ) {
    automaticDiscountNode {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "automaticBxgyDiscount": {}
}

Arguments

Argument Description
automaticBxgyDiscount ( DiscountAutomaticBxgyInput! ) required 自動割引の更新に使用される入力データ。
id ( ID! ) required 更新する自動割引の ID。

DiscountAutomaticBxgyInput フィールド

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

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

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

startsAt (DateTime)
割引が開始される日時。

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

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

Return fields

automaticDiscountNode (DiscountAutomaticNode)
更新された自動割引。

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

Arguments

Argument Description
id ( ID! ) required 更新する自動割引の ID。

Return fields

automaticDiscountNode (DiscountAutomaticNode)
解除された自動割引。

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

discountAutomaticDeactivate (mutation)

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountAutomaticDeactivate($id: ID!) {
  discountAutomaticDeactivate(id: $id) {
    automaticDiscountNode {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

Arguments

Argument Description
id ( ID! ) required 更新する自動割引の ID。

Return fields

automaticDiscountNode (DiscountAutomaticNode)
解除された自動割引。

userErrors ([DiscountUserError!]!)
変異を実行して発生したエラーのリスト。

discountAutomaticDelete (mutation)

自動割引を削除します。

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountAutomaticDelete($id: ID!) {
  discountAutomaticDelete(id: $id) {
    deletedAutomaticDiscountId
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

Arguments

Argument Description
id ( ID! ) required 削除する自動割引の ID。

Return fields

deletedAutomaticDiscountId (ID)
削除された自動割引の ID です。

userErrors ([DiscountUserError!]!)
変異を実行して発生したエラーのリストです。

discountCodeActivate (mutation)

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountCodeActivate($id: ID!) {
  discountCodeActivate(id: $id) {
    codeDiscountNode {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

Arguments

Argument Description
id ( ID! ) required 有効にするコード割引の ID。

Return fields

codeDiscountNode (DiscountCodeNode)
アクティベートされたコードディスカウントです。

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

discountCodeBasicCreate (mutation)

基本的なコード割引を作成します。

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountCodeBasicCreate($basicCodeDiscount: DiscountCodeBasicInput!) {
  discountCodeBasicCreate(basicCodeDiscount: $basicCodeDiscount) {
    codeDiscountNode {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "basicCodeDiscount": {}
}

Arguments

Argument Description
basicCodeDiscount ( DiscountCodeBasicInput! ) required コード割引の作成に使用される入力データ。

DiscountCodeBasicInput フィールド

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

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

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

customerSelection (DiscountCustomerSelectionInput)
割引を使用できる顧客を指定します。

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

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

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

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

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

usageLimit (Int)
割引を使用できる最大回数。制限のない割引の場合は、null を使用します。

Return fields

codeDiscountNode (DiscountCodeNode)
作成されたコードディスカウントです。

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

discountCodeBasicUpdate (mutation)

基本的なコード割引を更新します。

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountCodeBasicUpdate($id: ID!, $basicCodeDiscount: DiscountCodeBasicInput!) {
  discountCodeBasicUpdate(id: $id, basicCodeDiscount: $basicCodeDiscount) {
    codeDiscountNode {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "basicCodeDiscount": {}
}

Arguments

Argument Description
basicCodeDiscount ( DiscountCodeBasicInput! ) required コード割引の更新に使用される入力データ。
id ( ID! ) required 更新するコード割引の ID。

DiscountCodeBasicInput フィールド

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

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

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

customerSelection (DiscountCustomerSelectionInput)
割引を使用できる顧客を指定します。

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

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

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

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

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

usageLimit (Int)
割引を使用できる最大回数。制限のない割引の場合は、null を使用します。

Return fields

codeDiscountNode (DiscountCodeNode)
更新されたコードディスカウント。

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

discountCodeBulkActivate (mutation)

検索クエリ、savedSearchId、または ID のリストを使用して、コード割引を一括で非同期的にアクティブ化します。

Interactive example

Argument Description
ids ( [ID!] ) 有効にするコード割引の ID。
savedSearchId ( ID ) 保存された検索の ID。
search ( String ) 割引をフィルタリングするための検索クエリ。

Return fields

job (Job)
コードディスカウントを有効にする非同期のジョブです。

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

discountCodeBulkDeactivate (mutation)

検索クエリ、savedSearchId、または ID のリストを使用して、コード割引を非同期的に非アクティブ化します。

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountCodeBulkDeactivate {
  discountCodeBulkDeactivate {
    job {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}

Arguments

Argument Description
ids ( [ID!] ) コードの ID は、非アクティブ化するために割引されます。
savedSearchId ( ID ) 保存された検索の ID。
search ( String ) 割引をフィルタリングするための検索クエリ。

Return fields

job (Job)
コードディスカウントを有効にする非同期のジョブです。

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

discountCodeBulkDelete (mutation)

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountCodeBulkDelete {
  discountCodeBulkDelete {
    job {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}

Arguments

Argument Description
ids ( [ID!] ) 削除するコード割引の ID。
savedSearchId ( ID ) priceRuleSavedSearches クエリノードから取得された保存済み検索の ID。
search ( String ) 割引をフィルタリングするための検索クエリ。

Return fields

job (Job)
コードディスカウントを有効にする非同期のジョブです。

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

discountCodeBxgyCreate (mutation)

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountCodeBxgyCreate($bxgyCodeDiscount: DiscountCodeBxgyInput!) {
  discountCodeBxgyCreate(bxgyCodeDiscount: $bxgyCodeDiscount) {
    codeDiscountNode {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "bxgyCodeDiscount": {}
}

Arguments

Argument Description
bxgyCodeDiscount ( DiscountCodeBxgyInput! ) required コード割引の作成に使用される入力データ。

DiscountCodeBxgyInput フィールド

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

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

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

customerGets (DiscountCustomerGetsInput)
注文に含まれる対象商品、それぞれの数量、および割引の合計金額。

customerSelection (DiscountCustomerSelectionInput)
割引を使用できる顧客を指定します。

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

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

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

usageLimit (Int)
割引を使用できる最大回数。制限のない割引の場合は、null を使用します。

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

Return fields

codeDiscountNode (DiscountCodeNode)
作成されたコードディスカウントです。

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

discountCodeBxgyUpdate (mutation)

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountCodeBxgyUpdate($id: ID!, $bxgyCodeDiscount: DiscountCodeBxgyInput!) {
  discountCodeBxgyUpdate(id: $id, bxgyCodeDiscount: $bxgyCodeDiscount) {
    codeDiscountNode {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "bxgyCodeDiscount": {}
}

Arguments

Argument Description
bxgyCodeDiscount ( DiscountCodeBxgyInput! ) required コード割引の更新に使用される入力データ。
id ( ID! ) required 更新するコード割引の ID。

DiscountCodeBxgyInput フィールド

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

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

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

customerGets (DiscountCustomerGetsInput)
注文に含まれる対象商品、それぞれの数量、および割引の合計金額。

customerSelection (DiscountCustomerSelectionInput)
割引を使用できる顧客を指定します。

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

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

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

usageLimit (Int)
割引を使用できる最大回数。制限のない割引の場合は、null を使用します。

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

Return fields

codeDiscountNode (DiscountCodeNode)
更新されたコードディスカウント。

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

discountCodeDeactivate (mutation)

コード割引を無効にします。

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountCodeDeactivate($id: ID!) {
  discountCodeDeactivate(id: $id) {
    codeDiscountNode {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

Arguments

Argument Description
id ( ID! ) required 非アクティブ化するコード割引の ID。

Return fields

codeDiscountNode (DiscountCodeNode)
無効化されたコードディスカウント。

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

discountCodeDelete (mutation)

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountCodeDelete($id: ID!) {
  discountCodeDelete(id: $id) {
    deletedCodeDiscountId
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

Arguments

Argument Description
id ( ID! ) required 削除するコード割引の ID。

Return fields

deletedCodeDiscountId (ID)
削除されたコードディスカウントの ID です。

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

discountCodeFreeShippingCreate (mutation)

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountCodeFreeShippingCreate($freeShippingCodeDiscount: DiscountCodeFreeShippingInput!) {
  discountCodeFreeShippingCreate(
    freeShippingCodeDiscount: $freeShippingCodeDiscount
  ) {
    codeDiscountNode {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "freeShippingCodeDiscount": {}
}

Arguments

Argument Description
freeShippingCodeDiscount ( DiscountCodeFreeShippingInput! ) required コード割引の作成に使用される入力データ。

DiscountCodeFreeShippingInput フィールド

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 を使用します。

Return fields

codeDiscountNode (DiscountCodeNode)
作成されたコードディスカウントです。

userErrors ([DiscountUserError!]!)
変異を実行して発生したエラーのリスト。

discountCodeFreeShippingUpdate (mutation)

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountCodeFreeShippingUpdate($id: ID!, $freeShippingCodeDiscount: DiscountCodeFreeShippingInput!) {
  discountCodeFreeShippingUpdate(
    id: $id
    freeShippingCodeDiscount: $freeShippingCodeDiscount
  ) {
    codeDiscountNode {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "freeShippingCodeDiscount": {}
}

Arguments

Argument Description
freeShippingCodeDiscount ( DiscountCodeFreeShippingInput! ) required コード割引の更新に使用される入力データ。
id ( ID! ) required 更新するコード割引の ID。

DiscountCodeFreeShippingInput フィールド

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 を使用します。

Return fields

codeDiscountNode (DiscountCodeNode)
更新されたコードディスカウント。

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

discountCodeRedeemCodeBulkDelete (mutation)

割引引き換えコードを一括で非同期に削除します。検索クエリ、savedSearchId、または引き換えコード ID のリストを指定して、削除する引き換えコードを指定します。

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountCodeRedeemCodeBulkDelete($discountId: ID!) {
  discountCodeRedeemCodeBulkDelete(discountId: $discountId) {
    job {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "discountId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

Arguments

Argument Description
discountId ( ID! ) required 引き換えコードの割引の ID。
ids ( [ID!] ) 削除する割引引き換えコードの ID。
savedSearchId ( ID ) 保存された検索の ID。
search ( String ) 割引引き換えコードをフィルタリングするための検索クエリ。

Return fields

job (Job)
割引のリデムコードを削除する非同期ジョブです。

userErrors ([DiscountUserError!]!)
を実行して発生したエラーのリストです。

discountRedeemCodeBulkAdd (mutation)

割引引き換えコードを非同期で一括で追加します。追加するコードと、コードが属する割引コード ID を指定します。

Interactive example

これはミューテーションクエリの例です。

Query
mutation discountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {
  discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {
    bulkCreation {
      id
    }
    userErrors {
      code
      extraInfo
      field
      message
    }
  }
}
Variables
{
  "discountId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "codes": [
    {
      "code": "placeholder"
    }
  ]
}

Arguments

Argument Description
codes ( [DiscountRedeemCodeInput!]! ) required コード割引に追加されるコードのリスト。最大 100 個のコードが許可されます。
discountId ( ID! ) required コードが追加されるコード割引の ID。

DiscountRedeemCodeInput フィールド

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

Return fields

bulkCreation (DiscountRedeemCodeBulkCreation)
バルクコード作成の進捗状況を追跡します。

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

marketingActivityCreate (mutation)

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation marketingActivityCreate($input: MarketingActivityCreateInput!) {
  marketingActivityCreate(input: $input) {
    marketingActivity {
      id
    }
    redirectPath
    userErrors {
      field
      message
    }
  }
}
Variables
{
  "input": {
    "marketingActivityExtensionId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
    "status": "placeholder"
  }
}

Arguments

Argument Description
input ( MarketingActivityCreateInput! ) required マーケティング活動のインプットが生み出す。

MarketingActivityCreateInput フィールド

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 に必要です。

Return fields

marketingActivity (MarketingActivity)
作成されたマーケティング活動。

redirectPath (String)
埋め込みエディタから shopify admin に戻るためのパス。

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

marketingActivityUpdate (mutation)

マーケティング活動を更新します。

Interactive example

これはミューテーションクエリの例です。

Query
mutation marketingActivityUpdate($input: MarketingActivityUpdateInput!) {
  marketingActivityUpdate(input: $input) {
    marketingActivity {
      id
    }
    redirectPath
    userErrors {
      field
      message
    }
  }
}
Variables
{
  "input": {
    "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
  }
}

Arguments

Argument Description
input ( MarketingActivityUpdateInput! ) required マーケティング活動のインプット。

MarketingActivityUpdateInput フィールド

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 パラメーターは一度だけ設定でき、決して変更できません。

Return fields

marketingActivity (MarketingActivity)
更新されたマーケティング活動。

redirectPath (String)
埋め込みエディタから shopify admin に戻るためのパス。

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

marketingEngagementCreate mutation

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation marketingEngagementCreate($marketingActivityId: ID!, $marketingEngagement: MarketingEngagementInput!) {
  marketingEngagementCreate(
    marketingActivityId: $marketingActivityId
    marketingEngagement: $marketingEngagement
  ) {
    marketingEngagement {
      clicksCount
      commentsCount
      complaintsCount
      failsCount
      favoritesCount
      fetchedAt
      impressionsCount
      isCumulative
      occurredOn
      sendsCount
      sharesCount
      uniqueClicksCount
      uniqueViewsCount
      unsubscribesCount
      utcOffset
      viewsCount
    }
    userErrors {
      field
      message
    }
  }
}
Variables
{
  "marketingActivityId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "marketingEngagement": {
    "occurredOn": "placeholder"
  }
}

Arguments

Argument Description
marketingActivityId ( ID! ) required マーケティング活動の ID。
marketingEngagement ( MarketingEngagementInput! ) required マーケティングエンゲージメントの属性。

MarketingEngagementInput フィールド

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)
その日のビュー数の合計です。

Return fields

marketingEngagement (MarketingEngagement)
作成されたマーケティングエンゲージメントです。

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

priceRuleActivate (mutation)

価格ルールをアクティブにします。

Interactive example

これはミューテーションクエリの例です。

Query
mutation priceRuleActivate($id: ID!) {
  priceRuleActivate(id: $id) {
    priceRule {
      id
    }
    priceRuleUserErrors {
      code
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

Arguments

Argument Description
id ( ID! ) required 更新する価格ルールの ID。

Return fields

priceRule (PriceRule)
有効化された価格ルールです。

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

非推奨返却フィールド

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

priceRuleCreate (mutation)

入力を使用して価格ルールを作成します。

Interactive example

これはミューテーションクエリの例です。

Query
mutation priceRuleCreate($priceRule: PriceRuleInput!) {
  priceRuleCreate(priceRule: $priceRule) {
    priceRule {
      id
    }
    priceRuleDiscountCode {
      id
    }
    priceRuleUserErrors {
      code
      field
      message
    }
  }
}
Variables
{
  "priceRule": {}
}

Arguments

Argument Description
priceRule ( PriceRuleInput! ) required 価格ルールを作成するためのフィールドを入力します。
priceRuleDiscountCode ( PriceRuleDiscountCodeInput ) 価格ルールの割引コードを作成するためのフィールドを入力します。

PriceRuleInput 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)
価格ルールの値です。

Return fields

priceRule (PriceRule)
新しく作成された価格ルール。

priceRuleDiscountCode (PriceRuleDiscountCode)
新しく作成された割引コード。

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

非推奨の返却フィールド

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

priceRuleDeactivate (mutation)

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation priceRuleDeactivate($id: ID!) {
  priceRuleDeactivate(id: $id) {
    priceRule {
      id
    }
    priceRuleUserErrors {
      code
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

Arguments

Argument Description
id ( ID! ) required 更新する価格ルールの ID。

Return fields

priceRule (PriceRule)
解除された価格ルール。

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

非推奨返却フィールド

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

priceRuleDelete (mutation)

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation priceRuleDelete($id: ID!) {
  priceRuleDelete(id: $id) {
    deletedPriceRuleId
    priceRuleUserErrors {
      code
      field
      message
    }
    shop {
      id
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

Arguments

Argument Description
id ( ID! ) required 価格ルールオブジェクトの ID。

Return fields

deletedPriceRuleId (ID)
削除された価格ルールの ID 価格です。

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

shop (Shop!)
削除された価格ルールのショップ。

非推奨返却フィールド

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

priceRuleDiscountCodeCreate (mutation)

Interactive example

これはミューテーションクエリの例です。

Query
mutation priceRuleDiscountCodeCreate($priceRuleId: ID!, $code: String!) {
  priceRuleDiscountCodeCreate(priceRuleId: $priceRuleId, code: $code) {
    priceRule {
      id
    }
    priceRuleDiscountCode {
      id
    }
    priceRuleUserErrors {
      code
      field
      message
    }
  }
}
Variables
{
  "priceRuleId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "code": "placeholder"
}

Arguments

Argument Description
code ( String! ) required 価格ルール用に作成するコード。
priceRuleId ( ID! ) required 価格ルールオブジェクトの ID。

Return fields

priceRule (PriceRule)
更新された価格ルールです。

priceRuleDiscountCode (PriceRuleDiscountCode)
新しく作成された割引コード。

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

非推奨返却フィールド

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

priceRuleDiscountCodeUpdate (mutation)

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation priceRuleDiscountCodeUpdate($priceRuleId: ID!, $code: String!) {
  priceRuleDiscountCodeUpdate(priceRuleId: $priceRuleId, code: $code) {
    priceRule {
      id
    }
    priceRuleDiscountCode {
      id
    }
    priceRuleUserErrors {
      code
      field
      message
    }
  }
}
Variables
{
  "priceRuleId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "code": "placeholder"
}

Arguments

Argument Description
code ( String! ) required 価格ルールの新しいコード。
priceRuleId ( ID! ) required 価格ルールオブジェクトの ID。

Return fields

priceRule (PriceRule)
更新された価格ルールです。

priceRuleDiscountCode (PriceRuleDiscountCode)
更新された割引コード。

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

非推奨返却フィールド

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

priceRuleUpdate (mutation)

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

Interactive example

これはミューテーションクエリの例です。

Query
mutation priceRuleUpdate($id: ID!, $priceRule: PriceRuleInput!) {
  priceRuleUpdate(id: $id, priceRule: $priceRule) {
    priceRule {
      id
    }
    priceRuleDiscountCode {
      id
    }
    priceRuleUserErrors {
      code
      field
      message
    }
  }
}
Variables
{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "priceRule": {}
}

Arguments

Argument Description
id ( ID! ) required 更新する価格ルールの ID。
priceRule ( PriceRuleInput! ) required 価格ルールを更新するための入力フィールド。
priceRuleDiscountCode ( PriceRuleDiscountCodeInput ) 価格ルールの割引コードを更新するためのフィールドを入力します。

PriceRuleInput フィールド

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)
価格ルールの値です。

Return fields

priceRule (PriceRule)
更新された価格ルールです。

priceRuleDiscountCode (PriceRuleDiscountCode)
更新された割引コード。

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

非推奨返却フィールド

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

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

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