【Shopify.dev和訳】Storefront API/Reference/Common objects

この記事について

この記事は、Storefront API/Reference/Common objectsの記事を和訳したものです。

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

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

Overview

Common APIs

Storefront API の共通オブジェクト。

セクション項目 | In this section

• ApiVersion - API のバージョンを表します。

• Attribute - 一般的なカスタム属性を表します。

• AttributeInput - 属性に必要な入力フィールドを指定します。

• CardBrand - 決済に使用できる Visa や Mastercard などのカードブランド。

• Country - 国です。

• CountryCode - ISO 3166-1 アルファ 2 の国コード（一部異なる場合があります）。

• CropRegion - クロップした後に残すべき画像の部分です。

• Currency - 通貨です。

• CurrencyCode - 通貨コードです。

• DigitalWallet - Apple Pay などのデジタルウォレットで、チェックアウトを高速化するために使用できます。

• Domain - ウェブアドレスを表す。

• FilterGroup - 親フィールドでサポートされているフィルターのグループです。

• FilterType - このフィルターグループが表すデータの種類を示す。

• FilterValue - 特定のフィルターグループの選択可能なオプションです。

• HasMetafields - 指定されたリソースに関連するメタフィールドに関する情報を表します。

• Image - イメージリソースを表します。

• ImageContentType - サポートされているイメージコンテンツタイプのリスト。

• Localization - ショップに設定されたローカライズ体験に関する情報を表します。

• MailingAddress - 顧客および配送用の郵送先住所を表します。

• MailingAddressInput - 郵送先住所の作成または更新に使用するフィールドを指定します。

• Metafield - メタフィールドは、リソースに添付されるカスタムメタデータを表します。メタフィールドは、名前空間に分類することができ、キー、値、および値のタイプで構成されます。

• MetafieldParentResource - メタフィールドが属するリソースです。

• MetafieldValueType - メタフィールドの値のタイプ。

• MoneyInput - 通貨付きの金銭的価値のフィールドを指定します。

• MoneyV2 - 通貨を含む金銭的価値。

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

• OnlineStorePublishable - オンラインストアの販売チャネルに公開できるリソースを表します。

• QueryRoot - スキーマのクエリのエントリーポイントです。すべてのクエリが開始されなければならないパブリックなトップレベルの API として機能します。

• SEO - SEO 情報。

• UnitSystem - 重量と測定のシステム。

• WeightUnit - 重量の測定単位。

QueryRoot

スキーマのクエリのエントリーポイントです。これは、すべてのクエリの出発点となるパブリックなトップレベル API として機能します。

接続先 | Connection

articles (ArticleConnection!)
ストアの記事一覧。

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

blogs (BlogsConnection!)
ストアのブログの一覧です。

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

collections (CollectionConnection!)
ストアのコレクションの一覧です。

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

locations (LocationConnection!)
店頭でのピックアップに対応しているショップのロケーションのリストです。

距離でソートする場合は、near引数で場所を指定する必要があります。

必要なアクセス
unauthenticated_read_product_pickup_locationsのアクセススコープです。

Argument	Description
after (String)	指定されたカーソルの後にある要素を返します。
before (String)	指定されたカーソルの前にある要素を返します。
first (Int)	リストから最初の n 個の要素までを返します。
last (Int)	リストから最後の n 個の要素までを返します。
near (GeoCoordinateInput)	指定された場所に近いかどうかで結果をソートするために使用します。
reverse (Boolean)	基礎となるリストの順序を逆にします。 デフォルト値 : false
sortKey (LocationSortKeys)	基礎となるリストを、与えられたキーでソートします。 デフォルトの値 : ID

pages (PageConnection!)
ストアのページの一覧です。

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

productTags (StringConnection!)
製品にタグが追加されました。追加のアクセススコープが必要です：unauthenticated_read_product_tags

必要なアクセス
unauthenticated_read_product_tags のアクセススコープです。

Argument	Description
first (Int!) required	リストから最初の n 個の要素までを返します。

productTypes (StringConnection!)
アプリに公開されているショップの商品の商品タイプの一覧です。

必要なアクセス
unauthenticated_read_product_listingsのアクセススコープです。

Argument	Description
first (Int!) required	リストから最初の n 個の要素までを返します。

products (ProductConnection!)
ストアの商品の一覧です。

Argument	Description
after (String)	指定されたカーソルの後にある要素を返します。
before (String)	指定されたカーソルの前にある要素を返します。
first (Int)	リストから最初の n 個の要素までを返します。
last (Int)	リストから最後の n 個の要素までを返します。
query (String)	サポートされているフィルタパラメータです。 ・available_for_sale ・created_at ・product_type ・tag ・title ・updated_at ・variants.price ・vendor フィルターの使い方については、詳細な検索構文を参照してください。
reverse (Boolean)	基礎となるリストの順序を逆にします。 デフォルト値 : false
sortKey (ProductSortKeys)	基礎となるリストを、与えられたキーでソートします。 デフォルトの値 : ID

フィールド | Fields

blogByHandle (Blog)
ハンドルネームでブログを検索します。

Argument	Description
handle (String) required	ブログのハンドルです。

collectionByHandle (Collection)
そのハンドルによってコレクションを検索します。

Argument	Description
handle (String) required	コレクションのハンドルです。

customer (Customer)
アクセストークンでカスタマーを検索します。

Argument	Description
customerAccessToken (String!) required	カスタマーのアクセストークン。

localization (Localization!)
ショップに設定されたローカライズエクスペリエンスを返します。

node (Node)
特定のノードを ID で返します。

Argument	Description
id (ID!) required	返すべきノードの ID。

nodes ([Node]!)
与えられた ID を持つノードのリストを返します。

Argument	Description
ids ([ID!]!) required	返すべき Nodes の ID。

pageByHandle (Page)
ハンドルでページを検索します。

Argument	Description
handle (String!) required	ページのハンドルです。

productByHandle (Product)
ハンドルで製品を検索します。

Argument	Description
handle (String!) required	製品のハンドルです。

productRecommendations ([Product!])
与えられた product_id に関連する推奨製品を検索します。おすすめ商品がどのように生成されるかについては、Showing product recommendations on product pages を参照してください。

Argument	Description
productId (ID!) required	製品の ID。

publicApiVersions ([ApiVersion!]!)
サポートされているバージョン、リリース候補バージョン、不安定バージョンを含む、Storefront API のパブリックバージョンのリストです。

shop (Shop!)
ストアフロントのアクセストークンに関連付けられているショップです。

ApiVersion object

API のバージョンです。

フィールド | Fields

displayName (String!)
バージョンの人間が読める名前。

handle (String!)
ApiVersion の一意の識別子。サポートされているすべての API バージョンには、日付ベース（YYYY-MM）またはunstableハンドルがあります。

supported (Boolean!)
そのバージョンが Shopify によってアクティブにサポートされているかどうか。

サポートされている API バージョンは安定していることが保証されています。

サポートされていない API バージョンには、サポートされていないとマークされた不安定版、リリース候補版、終息版が含まれます。

詳しくは、バージョニングを参照してください。

ApiVersion を返す型 | Types that return ApiVersion

• QueryRoot.publicApiVersions

Attribute object

一般的なカスタム属性を表します。

フィールド | Fields

key (String!)
属性のキーまたは名前。

value (String)
属性の値を指定します。

ApiVersion を返す型 | Types that return ApiVersion

• Checkout.customAttributes
• CheckoutLineItem.customAttributes
• OrderLineItem.customAttributes

AttributeInput input object

属性に必要な入力フィールドを指定します。

入力フィールド | Input Fields

key (String!) required
属性のキーまたは名前です。

value (String!) required
属性の値です。

CardBrand enum

決済に使用できる Visa や Mastercard などのカードブランド。

値 | Values

AMERICAN_EXPRESS
American Express

DINERS_CLUB
Diners Club

DISCOVER
Discover

JCB
JCB

MASTERCARD
Mastercard

VISA
Visa

CardBrand を返す型 | Types that return CardBrand

• PaymentSettings.acceptedCardBrands

Country object

フィールド | Fields

currency (Currency!)
その国の通貨です。

isoCode (CountryCode!)
その国の ISO コード。

name (String!)
国の名前です。

unitSystem (UnitSystem!)
その国で使用されている単位系。

Country を返す型 | Types that return Country

• Localization.availableCountries
• Localization.country

CountryCode enum

ISO 3166-1 alpha-2 の国コードで、いくつかの違いがあります。

値 | Values

AC
アセンション・アイランド

AD
アンドラ

AE
アラブ首長国連邦

AF
アフガニスタン

AG
アンティグア・バーブーダ

AI
アンギラ

AL
アルバニア

AM
アルメニア

AN
オランダ領アンティル

AO
アンゴラ

AR
アルゼンチン

AT
オーストリア

AU
オーストラリア

AW
アルバ

AX
オーランド諸島

AZ
アゼルバイジャン

BA
ボスニア・ヘルツェゴビナ

BB
バルバドス

BD
バングラデシュ

BE
ベルギー

BF
ブルキナファソ

BG
ブルガリア

BH
バーレーン

BI
ブルンジ

BJ
ベナン

BL
セント・バルテルミー

BM
バミューダ

BN
ブルネイ

BO
ボリビア

BQ
カリブ海のオランダ

BR
ブラジル

BS
バハマ

BT
ブータン

BV
ブーベ島

BW
ボツワナ

BY
ベラルーシ

BZ
ベリーズ

CA
カナダ

CC
ココス（キーリング）諸島

CD
コンゴ - キンシャサ

CF
中央アフリカ共和国

CG
コンゴ - ブラザビル

CH
スイスのこと。

CI
Côte d'Ivoire.

CK
クック諸島

CL
チリ

CM
カメルーン

CN
中国

CO
コロンビア

CR
コスタ・リカ

CU
キューバ

CV
カーボベルデ

CW
キュラソー

CX
クリスマス島

CY
キプロス

CZ
チェコ共和国

DE
ドイツ

DJ
ジブチ

DK
デンマーク

DM
ドミニカ

DO
ドミニカ共和国

DZ
アルジェリア

EC
エクアドル

EE
エストニア

EG
エジプト

EH
西サハラ

ER
エリトリア

ES
スペイン

ET
エチオピア

FI
フィンランド

FJ
フィジー

FK
フォークランド諸島

FO
フェロー諸島

FR
フランスです。

GA
ガボン

GB
イギリス

GD
グレナダ

GE
ジョージア

GF
フランス領ギアナ。

GG
ガーンジー

GH
ガーナ

GI
ジブラルタル。

GL
グリーンランド

GM
ガンビア

GN
ギニア

GP
Guadeloupe（グアドループ）。

GQ
赤道ギニア。

GR
ギリシャ

GS
サウスジョージア島・南サンドイッチ諸島。

GT
グアテマラ

GW
ギニア・ビサウ

GY
ガイアナ

HK
香港特別行政区。

HM
ハード＆マクドナルド諸島

HN
ホンジュラス。

HR
クロアチア

HT
ハイチ

HU
ハンガリー

ID
インドネシア

IE
アイルランド

IL
イスラエル

IM
Isle of Man.

IN
インド

IO
イギリスのインド洋領土。

IQ
イラクのこと。

IR
イラン

IS
アイスランド

IT
イタリア

JE
ジャージー

JM
ジャマイカ

JO
ジョーダン

JP
日本

KE
ケニア

KG
Kyrgyzstan

KH
カンボジア

KI
キリバス

KM
コモロ

KN
セントキッツ・ネイビス

KP
北朝鮮

KR
南朝鮮のことです。

KW
クウェート

KY
ケイマン諸島

KZ
カザフスタン

LA
ラオス

LB
レバノン

LC
セントルシア

LI
リヒテンシュタイン

LK
スリランカ

LR
リベリア

LS
レソト

LT
リトアニア

LU
ルクセンブルク

LV
ラトビア

LY
リビア

MA
モロッコ

MC
モナコ

MD
モルドバ

ME
モンテネグロ

MF
セント・マーチン

MG
マダガスカル

MK
北マケドニア

ML
マリ

MM
ミャンマー（ビルマ）。

MN
モンゴル

MO
マカオ SAR。

MQ
マルティニーク

MR
モーリタニア

MS
Montserrat

MT
マルタ

MU
モーリシャス

MV
モルジブ

MW
マラウイ

MX
メキシコ

MY
マレーシア

MZ
モザンビーク

NA
ナミビア

NC
ニューカレドニア。

NE
ニジェール

NF
ノーフォーク島。

NG
ナイジェリア

NI
ニカラグア

NL
オランダ

NO
ノルウェー

NP
ネパール

NR
ナウル

NU
ニウエ

NZ
ニュージーランド

OM
オマーン

PA
パナマ

PE
ペルー

PF
フランス領ポリネシア

PG
パプアニューギニア

PH
フィリピンです。

PK
パキスタン

PL
ポーランド

PM
サンピエール島・ミクロン島

PN
ピトケアン諸島

PS
パレスチナ自治区。

PT
ポルトガル

PY
パラグアイ

QA
カタール

RE
レユニオン

RO
ルーマニア

RS
セルビア

RU
ロシア

RW
ルワンダ

SA
サウジアラビア

SB
ソロモン諸島

SC
セーシェル

SD
スーダン

SE
スウェーデン

SG
シンガポール

SH
St.ヘレナ

SI
スロベニア

SJ
スバールバル諸島とヤンマイエン

SK
スロバキア

SL
シエラレオネ

SM
サンマリノ

SN
セネガル

SO
ソマリア

SR
スリナム

SS
南スーダン

ST
サントメ・プリンシペ

SV
エルサルバドル

SX
シント・マールテン

SY
シリア

SZ
エスワティニ

TA
トリスタンダクーニャ

TC
タークス・カイコス諸島

TD
チャド

TF
フランス領南方地域。

TG
トーゴ

TH
タイ。

TJ
タジキスタン

TK
トケラウ

TL
東ティモール

TM
トルクメニスタン

TN
チュニジア

TO
トンガ

TR
トルコ

TT
トリニダード・トバゴ

TV
ツバル

TW
台湾

TZ
タンザニア

UA
ウクライナ

UG
ウガンダ

UM
合衆国領有小離島

US
アメリカ合衆国

UY
ウルグアイ

UZ
ウズベキスタン

VA
バチカン市国

VC
セントビンセント・グレナディーン諸島

VE
ベネズエラ

VG
英領バージン諸島

VN
ベトナム

VU
バヌアツ。

WF
ウォリス＆フツナ

WS
サモア

XK
コソボ

YE
イエメン

YT
マヨット

ZA
南アフリカ共和国

ZM
ザンビア

ZW
ジンバブエ

ZZ
未知の地域。

CountryCode を返す型 | Types that return CountryCode

• CheckoutBuyerIdentity.countryCode
• Country.isoCode
• MailingAddress.countryCodeV2
• PaymentSettings.countryCode
• Shop.shipsToCountries

CropRegion enum

クロップ（画像の切り取り）後に残すべき画像の部分。

値 | Values

BOTTOM
画像の下部を保持する。

CENTER
画像の中央を保持する。

LEFT
画像の左を保持します。

RIGHT
画像の右を保持します。

TOP
画像の上部を保持します。

Currency object

通貨です。

フィールド | Fields

isoCode (CurrencyCode!)
通貨の ISO コード。

name (String!)
通貨の名前。

symbol (String!)
通貨の記号。

Currency を返す型 | Types that return Currency

• Country.currency

CurrencyCode enum

通貨コードです。

値 | Values

AED
アラブ首長国連邦ディルハム（AED）。

AFN
アフガニスタンのアフガニ（AFN）です。

ALL
アルバニア・レク（ALL）。

AMD
アルメニア・ドラム（AMD）。

ANG
オランダ領アンティルギルダー。

AOA
アンゴラ・クワンザ（AOA）。

ARS
アルゼンチン・ペソ（ARS）。

AUD
オーストラリア・ドル（AUD）。

AWG
アルーバン・フローリン（AWG）。

AZN
アゼルバイジャン・マナト（AZN）。

BAM
ボスニア・ヘルツェゴビナ 兌換マルク （BAM）。

BBD
バルバドスドル（BBD）。

BDT
バングラデシュ・タカ（BDT）。

BGN
ブルガリア・レフ（BGN）。

BHD
バーレーン・ディナール（BHD）。

BIF
ブルンジ・フラン（BIF）。

BMD
バミューダ・ドル（BMD）。

BND
ブルネイ・ドル（BND）。

BOB
ボリビア・ボリビアーノ（BOB）。

BRL
ブラジル・レアル（BRL）。

BSD
バハマ・ドル（BSD）。

BTN
ブータンのングルトゥルム（BTN）。

BWP
ボツワナ・プラ（BWP）。

BYN
ベラルーシ・ルーブル（BYN）。

BZD
ベリーズ・ドル（BZD）。

CAD
カナダ・ドル（CAD）。

CDF
コンゴ共和国フラン（CDF）。

CHF
スイスフラン（CHF）。

CLP
チリ・ペソ（CLP）。

CNY
中国元人民元（CNY）。

COP
コロンビア・ペソ（COP）。

CRC
コスタリカ・コロネス（CRC）。

CVE
カーボベルデのエスクード（CVE）。

CZK
チェコのコルニー（CZK）。

DJF
ジブチ・フラン（DJF）。

DKK
デンマーク・クローネ（DKK）。

DOP
ドミニカ共和国ペソ（DOP）。

DZD
アルジェリア・ディナール（DZD）。

EGP
エジプト・ポンド（EGP）。

ERN
エリトリア・ナクファ（ERN）。

ETB
エチオピア・ブル（ETB）。

EUR
ユーロ（EUR）。

FJD
フィジードル（FJD）。

FKP
フォークランド諸島ポンド （FKP）。

GBP
イギリス・ポンド （GBP）。

GEL
ジョージアン・ラリ（GEL）。

GHS
ガーナ・セディ （GHS）。

GIP
ジブラルタル・ポンド（GIP）。

GMD
ガンビア・ダラシ（GMD）。

GNF
ギニア・フラン（GNF）。

GTQ
グアテマラ・ケツァル（GTQ）。

GYD
ガイアナ・ドル（GYD）。

HKD
香港ドル（HKD）。

HNL
ホンジュラス・レンピラ（HNL）。

HRK
クロアチア・クーナ（HRK）。

HTG
ハイチのグールド（HTG）。

HUF
ハンガリーフォリント（HUF）。

IDR
インドネシア・ルピア（IDR）。

ILS
イスラエルのニューシェケル（NIS）。

INR
インド・ルピー（INR）。

IQD
イラク・ディナール（IQD）。

IRR
イラン・リアル（IRR）。

ISK
アイスランド・クローネール（ISK）。

JEP
ジャージー・ポンド。

JMD
ジャマイカ・ドル（JMD）。

JOD
ヨルダン・ディナール（JOD）。

JPY
日本円（JPY）。

KES
ケニア・シリング（KES）。

KGS
キルギスのソム（KGS）。

KHR
カンボジア・リエル。

KID
キリバスドル（KID）。

KMF
コモロ・フラン（KMF）。

KRW
韓国ウォン（KRW）。

KWD
クウェートディナール（KWD）。

KYD
ケイマン・ドル（KYD）。

KZT
カザフスタンのテンゲ（KZT）。

LAK
ラオスのキップ（LAK）。

LBP
レバノン・ポンド（LBP）。

LKR
スリランカ・ルピー（LKR）。

LRD
リベリア・ドル（LRD）。

LSL
レソト・ロチ（LSL）。

LTL
リトアニア・リタイ（LTL）。

LVL
ラトビアの Lati（LVL）。

LYD
リビア・ディナール（LYD）。

MAD
モロッコ・ディルハム。

MDL
モルドバ・リュー（MDL）。

MGA
マダガスカル・アリアリ（MGA）。

MKD
マケドニア・デナル（MKD）。

MMK
ビルマ・チャット（MMK）。

MNT
モンゴルのトゥグリーク。

MOP
マカニーズ・パタカ（MOP）。

MRU
モーリタニアン・オウギヤ（MRU）。

MUR
モーリシャン・ルピー（MUR）。

MVR
モルディブ・ルフィア（MVR）。

MWK
マラウイ・クワチャ（MWK）。

MXN
メキシコペソ（MXN）。

MYR
マレーシア・リンギット（MYR）。

MZN
モザンビーク・メティカル。

NAD
ナミビア・ドル。

NGN
ナイジェリア・ナイラ（NGN）。

NIO
ニカラグアのコルドバ（NIO）。

NOK
ノルウェー・クローネ（NOK）。

NPR
ネパール・ルピー（NPR）。

NZD
ニュージーランド・ドル（NZD）。

OMR
オマーン・リアル（OMR）。

PAB
パナマ・バルボア（PAB）。

PEN
ペルーのヌエボ・ソル（PEN）。

PGK
パプアニューギニア・キナ（PGK）。

PHP
フィリピン・ペソ（PHP）。

PKR
パキスタン・ルピー（PKR）。

PLN
ポーランド・ズロチチ（PLN）。

PYG
パラグアイ・グアラニー（PYG）。

QAR
カタール・リアル（QAR）。

RON
ルーマニア・レイ（RON）。

RSD
セルビア・ディナール（RSD）。

RUB
ロシア・ルーブル（RUB）。

RWF
ルワンダ・フラン（RWF）。

SAR
サウジアラビア・リヤル（SAR）。

SBD
ソロモン諸島ドル（SBD）。

SCR
セーシェル・ルピー（SCR）。

SDG
スーダン・ポンド（SDG）。

SEK
スウェーデン・クローナ（SEK）。

SGD
シンガポール・ドル（SGD）。

SHP
セントヘレナ・ポンド（SHP）。

SLL
シエラレオネ・レオネ（SLL）。

SOS
ソマリア・シリング（SOS）。

SRD
スリナム・ドル（SRD）。

SSP
南スーダン・ポンド（SSP）。

STD
サントメ・プリンシペ・ドブラ（STD）。

SYP
シリア・ポンド（SYP）。

SZL
スワジ・リランゲニ（SZL）。

THB
タイバーツ（THB）。

TJS
タジキスタン・ソモニ（TJS）。

TMT
トルクメニスタン・マナト（TMT）。

TND
チュニジア・ディナール（TND）。

TOP
トンガのパアンガ（TOP）。

TRY
トルコリラ（TRY）。

TTD
トリニダード・トバゴ・ドル（TTD）。

TWD
台湾ドル（TWD）。

TZS
タンザニア・シリング（TZS）。

UAH
ウクライナ・フリヴニャ（UAH）。

UGX
ウガンダ・シリング (UGX)。

USD
米国ドル（USD）。

UYU
ウルグアイ・ペソ（UYU）。

UZS
ウズベキスタンソム（UZS）。

VES
ベネズエラ・ボリバル（VES）。

VND
ベトナム đồng（VND）。

VUV
バヌアツ Vatu（VUV）。

WST
サモアのターラ（WST）。

XAF
中央アフリカ CFA フラン（XAF）。

XCD
東カリブドル（XCD）。

XOF
西アフリカ CFA フラン（XOF）。

XPF
CFP フラン（XPF）。

XXX
認識されていない通貨。

YER
Yemeni Rial (YER)。

ZAR
南アフリカ・ランド（ZAR）。

ZMW
ザンビア・クワチャ（ZMW）。

BYR deprecated
ベラルーシ・ルーブル（BYR）。

非推奨の警告
BYRは推奨されません。代わりにバージョン2020-01以降のBYRをご利用ください。

VEF deprecated
ベネズエラボリバル (VEF)。

非推奨の警告
VEFは推奨されません。代わりにバージョン2020-10以降のVESをご利用ください。

CurrencyCode を返す型 | Types that return CurrencyCode

• Checkout.currencyCode
• Currency.isoCode
• MoneyV2.currencyCode
• Order.currencyCode
• PaymentSettings.currencyCode
• PaymentSettings.enabledPresentmentCurrencies

DigitalWallet enum

Apple Pay などのデジタルウォレットで、チェックアウトを加速することができます。

値 | Values

ANDROID_PAY
Android Pay です。

APPLE_PAY
Apple Pay です。

GOOGLE_PAY
Google Pay です。

SHOPIFY_PAY
Shopify Pay です。

CurrencyCode を返す型 | Types that return CurrencyCode

• PaymentSettings.supportedDigitalWallets

Domain object

Web アドレスを表します。

フィールド | Fields

host (String!)
ドメインのホスト名です（例：example.com）。

sslEnabled (Boolean!)
SSL が有効であるかどうか。

url (URL!)
ドメインの URL です（例：https://example.com）。

Domain を返す型 | Types that return Domain

• Shop.primaryDomain

FilterGroup object

親フィールドでサポートされているフィルターのグループ。

必要なアクセス
unauthenticated_read_product_listingsのアクセススコープです。

フィールド | Fields

id (String!)
一意の識別子です。

label (String!)
フィルタグループの人間に優しい文字列。

type (FilterType!)
このフィルタグループが表現するデータの種類を示す Enum です。

values ([FilterValue!]!)
このフィルタグループのオプションのリストです。

Domain を返す型 | Types that return Domain

• Product.filters

FilterType enum

フィルターグループが表すデータの種類を示す。

値 | Values

LIST
選択可能な値のリストです。

PRICE_RANGE
価格の範囲。

FilterType を返す型 | Types that return FilterType

• FilterGroup.type

FilterValue object

特定のフィルターグループに対して選択可能なオプション。

必要なアクセス
unauthenticated_read_product_listingsのアクセススコープです。

値 | Values

count (Int!)
このフィルターオプションにマッチするオブジェクトの数のカウント。

filterParams (JSON!)
このオプションを親フィールドのフィルターとして選択するために使われるパラメータ。

id (String!)
一意の識別子。

label (String!)
フィルターグループの人間に優しい文字列。

FilterValue を返す型 | Types that return FilterValue

• FilterGroup.values

HasMetafields interface

指定されたリソースに関連するメタフィールドの情報を表します。

フィールド | Fields

metafield (Metafield!)
名前空間とキーで見つかったメタフィールドを返します。

Argument	Description
key (String!) required	メタフィールドの識別子（最大 30 文字）。
namespace (String!) required	メタフィールドのセットのためのコンテナ（最大 20 文字）。

metafields (MetafieldConnection!)
リソースに関連するメタフィールドのページングされたリスト。

Argument	Description
after (String)	指定されたカーソルの後にある要素を返します。
before (String)	指定されたカーソルの前にある要素を返します。
first (Int)	リストから最初の n 個の要素までを返します。
last (Int)	リストから最後の n 個の要素までを返します。
namespace (String)	メタフィールドのセットのためのコンテナ（最大 20 文字）。
reverse (Boolean)	基礎となるリストの順序を逆にします。 デフォルトの値 : false

HasMetafields を返す型 | Types that return HasMetafields

• Article
• Blog
• Collection
• Customer
• Order
• Page
• Product
• ProductVariant
• Shop

Image object

画像リソースを表します。

フィールド | Fields

altText (String)
画像の性質や内容を共有するための単語やフレーズです。

height (Int)
画像の元の高さをピクセルで表したもの。画像が Shopify でホストされていない場合はnullを返します。

id (ID)
画像の一意の識別子。

originalSrc (URL!)
URL としてのオリジナル画像の場所。

元のソース URL に既存の変換がある場合、それらは削除されずに残ります。

transformedSrc (URL!)
変換された画像の URL です。

すべての変換引数は「ベストエフォート」とみなされます。画像に適用できるものであれば、適用されます。そうでなければ、画像タイプがサポートしていない変換は無視されます。

Argument	Description
crop (CropRegion)	指定された領域に合わせて画像をクロップする。
maxHeight (Int)	画像の高さを 1 から 5760 の間のピクセル数で指定します。
maxWidth (Int)	画像の幅を 1 から 5760 の間のピクセル数で指定します。
preferredContentType (ImageContentType)	画像のコンテンツタイプへの最適な変換（SVG -> PNG, Anything -> JGP, Anything -> WEBP をサポート）。
scale (Int)	高解像度の Retina ディスプレイ用の画像サイズの倍率。1 から 3 の間でなければなりません。 デフォルト値：1

width (Int)
画像の元の幅をピクセル単位で指定します。画像が Shopify でホストされていない場合はnullを返します。

Image を返す型 | Types that return Image

• Article.image
• Collection.image
• ExternalVideo.previewImage
• MediaImage.image
• MediaImage.previewImage
• Model3d.previewImage
• Product.images
• ProductVariant.image
• Video.previewImage

非推奨フィールド | Deprecated fields

• src (URL!) deprecated
  画像の位置を URL で指定します。

非推奨の警告

これまでの画像は、srcフィールドを 1 つ持っていました。これは、元の画像の位置を返すか、サイズやスケールなどの変換を含む URL を返すかのいずれかでした。

これらの変換は、親フィールドの引数で指定されていました。

現在、画像には、originalSrcとtransformedSrcという 2 つの異なる URL フィールドがあります。

• originalSrc - 修正されていないオリジナルの画像 URL
• transformedSrc - 指定された変換を含む画像の URL です。
  新しいフィールドに移行するには、画像の変換を親フィールドからtransformedSrcに移動する必要があります。

以前 :

{
  shop {
    productImages(maxWidth: 200, scale: 2) {
      edges {
        node {
          src
        }
      }
    }
  }
}

現在 :

{
  shop {
    productImages {
      edges {
        node {
          transformedSrc(maxWidth: 200, scale: 2)
        }
      }
    }
  }
}

ImageContentType enum

対応している画像コンテンツタイプの一覧です。

Values

JPG
JPG 画像です。

PNG
PNG 画像です。

WEBP
WEBP 画像です。

Localization object

ショップに設定されているローカライズエクスペリエンスに関する情報です。

フィールド | Fields

availableCountries ([Country!]!)
局所的発現が有効な国のリスト

country (Country!)
局所的発現が有効な国。この値を変更するには @inContext ディレクティブを使用します。

Image を返す型 | Types that return Image

• QueryRoot.localization

MailingAddress object

顧客や配送用の郵送先住所を表します。

フィールド | Fields

address1 (String)
住所の 1 行目。一般的には、番地や私書箱の番号です。

address2 (String)
住所の 2 行目。典型的には、アパート、スイート、またはユニットの番号です。

city (String)
市、区、村、または町の名前。

company (String)
顧客の会社や組織の名前。

country (String)
国の名前を指定します。

countryCodeV2 (CountryCode)
住所の国を表す 2 文字のコードです。

例えば、US です。

firstName (String)
お客様のファーストネームです。

formatted ([String!]!)
与えられた引数によってカスタマイズされた、住所のフォーマットされたバージョン。

Argument	Description
withCompany Boolean	フォーマットされたアドレスに顧客の会社を含めるかどうか。 デフォルト値 : true
withName Boolean	フォーマットされたアドレスに顧客の名前を含めるかどうか。 デフォルト値 : false

formattedArea (String)
city、province、country の値をカンマで区切ったリスト。

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

lastName (String)
顧客のラストネーム。

latitude (Float)
顧客の住所の緯度座標。

longitude (Float)
顧客の住所の経度座標。

name (String)
firstName と lastName に基づく、顧客のフルネーム。

phone (String)
顧客のユニークな電話番号。

E.164 規格に基づいてフォーマットされています。

例えば、[phone] です。

province (String)
県、州、地区などの住所の地域名。

provinceCode (String)
地域を表す 2 文字のコードです。

例えば、ON です。

zip (String)
住所の郵便番号を指定します。

Image を返す型 | Types that return Image

• Checkout.shippingAddress
• Customer.addresses
• Customer.defaultAddress
• Order.shippingAddress
• Payment.billingAddress

実装 | Implements

• Node

非推奨フィールド | Deprecated fields

• countryCode (String) deprecated
  住所の国を表す 2 文字のコード。
  例えば、US です。

非推奨の警告
代わりにcountryCodeV2を使用してください。

MailingAddressInput input object

郵送物の作成や更新の際に受け付けるフィールドを指定します。

入力フィールド | Input fields

address1 (String)
住所の 1 行目。一般的には、住所や私書箱の番号です。

address2 (String)
住所の 2 行目。典型的には、アパート、スイート、またはユニットの番号です。

city (String)
市、区、村、または町の名前。

company (String)
顧客の会社や組織の名前。

country (String)
国の名前を指定します。

firstName (String)
顧客のファーストネーム。

lastName (String)
顧客のラストネーム。

phone (String)
顧客のユニークな電話番号。

E.164 規格に基づいてフォーマットされています。例えば、[phone] です。

province (String)
県、州、地区などの住所の地域名。

zip (String)
住所の郵便番号を指定します。

Metafield object

メタフィールドは、リソースに付加されたカスタムメタデータを表します。メタフィールドは、名前空間でソートすることができ、キー、値、値のタイプで構成されます。

フィールド | Fields

createdAt (DateTime!)
ストアフロントのメタフィールドが作成された日付と時間。

description (String)
メタフィールドの説明です。

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

key (String!)
メタフィールドのキー名です。

namespace (String!)
メタフィールドの名前空間です。

parentResource (MetafieldParentResource!)
メタフィールドが属する親オブジェクトです。

type (String!)
メタフィールドの型名です。サポートされる型のリストを参照してください。

updatedAt (DateTime!)
ストアフロントのメタフィールドが更新された日付と時間です。

value (String!)
メタフィールドの値です。

Metafield を返す型 | Types that return Metafield

• Article.metafield
• Article.metafields
• Blog.metafield
• Blog.metafields
• Collection.metafield
• Collection.metafields
• Customer.metafield
• Customer.metafields
• Order.metafield
• Order.metafields
• Page.metafield
• Page.metafields
• Product.metafield
• Product.metafields
• ProductVariant.metafield
• ProductVariant.metafields
• Shop.metafield
• Shop.metafields

実装 | Implements

• Node

非推奨フィールド | Deprecated fields

• valueType (MetafieldValueType!) deprecated
  メタフィールドの値のタイプを表します。

非推奨の警告
valueTypeは非推奨で、API バージョン 2021-07 ではtypeに置き換えられています。

MetafieldParentResource union

メタフィールドが属するリソース。

可能な型 | Possible types

• Article
• Blog
• Collection
• Customer
• Order
• Page
• Product
• ProductVariant
• Shop

MetafieldValueType enum

メタフィールドの値の種類。

値 | Values

INTEGER
整数のメタフィールドです。

JSON_STRING
json 文字列のメタフィールドです。

STRING
文字列のメタフィールドです。

MoneyInput input object

通貨を使った金額のフィールドを指定します。

入力フィールド | Input fields

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

currencyCode (CurrencyCode!) required
お金の通貨です。

MoneyV2 object

通貨を使った金銭的価値。

フィールド | Fields

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

currencyCode (CurrencyCode!)
お金の通貨。

MoneyV2 を返す型 | Types that return MoneyV2

• AppliedGiftCard.amountUsedV2
• AppliedGiftCard.balanceV2
• AppliedGiftCard.presentmentAmountUsed
• Checkout.lineItemsSubtotalPrice
• Checkout.paymentDueV2
• Checkout.subtotalPriceV2
• Checkout.totalDuties
• Checkout.totalPriceV2
• Checkout.totalTaxV2
• CheckoutLineItem.unitPrice
• DiscountAllocation.allocatedAmount
• Order.currentSubtotalPrice
• Order.currentTotalDuties
• Order.currentTotalPrice
• Order.currentTotalTax
• Order.originalTotalDuties
• Order.originalTotalPrice
• Order.subtotalPriceV2
• Order.totalPriceV2
• Order.totalRefundedV2
• Order.totalShippingPriceV2
• Order.totalTaxV2
• OrderLineItem.discountedTotalPrice
• OrderLineItem.originalTotalPrice
• Payment.amountV2
• ProductPriceRange.maxVariantPrice
• ProductPriceRange.minVariantPrice
• ProductVariant.compareAtPriceV2
• ProductVariant.priceV2
• ProductVariant.unitPrice
• ProductVariantPricePair.compareAtPrice
• ProductVariantPricePair.price
• SellingPlanAllocationPriceAdjustment.compareAtPrice
• SellingPlanAllocationPriceAdjustment.perDeliveryPrice
• SellingPlanAllocationPriceAdjustment.price
• SellingPlanAllocationPriceAdjustment.unitPrice
• SellingPlanFixedAmountPriceAdjustment.adjustmentAmount
• SellingPlanFixedPriceAdjustment.price
• ShippingRate.priceV2
• Transaction.amountV2

Node interface

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

フィールド | Fields

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

Node を返す型 | Types that return Node

• AppliedGiftCard
• Article
• Blog
• Checkout
• CheckoutLineItem
• Collection
• Comment
• ExternalVideo
• Location
• MailingAddress
• MediaImage
• Metafield
• Model3d
• Order
• Page
• Payment
• Product
• ProductOption
• ProductVariant
• ShopPolicy
• Video

OnlineStorePublishable interface

オンラインストアの販売チャネルに公開できるリソースを表します。

フィールド | Fields

onlineStoreUrl (URL)
ショップのオンラインストアでリソースを表示するための URL です。リソースが現在オンラインストアの販売チャネルに公開されていない場合は、NULL となります。

OnlineStorePublishable を返す型 | Types that return OnlineStorePublishable

• Article
• Blog
• Collection
• Page
• Product

SEO object

SEO 情報です。

必要なアクセス
コンテンツや商品リストへのアクセスが必要です。

フィールド | Fields

description (String)
メタ記述。

title (String)
SEO のタイトル。

SEO を返す型 | Types that return SEO

• Article.seo
• Blog.seo
• Page.seo
• Product.seo

UnitSystem enum

重量と測定のシステム。

値 | Value

IMPERIAL_SYSTEM
帝国の重量と尺度のシステム。

METRIC_SYSTEM
度量衡のメートル法。

UnitSystem を返す型 | Types that return UnitSystem

• Country.unitSystem

WeightUnit enum

重量の測定単位。

値 | Value

GRAMS
質量を表すメートル法の単位。

KILOGRAMS
1 キログラムは 1000 グラムに相当します。

OUNCES
インペリアル方式の質量の単位。

POUNDS
1 ポンドは 16 オンスです。

UnitSystem を返す型 | Types that return UnitSystem

• ProductVariant.weightUnit

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