📈

【Shopify.dev和訳】Admin API/GraphQL reference Common Objects④

2021/10/01に公開

GraphQL

API

Shopify

tech

この記事について

この記事は、Admin API/GraphQL reference Common Objects4の記事を和訳したものです。

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

Shopify アプリのご紹介

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

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

Common APIs

Common Admin API objects の続きです。

`MoneyV2` (`object`)

貨幣による金銭的価値。

Fields

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

currencyCode (CurrencyCode!)
お金の通貨。

`MoneyV2` を返すタイプ

`MutationsStagedUploadTargetGenerateUploadParameter` (`object`)

アセットを Shopify にアップロードするための署名入りアップロードパラメータです。

Fields

name (String!)
アップロードパラメータ名。

value (String!)
アップロードパラメータの値

`Navigable` (`interface`)

クエリで結果をページングするために使用できるデフォルトのカーソルです。コネクション内の各エッジは、コネクション内のエッジの位置への参照であるカーソルを返すことができます。エッジのカーソルを起点にして、接続内のそのエッジの前後のノードを検索することができます。

カーソルベースのページネーションの詳細については、「GraphQL で結果をページネーションする」を参照してください。

Fields

defaultCursor (String!)
ID で昇順にソートされた単一の次のレコードを返すデフォルトのカーソル。

`Navigable` を実装するタイプ

`Node` (`interface`)

グローバルな識別をサポートするための ID を持つオブジェクト。

Fields

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

`Node`実装するタイプ

`paymentAuthorizationSettingsUpdate` (`mutation`)

ショップの支払い承認設定を更新します。

query

mutation paymentAuthorizationSettingsUpdate($processingMethod: PaymentProcessingMethod!) {
  paymentAuthorizationSettingsUpdate(processingMethod: $processingMethod) {
    paymentAuthorizationSettings {
      id
    }
    userErrors {
      field
      message
    }
  }
}

引数

引数	説明
`enableExpiryNotifications` ( `Boolean` )	認証の有効期限が近い場合、メール通知を有効にします。
`processingMethod` ( `PaymentProcessingMethod!` ) `required`	支払いの処理方法です。

返却フィールド

paymentAuthorizationSettings（PaymentAuthorizationSettings)
支払い認証の設定です。

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

`paymentsAppConfigure` (`mutation`)

パートナーが管理するゲートウェイをマーチャントのストアに設定します。

例

mutation query の実行例を示す。

query

mutation paymentsAppConfigure($ready: Boolean!) {
  paymentsAppConfigure(ready: $ready) {
    paymentsAppConfiguration {
      externalHandle
      ready
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "ready": true
}

引数

引数	説明
`externalHandle` ( `String` )	外部システムで使用されるハンドル。
`ready` ( `Boolean!` ) `required`	プロバイダがマーチャントの支払いを処理する準備ができていることを示します。

返却フィールド

paymentsAppConfiguration（PaymentsAppConfiguration )
ペイメントアプリの本番環境設定です。

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

`PaymentSchedule` (`object`)

支払い条件で定義された 1 回の支払いに対する支払いスケジュールを表します。

FIelds

amount (MoneyV2!)
この支払いスケジュールの支払い額。

completedAt (DateTime)
支払いスケジュールが支払われた、または履行された日時。

dueAt（DateTime )
支払いスケジュールが期限切れとなる日時。

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

issuedAt (DateTime)
請求書が送信された日時。

`PaymentSchedule` を返すタイプ

PaymentTerms.paymentSchedules

Implements

Node

`PaymentScheduleInput` (`input` `object`)

支払条件の支払いスケジュールを作成する際に使用する入力フィールドです。

入力フィールド

dueAt（DateTime )
支払い予定日の日時を指定します。このフィールドは、固定タイプの支払条件の場合に提供する必要があります。

issuedAt (DateTime)
支払予定表が発行された日時を指定します。このフィールドは、ネットタイプの支払い条件の場合に提供する必要があります。

`PaymentTerms` (`object`)

注文やドラフトオーダーの支払い条件を表します。

Connections

paymentSchedules (PaymentScheduleConnection)
支払期間のスケジュールのリスト

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

Fields

dueInDays (Int)
支払条件の作成に使用された支払条件テンプレートに基づく、支払条件の期間（日数）。

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

overdue（Boolena!)
支払い条件に期限切れの支払いスケジュールがあるかどうか。

paymentTermsName（String! )
支払い条件の作成に使用された支払い条件テンプレートの名前。

paymentTermsType（PaymentTermsType! )
支払い条件の作成に使用された支払い条件テンプレートのタイプです。

translatedName（String! )
翻訳された支払条件名。

`PaymentTerms`を返すタイプ

Implements

Node

`paymentTermsCreate` (`mutation`)

支払い条件の作成

例

mutation query の実行例を示す。

query

mutation paymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
  paymentTermsCreate(
    referenceId: $referenceId
    paymentTermsAttributes: $paymentTermsAttributes
  ) {
    paymentTerms {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "referenceId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "paymentTermsAttributes": {
    "paymentTermsTemplateId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
  }
}

引数

引数	説明
`paymentTermsAttributes` ( `PaymentTermsCreateInput!` ) `required`	支払い条件の作成に使用される属性です。
`referenceId` ( `ID!` ) `required`	支払い条件を追加する参照を指定します。

`PaymentTermsCreateInput`fields

paymentSchedules ([PaymentScheduleInput!])
支払条件の支払スケジュールを指定します。

paymentTermsTemplateId (ID!) required
支払条件の生成に使用される支払条件テンプレート ID を指定します。

返却フィールド

paymentTerms（PaymentTerms )
作成された支払条件です。

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

`PaymentTermsCreateInput` (`input` `object`)

支払条件を作成するための入力フィールドです。

入力フィールド

paymentSchedules ([PaymentScheduleInput!])
支払条件の支払スケジュールを指定します。

paymentTermsTemplateId (ID!) required
支払条件の生成に使用される支払条件テンプレート ID を指定します。

`paymentTermsDelete` (`mutation`)

支払い条件の削除

例

mutation query の実行例を示す。

query

mutation paymentTermsDelete($input: PaymentTermsDeleteInput!) {
  paymentTermsDelete(input: $input) {
    deletedId
    userErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "input": {
    "paymentTermsId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
  }
}

引数

引数	説明
`input` ( `PaymentTermsDeleteInput!` ) `required`	支払い条件の削除に使用される入力フィールドです。

`PaymentTermsDeleteInput`fields

paymentTermsId (ID!) required
削除される支払い条件の ID です。

返却フィールド

deletedId (ID)
削除された支払条件の ID です。

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

`PaymentTermsDeleteInput` (`input` `object`)

支払い条件の削除に使用する入力フィールドです。

入力フィールド

paymentTermsId (ID!) required
削除される支払い条件の ID です。

`PaymentTermsInput` (`input` `object`)

支払い条件を作成するための入力フィールドです。

入力フィールド

paymentSchedules ([PaymentScheduleInput!])
支払条件の支払スケジュールを指定します。

paymentTermsTemplateId (ID)
支払条件の生成に使用される支払条件テンプレート ID を指定します。

`PaymentTermsTemplate` (`object`)

支払条件テンプレートオブジェクトを表します。

Fields

description (String!)
支払条件テンプレートの説明です。

dueInDays (Int)
ネットタイプの支払条件の場合、発行日から支払日までの日数。

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

name (String!)
支払い条件テンプレートの名前。

paymentTermsType（PaymentTermsType! )
支払い条件テンプレートのタイプ。

translatedName（String! )
翻訳された支払条件テンプレートの名前です。

`PaymentTermsType` (`enum`)

支払条件または支払条件テンプレートのタイプです。

Values

FIXED
支払条件または支払条件テンプレートは固定タイプです。

NET
支払条件または支払条件テンプレートはネットタイプです。

RECEIPT*
支払条件または支払条件テンプレートの支払期限は受領時です。

UNKNOWN
支払条件または支払条件テンプレートのタイプは不明です。

PaymentTermsType を返す型

`paymentTermsUpdate` (`mutation`)

支払い条件の更新。

例

mutation query の実行例を示す。

query

mutation paymentTermsUpdate($input: PaymentTermsUpdateInput!) {
  paymentTermsUpdate(input: $input) {
    paymentTerms {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "input": {
    "paymentTermsId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
    "paymentTermsAttributes": {}
  }
}

引数

引数	説明
`input` ( `PaymentTermsUpdateInput!` ) `required`	支払い条件を更新するために使用する入力フィールドです。

`PaymentTermsUpdateInput`フィールド

paymentTermsAttributes (PaymentTermsInput!) required
支払条件の更新に使用される属性です。

paymentTermsId (ID!) required
更新される支払条件の ID です。

返却フィールド

paymentTerms (PaymentTerms)
更新された支払条件です。

userErrors ([PaymentTermsUpdateUserError!]!)
mutation を実行した際に発生したエラーのリスト。

`PaymentTermsUpdateInput` (`input` `object`)

支払い条件を更新するための入力フィールドです。

入力フィールド

paymentTermsAttributes (PaymentTermsInput!) required
支払条件の更新に使用される属性です。

paymentTermsId (ID!) required
更新される支払条件の ID です。

`pubSubWebhookSubscriptionCreate` (`mutation`)

新しい Google Cloud Pub/Sub Webhook サブスクリプションを作成します。

例

mutation query の実行例を示す。

query

mutation pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {
  pubSubWebhookSubscriptionCreate(
    topic: $topic
    webhookSubscription: $webhookSubscription
  ) {
    userErrors {
      code
      field
      message
    }
    webhookSubscription {
      id
    }
  }
}

Variables

{
  "topic": "placeholder",
  "webhookSubscription": {
    "pubSubProject": "placeholder",
    "pubSubTopic": "placeholder"
  }
}

引数

引数	説明
`topic` ( `WebhookSubscriptionTopic!` ) `required`	Webhook をトリガするイベントのタイプです。
`webhookSubscription` ( `PubSubWebhookSubscriptionInput!` ) `required`	Google Cloud Pub/Sub Webhook サブスクリプションの入力フィールドを指定します。

`PubSubWebhookSubscriptionInput`フィールド

format (WebhookSubscriptionFormat)
Webhook サブスクリプションがデータを送信する際のフォーマットです。

includeFields ([String!])
Webhook サブスクリプションに含めるフィールドのリストです。

metafieldNamespaces ([String!])
webhook サブスクリプションに含まれるべき任意のメタフィールドの名前空間のリストです。

pubSubProject (String!) required
PUB/SUB のプロジェクト ID です。

pubSubTopic (String!) required
Pub/Sub のトピック ID。

返却フィールド

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

webhookSubscription (WebhookSubscription)
作成された Webhook サブスクリプションです。

`PubSubWebhookSubscriptionInput` (`input` `object`)

PubSub Webhook サブスクリプションの入力フィールドを指定します。

入力フィールド

format（WebhookSubscriptionFormat)
Webhook サブスクリプションがデータを送信する際のフォーマットです。

includeFields ([String!])
Webhook サブスクリプションに含まれるフィールドのリストです。

metafieldNamespaces ([String!])
webhook サブスクリプションに含まれるべき任意のメタフィールドの名前空間のリストです。

pubSubProject (String!) required
PUB/SUB のプロジェクト ID です。

pubSubTopic (String!) required
Pub/Sub のトピック ID。

`pubSubWebhookSubscriptionUpdate` (`mutation`)

Google Cloud Pub/Sub Webhook サブスクリプションを更新します。

例

mutation query の実行例を示す。

query

mutation pubSubWebhookSubscriptionUpdate($id: ID!) {
  pubSubWebhookSubscriptionUpdate(id: $id) {
    userErrors {
      code
      field
      message
    }
    webhookSubscription {
      id
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数	説明
`id` ( `ID!` ) `required`	更新する Webhook サブスクリプションの ID です。
`webhookSubscription` ( `PubSubWebhookSubscriptionInput` )	Google Cloud Pub/Sub Webhook サブスクリプションの入力フィールドを指定します。

`PubSubWebhookSubscriptionInput`フィールド

format (WebhookSubscriptionFormat)
Webhook サブスクリプションがデータを送信する際のフォーマットです。

includeFields ([String!])
Webhook サブスクリプションに含めるフィールドのリストです。

metafieldNamespaces ([String!])
webhook サブスクリプションに含まれるべき任意のメタフィールドの名前空間のリストです。

pubSubProject (String!) required
PUB/SUB のプロジェクト ID です。

pubSubTopic (String!) required
Pub/Sub のトピック ID。

返却フィールド

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

webhookSubscription (WebhookSubscription)
更新された Webhook サブスクリプションです。

`SavedSearch` (`object`)

保存された検索は、管理者に保存された検索クエリを表現したものです。

Fields

filters ([SearchFilter!]!)
保存された検索のフィルタ。

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

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

name (String!)
保存された検索の名前。

query (String!)
保存された検索のクエリ文字列。これには検索用語やフィルターが含まれます。

resourceType (SearchResultType!)
この保存された検索が検索するリソースのタイプです。

searchTerms (String!)
保存された検索の検索語句。

`SavedSearch`を返すタイプ

`SavedSearch`の mutation

savedSearchCreate
保存された検索結果を作成します。

savedSearchDelete
保存された検索結果を削除します。

savedSearchUpdate
保存された検索結果を更新します。

Implements

例

query

# 注文時に保存された検索結果のうち、最初の10件のIDを取得する
{
  orderSavedSearches(first:10) {
    edges {
      node {
        id
      }
    }
  }
}

response

{
  "data": {
    "orderSavedSearches": {
      "edges": [
        {
          "node": {
            "id": "gid://shopify/SavedSearch/555078877206"
          }
        },
        {
          "node": {
            "id": "gid://shopify/SavedSearch/555078909974"
          }
        },
        {
          "node": {
            "id": "gid://shopify/SavedSearch/555078942742"
          }
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 12,
      "actualQueryCost": 5,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 995,
        "restoreRate": 50
      }
    }
  }
}

`savedSearchCreate` (`mutation`)

保存された検索結果を作成します。

例

mutation query の実行例です。

query

mutation savedSearchCreate($input: SavedSearchCreateInput!) {
  savedSearchCreate(input: $input) {
    savedSearch {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": {
    "resourceType": "placeholder",
    "name": "placeholder",
    "query": "placeholder"
  }
}

引数

引数	説明
`input` ( `SavedSearchCreateInput!` ) `required`	保存された検索の入力フィールドを指定します。

`SavedSearchCreateInput` fields

name (String!) required
保存された検索の説明的な名前。

query (String!) required
保存された検索のクエリ文字列。これには検索語句とフィルターが含まれます。

resourceType (SearchResultType!) required
この保存された検索が検索するリソースのタイプです。

返却フィールド

savedSearch (SavedSearch)
作成された保存された検索です。

userErrors ([UserError!]!)
mutation を実行した際に発生したエラーのリスト。

`SavedSearchCreateInput` (`input` `object`)

保存された検索の作成に必要なフィールドを指定します。

入力フィールド

name (String!) required
保存された検索の説明的な名前。

query (String!) required
保存された検索のクエリ文字列。これには検索語句とフィルターが含まれます。

resourceType (SearchResultType!) required
この保存された検索が検索するリソースのタイプです。

`savedSearchDelete` (`mutation`)

保存した検索結果を削除する。

例

mutation query の実行例を示す。

query

mutation savedSearchDelete($input: SavedSearchDeleteInput!) {
  savedSearchDelete(input: $input) {
    deletedSavedSearchId
    shop {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": {
    "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
  }
}

引数

引数	説明
`input` ( `SavedSearchDeleteInput!` ) `required`	保存された検索を削除するための入力フィールドです。

`SavedSearchDeleteInput`フィールド

id (ID!) required
削除する保存された検索の ID。

返却フィールド

deletedSavedSearchId (ID)
削除された保存された検索の ID です。

shop (Shop!)
削除された検索結果のショップです。

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

`SavedSearchDeleteInput`

保存された検索を削除するフィールドを指定します。

入力フィールド

id (ID!) required
削除する保存された検索の ID です。

`savedSearchUpdate` (`mutation`)

保存した検索結果を更新する。

例

mutation query の実行例です。

query

mutation savedSearchUpdate($input: SavedSearchUpdateInput!) {
  savedSearchUpdate(input: $input) {
    savedSearch {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": {
    "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
  }
}

引数

引数	説明
`input` ( `SavedSearchUpdateInput!` ) `required`	保存された検索を更新するための入力フィールドです。

`SavedSearchUpdateInput` fields

id (ID!) required
更新する保存された検索の ID。

name (String)
保存された検索の説明的な名前。

query (String)
保存された検索のクエリ文字列。これには検索用語やフィルターが含まれる。

返却フィールド

savedSearch (SavedSearch)
更新された保存された検索です。

userErrors ([UserError!]!)
mutation を実行した際に発生したエラーのリストです。

`SavedSearchUpdateInput` (`input` `object`)

保存した検索結果を更新するために必要なフィールドを指定します。

入力フィールド

id (ID!) required
更新する保存された検索の ID。

name (String)
保存された検索の説明的な名前。

query (String)
保存された検索のクエリ文字列。これには検索用語やフィルターが含まれる。

`SearchFilter` (`object`)

キーと値のペアで表現される検索クエリのフィルタです。

Fields

key (String!)
検索フィルターのキーです。

value (String!)
検索フィルターの値です。

`SearchFilter`を返すタイプ

SavedSearch.filters

`SearchFilterOptions` (`object`)

検索フィルターのリストと、フィルタリングのための特定のオプション（value と label のペア）です。

Fields

productAvailability ([FilterOption!]!)
商品の在庫状況をフィルタリングするために使用できるオプションのリストです。

`SearchFilterOptions` を返すタイプ

Shop.searchFilters

`SearchResult` (`object`)

検索から返された個々の結果を表す。

Fields

description (String)
検索結果の説明テキストを返します。

image (Image)
検索結果に付随して提示される Image リソースを返します。

reference (Node!)
検索結果で返されたリソースの ID を返します。

title (String!)
リソースのタイトルを返します。

url (URL!)
検索結果のリソースへの絶対的な URL を返します。

`SearchResult`を返すタイプ

Shop.search

`SearchResultType` (`enum`)

検索結果として返されるリソースのタイプを指定します。

Values

COLLECTION
CUSTOMER
DISCUNT_REDEEM_CODE
割引引き換えコードです。

DRAFT_ORDER
FILE
ファイルです。

ONLINE_STORE_ARTICLE
ONLINE_STORE_BLOG
ONLINE_STORE_PAGE
ORDER
PRICE_RULE
PRODUCT
URL_REDIRECT
URL リダイレクトです。

SearchResultType を返す型

SavedSearch.resourceType

`StagedUploadHttpMethodType` (`enum`)

ステージドアップロードの対象となる HTTP メソッド。

Values

POST
HTTP POST メソッド

PUT
HTTP PUT メソッド

`StagedUploadInput` (`input` `object`)

アップロードされるメディア

入力フィールド

fileSize (UnsignedInt64)
アップロードするファイルのサイズをバイト単位で指定します。VIDEO や MODEL_3D のリソースにはrequiredです。

filename (String!) required
メディアのファイル名。

httpMethod (StagedUploadHttpMethodType)
ステージドアップロードで使用する HTTP メソッド。

mimeType（String!) required
メディアの MIME タイプ。

resource (StagedUploadTargetGenerateUploadResource!) required
メディアのリソース。

`StagedUploadParameter` (`object`)

メディアのアップロードパラメータです。

Fields

name (String!)
パラメータ名です。

value (String!)
パラメータの値を指定します。

`StagedUploadParameter`を返すタイプ

StagedMediaUploadTarget.parameters

`stagedUploadsCreate` (`mutation`)

各入力に対してステージングされたアップロードターゲットの URL を作成し、アップロードプロセスの最初のステップとなります。返された URL 付きのアップロードターゲットは、ファイルをアップロードするためのエンドポイントとして使用できます。

例

mutation query の実行例を示す。

query

mutation stagedUploadsCreate($input: [StagedUploadInput!]!) {
  stagedUploadsCreate(input: $input) {
    stagedTargets {
      resourceUrl
      url
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": [
    {
      "resource": "placeholder",
      "filename": "placeholder",
      "mimeType": "placeholder"
    }
  ]
}

引数

引数	説明
`input` ( `[StagedUploadInput!]!` ) `required`	mutation の入力には、ステージドアップロードターゲットの生成に必要な情報が含まれます。

`StagedUploadInput` fields

fileSize (UnsignedInt64)
アップロードするファイルのサイズをバイト単位で指定します。VIDEO;やMODEL_3Dのリソースにはrequiredです。

filename (String!) required
メディアのファイル名。

httpMethod (StagedUploadHttpMethodType)
ステージドアップロードで使用する HTTP メソッド。

mimeType（String!) required
メディアの MIME タイプ。

resource (StagedUploadTargetGenerateUploadResource!) required
メディアのリソース。

返却フィールド

stagedTargets ([StagedMediaUploadTarget!])
生成されたステージドアップロードターゲットです。

userErrors ([UserError!]!)
mutation を実行した際に発生したエラーのリスト。

`StagedUploadTarget` (`object`)

ステージングされたターゲット情報

FIelds

parameters ([ImageUploadParameter!]!)
アップロードされる画像のパラメータ。

url (String!)
画像の URL。

`stagedUploadTargetGenerate` (`mutation`)

アセットを Shopify にアップロードするために必要な URL と署名入りのパラメタを生成します。

例

mutation query の実行例を示す。

query

mutation stagedUploadTargetGenerate($input: StagedUploadTargetGenerateInput!) {
  stagedUploadTargetGenerate(input: $input) {
    parameters {
      name
      value
    }
    url
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": {
    "resource": "placeholder",
    "filename": "placeholder",
    "mimeType": "placeholder"
  }
}

引数

| 引数｜説明 |
| :---------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------- |
| input ( StagedUploadTargetGenerateInput! ) required | ステージドアップロードを生成するための入力フィールドです。 |

`StagedUploadTargetGenerateInput`fields

fileSize (UnsignedInt64)
アップロードするファイルのサイズをバイト単位で指定します。

filename (String!) required
アップロードするアセットのファイル名です。

httpMethod (StagedUploadHttpMethodType)
ステージドアップロードで使用する HTTP メソッドです。

mimeType (String!) required
アップロードされるアセットの MIME タイプです。

resource (StagedUploadTargetGenerateUploadResource!) required
アップロードされるリソースタイプです。

返却フィールド

parameters ([MutationstageduledouletTargetGenerateUploadParameter!]!)
アセットをアップロードする際に使用できる署名入りのパラメータです。

url (String!)
アセットをアップロードできる署名入りの URL。

userErrors ([UserError!]!)
mutaion を実行した際に発生したエラーのリスト。

`StagedUploadTargetGenerateInput` (`input` `object`)

アセットを Shopify にアップロードするために必要な URL とパラメータを生成するために必要なフィールドを指定します。

入力フィールド

fileSize (UnsignedInt64)
アップロードするファイルのサイズをバイト単位で指定します。

filename (String!) required
アップロードするアセットのファイル名です。

httpMethod (StagedUploadHttpMethodType)

ステージドアップロードで使用する HTTP メソッドです。

mimeType (String!) required
アップロードされるアセットの MIME タイプです。

resource (StagedUploadTargetGenerateUploadResource!) required
アップロードされるリソースタイプです。

`StagedUploadTargetGenerateUploadResource` (`enum`)

受信するリソースタイプです。

Values

BULK_MUTATION_VARIABLES
BulkOperation のリソース表現。

COLLECTION_IMAGE
コレクション画像。

FILE
Merchandising::GenericFile リソース表現。

IMAGE
Merchandising::Image リソース表現

MODEL_3D
Merchandising::Model3d リソース表現。

PRODUCT_IMAGE
商品画像

SHOP_IMAGE
ショップのイメージ

TIMELINE
タイムラインイベントです。

URL_REDIRECT_IMPORT
リダイレクトインポートのリソース表現

VIDEO
Merchandising::Videoリソースの表現です。

`stagedUploadTargetsGenerate` (`mutation`)

例

mutation query の実行例を示す。

query

mutation stagedUploadTargetsGenerate($input: [StageImageInput!]!) {
  stagedUploadTargetsGenerate(input: $input) {
    urls {
      url
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": [
    {
      "resource": "placeholder",
      "filename": "placeholder",
      "mimeType": "placeholder"
    }
  ]
}

引数

引数	説明
`input` ( `[StageImageInput!]!` ) `required`	ステージドアップロードを生成するための入力フィールドです。

`StageImageInput` fields

filename (String!) required
画像のファイル名。

httpMethod (StagedUploadHttpMethodType)
ステージドアップロードで使用する HTTP メソッドです。

mimeType（String!) required
画像の MIME タイプ

resource (StagedUploadTargetGenerateUploadResource!) required
画像のリソース。

返却フィールド

urls ([StagedUploadTarget!])
生成されたステージドアップロードターゲットです。

userErrors ([UserError!]!)
mutation を実行した際に発生したエラーのリスト。

`StageImageInput` (`input` `object`)

アップロードされる画像

入力フィールド

filename (String!) required
画像のファイル名。

httpMethod (StagedUploadHttpMethodType)
ステージドアップロードで使用する HTTP メソッドです。

mimeType（String!) required
画像の MIME タイプ

resource (StagedUploadTargetGenerateUploadResource!) required
画像のリソース。

`standardMetafieldDefinitionEnable` (`mutation`)

指定された標準メタフィールドの定義を有効にします。

例

mutation query の実行例を示す。

query

mutation standardMetafieldDefinitionEnable($id: ID!, $ownerType: MetafieldOwnerType!, $pin: Boolean!) {
  standardMetafieldDefinitionEnable(id: $id, ownerType: $ownerType, pin: $pin) {
    createdDefinition {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "ownerType": "placeholder",
  "pin": true
}

引数

引数	説明
`id` ( `ID!` ) `required`	有効にする標準的なメタフィールド定義テンプレートの ID です。
`ownerType` ( `MetafieldOwnerType!` ) `required`	メタフィールド定義がスコープされているリソースタイプです。
`pin` ( `Boolean!` ) `required`	メタフィールド定義を固定するかどうか。デフォルト値：`false`

返却フィールド

createdDefinition (MetafieldDefinition)
作成されたメタフィールド定義です。

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

`StandardMetafieldDefinitionTemplate` (`object`)

標準のメタフィールド定義テンプレートは、メタフィールド定義のためのプリセット設定を提供します。

Fileds

description (String)
標準のメタフィールド定義テンプレートの説明です。

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

key (String!)
標準メタフィールド定義テンプレートのキー名です。

name (String!)
標準のメタフィールド定義テンプレートの名前です。

namespace (String!)
標準的なメタフィールド定義テンプレートの名前空間です。

ownerTypes ([MetafieldOwnerType!]!)
標準定義テンプレートが適用可能なリソースタイプのリストです。

type (MetafieldDefinitionType!)
関連するメタフィールド定義タイプです。

validations ([MetafieldDefinitionValidation!]!)
標準のメタフィールド定義テンプレートに設定されたバリデーションです。

`StandardMetafieldDefinitionTemplate`を返すタイプ

Implements

Node

`tagsAdd` (`mutation`)

注文、注文の下書き、顧客、商品、オンラインストアの記事にタグを追加することができます。

例

mutation query の実行例を示す。

query

mutation tagsAdd($id: ID!, $tags: [String!]!) {
  tagsAdd(id: $id, tags: $tags) {
    node {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "tags": [
    "placeholder"
  ]
}

引数

引数	説明
`id` ( `ID!` ) `required`	タグを追加するリソースの ID です。
`tags` ( `[String!]!` ) `required`	タグのリスト。配列またはカンマで区切られたリストになります。値の例 : `["tag1", "tag2", "tag3"]`, `"tag1, tag2, tag3"`.

返却フィールド

node (Node)
更新されたオブジェクトです。

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

`tagsRemove` (`mutation`)

タグ付け可能なオブジェクトからタグを削除します。

例

mutation query の実行例を示す。

query

mutation tagsRemove($id: ID!, $tags: [String!]!) {
  tagsRemove(id: $id, tags: $tags) {
    node {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "tags": [
    "placeholder"
  ]
}

引数

引数	説明
`id` ( `ID!` ) `required`	タグを削除するリソースの ID です。
`tags` ( `[String!]!` ) `required`	リソースから削除するタグのリスト。値の例 `["tag1", "tag2", "tag3"]`.

返却フィールド

node (Node)
更新されたオブジェクト。

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

Shopify アプリのご紹介

Discussion

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

この記事について

Shopify アプリのご紹介

Common APIs

MoneyV2 (object)

Fields

MoneyV2 を返すタイプ

MutationsStagedUploadTargetGenerateUploadParameter (object)

Fields

Navigable (interface)

Fields

Navigable を実装するタイプ

Node (interface)

Fields

Node実装するタイプ

paymentAuthorizationSettingsUpdate (mutation)

引数

返却フィールド

paymentsAppConfigure (mutation)

例

引数

返却フィールド

PaymentSchedule (object)

FIelds

PaymentSchedule を返すタイプ

Implements

PaymentScheduleInput (input object)

入力フィールド

PaymentTerms (object)

Connections

Fields

PaymentTermsを返すタイプ

Implements

paymentTermsCreate (mutation)

例

引数

PaymentTermsCreateInputfields

返却フィールド

PaymentTermsCreateInput (input object)

入力フィールド

paymentTermsDelete (mutation)

例

引数

PaymentTermsDeleteInputfields

返却フィールド

PaymentTermsDeleteInput (input object)

入力フィールド

PaymentTermsInput (input object)

入力フィールド

PaymentTermsTemplate (object)

Fields

PaymentTermsType (enum)

Values

PaymentTermsType を返す型

paymentTermsUpdate (mutation)

例

引数

PaymentTermsUpdateInputフィールド

返却フィールド

PaymentTermsUpdateInput (input object)

入力フィールド

pubSubWebhookSubscriptionCreate (mutation)

例

引数

PubSubWebhookSubscriptionInputフィールド

返却フィールド

PubSubWebhookSubscriptionInput (input object)

入力フィールド

pubSubWebhookSubscriptionUpdate (mutation)

例

引数

PubSubWebhookSubscriptionInputフィールド

返却フィールド

SavedSearch (object)

Fields

SavedSearchを返すタイプ

SavedSearchの mutation

Implements

例

savedSearchCreate (mutation)

例

`MoneyV2` (`object`)

`MoneyV2` を返すタイプ

`MutationsStagedUploadTargetGenerateUploadParameter` (`object`)

`Navigable` (`interface`)

`Navigable` を実装するタイプ

`Node` (`interface`)

`Node`実装するタイプ

`paymentAuthorizationSettingsUpdate` (`mutation`)

`paymentsAppConfigure` (`mutation`)

`PaymentSchedule` (`object`)

`PaymentSchedule` を返すタイプ

`PaymentScheduleInput` (`input` `object`)

`PaymentTerms` (`object`)

`PaymentTerms`を返すタイプ

`paymentTermsCreate` (`mutation`)

`PaymentTermsCreateInput`fields

`PaymentTermsCreateInput` (`input` `object`)

`paymentTermsDelete` (`mutation`)

`PaymentTermsDeleteInput`fields

`PaymentTermsDeleteInput` (`input` `object`)

`PaymentTermsInput` (`input` `object`)

`PaymentTermsTemplate` (`object`)

`PaymentTermsType` (`enum`)

`paymentTermsUpdate` (`mutation`)

`PaymentTermsUpdateInput`フィールド

`PaymentTermsUpdateInput` (`input` `object`)

`pubSubWebhookSubscriptionCreate` (`mutation`)

`PubSubWebhookSubscriptionInput`フィールド

`PubSubWebhookSubscriptionInput` (`input` `object`)

`pubSubWebhookSubscriptionUpdate` (`mutation`)

`PubSubWebhookSubscriptionInput`フィールド

`SavedSearch` (`object`)

`SavedSearch`を返すタイプ

`SavedSearch`の mutation

`savedSearchCreate` (`mutation`)

`SavedSearchCreateInput` fields

`SavedSearchCreateInput` (`input` `object`)

`savedSearchDelete` (`mutation`)

`SavedSearchDeleteInput`フィールド

`SavedSearchDeleteInput`

`savedSearchUpdate` (`mutation`)

`SavedSearchUpdateInput` fields

`SavedSearchUpdateInput` (`input` `object`)

`SearchFilter` (`object`)

`SearchFilter`を返すタイプ

`SearchFilterOptions` (`object`)

`SearchFilterOptions` を返すタイプ

`SearchResult` (`object`)

`SearchResult`を返すタイプ

`SearchResultType` (`enum`)

`StagedUploadHttpMethodType` (`enum`)

`StagedUploadInput` (`input` `object`)

`StagedUploadParameter` (`object`)

`StagedUploadParameter`を返すタイプ

`stagedUploadsCreate` (`mutation`)

`StagedUploadInput` fields

`StagedUploadTarget` (`object`)

`stagedUploadTargetGenerate` (`mutation`)

`StagedUploadTargetGenerateInput`fields

`StagedUploadTargetGenerateInput` (`input` `object`)

`StagedUploadTargetGenerateUploadResource` (`enum`)

`stagedUploadTargetsGenerate` (`mutation`)

`StageImageInput` fields

`StageImageInput` (`input` `object`)

`standardMetafieldDefinitionEnable` (`mutation`)

`StandardMetafieldDefinitionTemplate` (`object`)

`StandardMetafieldDefinitionTemplate`を返すタイプ