マニュアル・利用規約

データ項目とShopifyAPI(GraphQL)の対比表

現在のGraphQLのバージョンは「2024-04」となります。

商品データ

商品データのGraphQLは下記URLをご確認ください。出力内容はGraphQLの値に準拠し、内容に関してのご説明にはお答えしかねますのでご了承ください。
https://shopify.dev/docs/api/admin-graphql/2024-04/objects/Product

グループ 項目名(和名) ShopifyAPI(GraphQL) 具体的な値 説明
基本 商品ハンドル product/handle 半袖ベーシックtシャツ ハンドル名は商品ごとに固有の名前です。ハンドル名は各商品のURLで使用されます。
商品ID product/id 10368404422974 商品のIDです。内部で保持している商品IDとなります。
商品タイトル product/title 半袖ベーシックTシャツ 商品のタイトルです。
商品説明 product/description 半袖ベーシックTシャツです。 商品説明(HTML)からHTML除外した商品の説明です。
商品説明(HTML) product/descriptionHtml <b>半袖ベーシックTシャツです。</> HTML形式での商品の説明です。
ベンダー product/vendor A社 商品の販売元の名前です。
商品タイプ product/productType Cult Products 商品のタイプを示すラベルです。アメリカで商品の税率を計算するために使用されます。
商品タグ product/tags トップス, Tシャツ 商品にタグ付けされた情報です。
ステータス product/status active 顧客が商品を購入できるかどうかを示します。
カテゴリ名(FULL) product/category/fullName ペット用品 > 犬用品 > 犬用ベッド 製品分類の完全な名前です。たとえば、動物、ペット用品 > ペット用品 > 犬用品 > 犬用ベッドなど。
カテゴリID product/category/id 123 製品分類の IDです。
カテゴリ名 product/category/name 犬用ベッド 製品分類の名前です。
作成日時 product/createdAt 2023-10-23 13:30:33 商品を登録した日時です。
更新日時 product/updatedAt 2023-11-09 17:18:46 商品を更新した日時です。
公開日時 product/publishedAt 2023-10-23 13:30:33 商品が公開された日時です。
商品URL product/onlineStoreUrl https://example.com/products/半袖シャツ 商品ページのURLです。
商品テンプレート product/templateSuffix special 商品ページに使用されるテンプレートです。
在庫数 product/totalInventory 748 在庫の総量です。
バリエーション数 product/variantsCount/count 13 バリエーションの数です。
メディア数 product/mediaCount/count 2 商品に属するメディアの総数。
在庫追跡 product/tracksInventory true 商品の在庫追跡が有効になっているかどうかを示します。
ギフトカードテンプレート product/giftCardTemplateSuffix ストアでギフトカードを表示するときに使用されるテーマテンプレートです。
在庫切れバリエーション有無 product/hasOutOfStockVariants true 商品に在庫切れのバリエーションがあるかどうか示します。
ギフトカード product/isGiftCard false 商品がギフトカードであるかどうかを示します。
最大価格 product/priceRangeV2/maxVariantPrice/amount 1500 小数点形式の価格を含む製品の価格範囲。最も高いバリエーションの価格です。
最小価格 product/priceRangeV2/minVariantPrice/amount 1000 小数点形式の価格を含む製品の価格範囲。最も低いバリエーションの価格です。
先頭行 true アイテムの先頭行の場合、TRUEがセットされます。
画像 [img]行番号 1 画像の行番号です。
[img]ID product/images/id 850703190 画像のIDです。
[img]URL product/images/url http://example.com/main.jpg 画像のURLです。
[img]Altテキスト product/images/altText 半袖ベーシックTシャツ 画像の代替テキストです。
[img]高さ product/images/height 140 画像の高さです。
[img]幅 product/images/width 110 画像の幅です。
バリエーション
在庫
[var]ID product/variants/id 47602678169918 商品またはバリエーションのIDです。
[var]タイトル product/variants/title 半袖ベーシックTシャツ 白 商品またはバリエーションのタイトルです。
[var]行番号 product/variants/position 1 バリエーションの行番号です。
[var]inventoryID product/variants/inventoryItem/id 49643288723774 グローバルインベントリアイテムの識別子です。これは、Shopify が多くの場所にまたがる在庫アイテムを識別する新しい方法です。
[var]表示名 product/variants/displayName テスト商品 – マルチカラー バリエーションの表示名です。
[var]オプション product/variants/selectedOptions 色: マルチカラー 「オプションの名前:オプションの値」で表示されます。
[var]SKU product/variants/sku 100010101 商品またはバリエーションのSKUです。
[var]価格 product/variants/price 1000 商品またはバリエーションの価格です。
[var]割引前価格 product/variants/compareAtPrice 1200 商品またはバリエーションの「割引前価格」です。
[var]IMG_URL product/variants/image/url http://example.com/white.jpg バリエーションの画像のURLです。
[var]バーコード product/variants/barcode B00010101 商品またはバリエーションのバーコード、ISBN、またはUPCです。
[var]税コード product/variants/taxCode DA040000 商品またはバリエーションの税コードです。
[var]課税対象 product/variants/taxable TRUE このバリエーションに税を適用するかを示します。
[var]在庫数 product/variants/inventoryQuantity 10 商品またはバリエーションの在庫にあるアイテム数です。
[var]在庫なし対応 product/variants/inventoryPolicy deny 商品またはバリエーションの在庫レベルが0に達した場合の注文の処理方法です。
在庫ポリシーが設定されたバリエーションは、その在庫レベルが0に達した後は購入できなくなります。
在庫ポリシーが設定されたバリエーションは、その在庫レベルが0に達した後も購入でき、負の在庫レベルが許容されます。
[var]配送必要 product/variants/inventoryItem/requiresShipping true 配送が必要かどうかを示します。
[var]登録日時 product/variants/createdAt 2023-10-23 13:30:33 商品またはバリエーションの作成日時です。
[var]更新日時 product/variants/updatedAt 2023-11-09 17:18:46 商品またはバリエーションの更新日時です。
コレクション [col]ハンドル product/collections/handle トップス, tシャツ スマートコレクションのハンドル名です。
メタフィールド メタフィールド product/metafields newvalue 商品のメタフィールドの値です。

顧客データ

顧客データのGraphQLは下記URLをご確認ください。出力内容はGraphQLの値に準拠し、内容に関してのご説明にはお答えしかねますのでご了承ください。
https://shopify.dev/docs/api/admin-graphql/2024-04/objects/Customer

グループ 項目名(和名) ShopifyAPI(GraphQL) 具体的な値 説明
基本 顧客ID customer/id 207119551 顧客番号です。
氏名 customer/displayName 太郎 山田 顧客の氏名です。氏名(苗字)と氏名(名前)が使用できない場合は、顧客の電子メール アドレスが使用され、それが使用できない場合は顧客の電話番号が使用されます。
氏名(名前) customer/firstName 太郎 顧客の名前です。
氏名(苗字) customer/lastName 山田 顧客の苗字です。
Email customer/email test@dot-color.co.jp 顧客のメールアドレスです。
電話番号 customer/phone 5052359073 顧客の電話番号です。
タグ customer/tags 優良顧客 顧客のタグ情報です。カンマ区切りで設定されます。
顧客メモ customer/note 黒が好み 顧客に関する追加情報です。
ステート customer/state ENABLED 顧客が有効かどうかを示します。
作成日時 customer/createdAt 2023-10-08 18:00:25 顧客情報の作成日時です。
更新日時 customer/updatedAt 2023-11-08 18:00:25 顧客情報の更新日時です。
Emailマーケ同意 customer/emailMarketingConsent/marketingState SUBSCRIBED メールマーケティングに同意しているかを示します。
Emailマーケオプトイン customer/emailMarketingConsent/marketingOptInLevel SINGLE_OPT_IN M3AAWG 送信者のベスト コモン プラクティスに記載されているマーケティング サブスクリプションのオプトイン レベルです。
Emailマーケ更新日時 customer/emailMarketingConsent/consentUpdatedAt 2023-11-08 18:00:25 メールマーケティングの同意に関する更新日時です。
SMSマーケ同意 customer/smsMarketingConsent/marketingState SUBSCRIBED SMSマーケティングに同意しているかを示します。
SMSマーケオプトイン customer/smsMarketingConsent/marketingOptInLevel SINGLE_OPT_IN M3AAWG 送信者のベスト コモン プラクティスに記載されているマーケティング サブスクリプションのオプトイン レベル。
SMSマーケ更新日時 customer/smsMarketingConsent/consentUpdatedAt 2023-11-08 18:00:25 SMSマーケティングの同意に関する更新日時です。
SMSマーケ情報源 customer/smsMarketingConsent/consentCollectedFrom SHOPIFY SMSマーケティングに同意したかどうかの情報源です。
削除可否 customer/canDelete false 販売者がストアから顧客を削除できるかどうかを示します。
非課税 customer/taxExempt false 顧客が非課税かどうかを示します。
地域 customer/locale ja-JP 顧客の地域です。
マルチパス識別子 customer/multipassIdentifier マルチパス ログインで使用される顧客の一意の識別子です。
メール解除URL customer/unsubscribeUrl https://xx.myshopify.com/account/unsubscribe?token=xx 顧客をメルマガリストから登録解除するための URLです。
メールアドレス正否 customer/validEmailAddress true メール アドレスの形式が正しいかどうかを示します。
メールアドレス認証 customer/verifiedEmail true 顧客がメールアドレスを認証したかどうかを示します。
デフォルト住所録 [住所]ID customer/defaultAddress/id 207119551 住所のIDです。
[住所]氏名 customer/defaultAddress/name 太郎 山田 氏名です。
[住所]氏名(名前) customer/defaultAddress/firstName 太郎 氏名(名前)です。
[住所]氏名(苗字) customer/defaultAddress/lastName 山田 氏名(苗字)です。
[住所]電話番号 customer/defaultAddress/phone 5052359073 電話番号です。
[住所]会社名 customer/defaultAddress/company ドットカラー 会社名です。
[住所]住所1 customer/defaultAddress/address1 北幸1-11-1 住所(1行目)です。
[住所]住所2 customer/defaultAddress/address2 水信ビル7階 住所(2行目)です。
[住所]市区町村 customer/defaultAddress/city 横浜市西区 市区町村です。
[住所]都道府県 customer/defaultAddress/province Kanagawa 都道府県です。
[住所]国 customer/defaultAddress/country Japan 国名です。
[住所]郵便番号 customer/defaultAddress/zip 2200004 郵便番号です。
[住所]都道府県コード customer/defaultAddress/provinceCode JP-14 都道府県コードです。
[住所]国コード customer/defaultAddress/countryCodeV2 JP 国コードです。
[住所]タイムゾーン customer/defaultAddress/timeZone Asia/Tokyo タイムゾーンです。
[住所]緯度 customer/defaultAddress/latitude 35.46774 緯度座標です。
[住所]経度 customer/defaultAddress/longitude 139.6182749 経度座標です。
住所録 [住所録]ID customer/addresses/id 207119552 住所のIDです。
[住所録]氏名 customer/addresses/name 一郎 佐藤 氏名です。
[住所録]氏名(名前) customer/addresses/firstName 佐藤 氏名(名前)です。
[住所録]氏名(苗字) customer/addresses/lastName 一郎 氏名(苗字)です。
[住所録]電話番号 customer/addresses/phone 5052359073 電話番号です。
[住所録]会社名 customer/addresses/company null 会社名です。
[住所録]住所1 customer/addresses/address1 北幸1-11-2 住所(1行目)です。
[住所録]住所2 customer/addresses/address2 ABCビル 住所(2行目)です。
[住所録]市区町村 customer/addresses/city 横浜市西区 市区町村です。
[住所録]都道府県 customer/addresses/province 神奈川県 都道府県です。
[住所録]国 customer/addresses/country Japan 国名です。
[住所録]郵便番号 customer/addresses/zip 2200004 郵便番号です。
[住所録]都道府県コード customer/addresses/provinceCode JP-14 都道府県コードです。
[住所録]国コード customer/addresses/countryCodeV2 81 国コードです。
[住所録]タイムゾーン customer/addresses/timeZone Asia/Tokyo タイムゾーンです。
[住所録]緯度 customer/addresses/latitude 35.46774 緯度座標です。
[住所録]経度 customer/addresses/longitude 139.6182749 経度座標です。
注文情報 合計購入金額 customer/amountSpent/amount 69090 総支払金額です。
合計注文数 customer/numberOfOrders 3 総注文数です。
継続期間 customer/lifetimeDuration over 17 years 顧客の継続期間です。
最終注文ID customer/lastOrder/id 6046740054334 最後の注文IDです。
最終注文名 customer/lastOrder/name #1004 ストア管理画面に表示される最後の注文番号です。
最終注文処理日時 customer/lastOrder/createdAt 2023-11-08 18:00:23 最後の注文が処理された日時です。
最終注文金額 customer/lastOrder/totalPriceSet/presentmentMoney/amount 3424 表示通貨での最後の注文合計額です。
メタフィールド メタフィールド customer/metafields newvalue メタフィールドの値です。

注文データ

注文データのGraphQLは下記URLをご確認ください。出力内容はGraphQLの値に準拠し、内容に関してのご説明にはお答えしかねますのでご了承ください。
https://shopify.dev/docs/api/admin-graphql/2024-04/objects/Order

グループ 項目名(和名) ShopifyAPI(GraphQL) 具体的な値 説明
基本 注文ID order/id 5599217615166 注文IDです。
注文番号 order/name #1001 ストア管理画面に表示される注文番号です。
Email order/email test@dot-color.co.jp 顧客のメールアドレスです。
電話番号 order/phone 5052359073 顧客の電話番号です。
注文メモ order/note 一部返金済み 注文時のメモです。
タグ order/tags 返金 注文に関連付けられたタグです。
注文日時 order/createdAt 2023-11-08 18:00:24 顧客による注文が完了した日時です。
注文更新日時 order/updatedAt 2023-12-22 13:44:52 注文を更新した日時です。
キャンセル日時 order/cancelledAt 2023-12-22 13:44:52 注文がキャンセルされた日時です。
キャンセル理由 order/cancelReason 間違えて注文 注文がキャンセルされた理由です。
注文処理日時 order/processedAt 2023-11-08 18:00:23 注文が処理された日時です。 この値は注文に表示され、分析レポートで使用される日付です。
処理完了日時 order/closedAt 2023-11-08 18:00:24 注文処理が完了された日時です。
注文クローズ order/closed false 注文がクローズされているかどうかを示します。。
通貨コード order/currencyCode JPY 基本通貨です。
免税 order/taxExempt false 注文で税金が免除されるかどうかを示します。
税込 order/taxesIncluded false 注文の小計に税金が含まれるかどうかを示します。
返金可否 order/refundable false 注文が返金可能かどうかを示します。
3rdParty識別子 order/sourceIdentifier 9129c561d033ce4b1b1dbf170150f5fa 以前のプラットフォームで行われた注文の IDです。
現在合計金額 order/currentTotalPriceSet/presentmentMoney/amount 10780 返品後の【現在】合計金額です 。この金額には税金と割引が含まれます。
現在小計金額 order/currentSubtotalPriceSet/presentmentMoney/amount 9800 【現在】小計金額です。このフィールドの値は、注文の編集、返品、返金を反映しています。
現在税額 order/currentTotalTaxSet/presentmentMoney/amount 980 【現在】税額合計です。このフィールドの値は、注文の編集、返品、または返金を反映しています。
現在関税額 order/currentTotalDutiesSet/presentmentMoney/amount 0 【現在】関税額です。関税が適用されない場合は null を返します。
現在注文割引額 order/currentCartDiscountAmountSet/presentmentMoney/amount 0 すべての注文が更新された後の【現在】の注文の割引額です。
現在割引総額 order/currentTotalDiscountsSet/presentmentMoney/amount 0 注文の【現在】の割引総額です。このフィールドの値は、注文の編集、返品、返金を反映しています。
現在追加料金 order/currentTotalAdditionalFeesSet/presentmentMoney/amount 0 返品後の【現在】追加料金の総額です。注文に追加料金がない場合は null を返します。
現在数量合計 order/currentSubtotalLineItemsQuantity 4 注文の【現在】の商品数量合計です。
現在総重量 order/currentTotalWeight 200 返品後の【現在】注文の合計重量 (グラム単位)です。
合計金額 order/totalPriceSet/presentmentMoney/amount 11880 商品価格、割引、配送料、税金、およびショップ通貨でのチップの合計金額です。
小計金額 order/subtotalPriceSet/presentmentMoney/amount 10800 割引後、配送料、関税、税金、チップ前の注文金額です。
税額 order/totalTaxSet/presentmentMoney/amount 1080 注文の税額合計です。
割引額 order/totalDiscountsSet/presentmentMoney/amount 0 返品前​​の注文で割引された合計金額です。これには、注文レベルと明細レベルの割引の両方が含まれます。
配送料 order/totalShippingPriceSet/presentmentMoney/amount 0 割引および返品前の合計配送料です。
未取引額 order/totalOutstandingSet/presentmentMoney/amount 0 注文に対してまだ取引されていない合計金額です。
正の値は顧客から販売者への支払いを示し、負の値は販売者から顧客への払い戻しを示します。
受取額 order/totalReceivedSet/presentmentMoney/amount 11880 返品前​​に顧客から受け取った合計金額です。
返金額 order/totalRefundedSet/presentmentMoney/amount 1100 返金された合計金額です。
送料返金額 order/totalRefundedShippingSet/presentmentMoney/amount 0 返金された送料の合計金額です。
数量合計 order/subtotalLineItemsQuantity 5 商品数量合計です。
総重量 order/totalWeight 2300 商品の総重量 (グラム単位)です。
表示用支払ステータス order/displayFinancialStatus PARTIALLY_REFUNDED 販売者に表示できる注文の財務状況です。
このフィールドは、注文の財務状態の詳細をすべて取得するわけではありません。概要を表示する目的のみに使用してください。
表示用フルフィルステータス order/displayFulfillmentStatus FULFILLED 販売者に表示できる注文の履行ステータスです。
このフィールドは、注文の履行状態の詳細をすべて取得するわけではありません。概要を表示する目的のみに使用してください。
クライアントIP order/clientip 111.2.11.1 オーダーを作成した API クライアントの IP アドレスです。
発注書番号 order/poNumber 1352356 発注書番号です。
テスト order/test false 注文がテストであるかどうかを示します。
請求先 [請求先]ID order/billingAddress/id 207119552 請求先のIDです。
[請求先]氏名 order/billingAddress/name 一郎 佐藤 氏名です。
[請求先]氏名(名前) order/billingAddress/firstName 佐藤 氏名(名前)です。
[請求先]氏名(苗字) order/billingAddress/lastName 一郎 氏名(苗字)です。
[請求先]電話番号 order/billingAddress/phone 5052359073 電話番号です。
[請求先]会社名 order/billingAddress/company null 会社名です。
[請求先]住所1 order/billingAddress/address1 北幸1-11-2 住所(1行目)です。
[請求先]住所2 order/billingAddress/address2 ABCビル 住所(2行目)です。
[請求先]市区町村 order/billingAddress/city 横浜市西区 市区町村です。
[請求先]都道府県 order/billingAddress/province 神奈川県 都道府県です。
[請求先]国 order/billingAddress/country Japan 国名です。
[請求先]郵便番号 order/billingAddress/zip 2200004 郵便番号です。
[請求先]都道府県コード order/billingAddress/provinceCode JP-14 都道府県コードです。
[請求先]国コード order/billingAddress/countryCodeV2 81 国コードです。
[請求先]タイムゾーン order/billingAddress/timeZone Asia/Tokyo タイムゾーンです。
[請求先]緯度 order/billingAddress/latitude 35.46774 緯度座標です。
[請求先]経度 order/billingAddress/longitude 139.6182749 経度座標です。
配送先 [配送先]ID order/shippingAddress/id 207119552 配送先のIDです。
[配送先]氏名 order/shippingAddress/name 一郎 佐藤 氏名です。
[配送先]氏名(名前) order/shippingAddress/firstName 佐藤 氏名(名前)です。
[配送先]氏名(苗字) order/shippingAddress/lastName 一郎 氏名(苗字)です。
[配送先]電話番号 order/shippingAddress/phone 5052359073 電話番号です。
[配送先]会社名 order/shippingAddress/company null 会社名です。
[配送先]住所1 order/shippingAddress/address1 北幸1-11-2 住所(1行目)です。
[配送先]住所2 order/shippingAddress/address2 ABCビル 住所(2行目)です。
[配送先]市区町村 order/shippingAddress/city 横浜市西区 市区町村です。
[配送先]都道府県 order/shippingAddress/province 神奈川県 都道府県です。
[配送先]国 order/shippingAddress/country Japan 国名です。
[配送先]郵便番号 order/shippingAddress/zip 2200004 郵便番号です。
[配送先]都道府県コード order/shippingAddress/provinceCode JP-14 都道府県コードです。
[配送先]国コード order/shippingAddress/countryCodeV2 81 国コードです。
[配送先]タイムゾーン order/shippingAddress/timeZone Asia/Tokyo タイムゾーンです。
[配送先]緯度 order/shippingAddress/latitude 35.46774 緯度座標です。
[配送先]経度 order/shippingAddress/longitude 139.6182749 経度座標です。
顧客 [顧客]ID order/customer/id 207119551 顧客番号です。
[顧客]氏名 order/customer/displayName 太郎 山田 顧客の氏名です。氏名(苗字)と氏名(名前)が使用できない場合は、顧客の電子メール アドレスが使用され、それが使用できない場合は顧客の電話番号が使用されます。
[顧客]氏名(名前) order/customer/firstName 太郎 顧客の名前です。
[顧客]氏名(苗字) order/customer/lastName 山田 顧客の苗字です。
[顧客]Email order/customer/emal test@dot-color.co.jp 顧客のメールアドレスです。
[顧客]電話番号 order/customer/phone 5052359073 顧客の電話番号です。
[顧客]タグ order/customer/tags 優良顧客 顧客のタグ情報です。カンマ区切りで設定されます。
[顧客]メモ order/customer/note 黒が好み 顧客に関する追加情報です。
[顧客]ステート order/customer/state ENABLED 顧客が有効かどうかを示します。
[顧客]生涯購入金額 order/customer/amountSpent/amount 150356 総支払金額です。
[顧客]生涯注文数 order/customer/numberOfOrders 45 総注文数です。
[顧客]継続期間 order/customer/lifetimeDuration over 17 years 顧客の継続期間です。
[顧客]作成日時 order/customer/createdAt 2023-11-08 18:00:24 顧客情報の作成日時です。
[顧客]更新日時 order/customer/updatedAt 2023-11-08 18:00:24 顧客情報の更新日時です。
注文明細 [明細]ID order/lineitems/id 14245019746622 注文明細のIDです。
[明細]商品ID order/lineitems/product/id 10370977628478 商品のIDです。内部で保持している商品IDとなります。
[明細]商品ハンドル order/lineitems/product/hundle トレンチコート ハンドル名は商品ごとに固有の名前です。ハンドル名は各商品のURLで使用されます。
[明細]商品タイトル order/lineitems/title トレンチコート 商品のタイトルです。
[明細]商品名 order/lineitems/name トレンチコート – M 商品の名称です。
[明細]SKU order/lineitems/sku 100210102 商品またはバリエーションのSKUです。
[明細]ベンダー order/lineitems/vendor DOT-COLOR 商品の販売元の名前です。
[明細]販売価格 order/lineitems/originalTotalSet/presentmentMoney/amount 35000 商品またはバリエーションの価格です。
[明細]割引額合計 order/lineitems/totalDiscountSet/presentmentMoney/amount 0 商品またはバリエーションに適用された割引金額の合計です。
[明細]割引後価格 order/lineitems/discountTotalSet/presentmentMoney/amount 35000 割引適用後の合計明細価格です。
[明細]数量 order/lineitems/quantity 1 商品またはバリエーションの購入数です。
[明細]バリエーションID order/lineitems/variant/id 47604550172990 商品またはバリエーションのIDです。
[明細]バリエーション名 order/lineitems/variant/title M 商品またはバリエーションのタイトルです。
[明細]配送対象商品 order/lineitems/requiresShipping ture 配送が必要な注文かどうかを示します。
[明細]課税対象 order/lineitems/taxable ture 課税対象かどうかを示します。
メタフィールド メタフィールド order/metafields newvalue 注文のメタフィールドの値です。