📈

【Shopify.dev和訳】Admin API/GraphQL reference/Store properties①

2021/10/02に公開約59,600字

この記事について

この記事は、Admin API/Graph QL reference/Store propertiesの記事を和訳したものです。

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

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

Store properties APIs (OBJECTS 前半)

オンラインストアのプロパティやポリシーを更新する。

このセクションには以下の内容が含まれています

OBJECT

CurrencyFormats (object)

通貨フォーマット。

フィールド

moneyFormat (FormattedString!)
通貨なしの HTML。

moneyInEmailsFormat (String!)
通貨を含まない電子メール。

moneyWithCurrencyFormat (FormattedString!)
通貨付きの HTML。

moneyWithCurrencyInEmailsFormat (String!)
通貨付きの電子メール。

CurrencyFormats の返却型

EmailSenderConfiguration (object)

ショップのメール送信者の設定を表す。

フィールド

senderDomainDnsRecords ([EmailSenderConfigurationDnsRecord!]!)
現在の送信者ドメインに対してマーチャントが設定する必要のある DNS レコード。

EmailSenderConfiguration の返却型

EmailSenderConfigurationDnsRecord (object)

ショップのメール送信者の設定に必要な DNS レコードを表します。

フィールド

name (String!)
DNS レコードのホスト名です。

type (String!)
DNS レコードのタイプ。

valueString!)
DNS レコードの値を指定します。

EmailSenderConfigurationDnsRecord の返却型

FilterOption (object)

フィルターオプションは、検索フィルターで使用可能な値の一つです。

フィールド

label (String!)
表示用のフィルターオプションのラベルです。

valueString!)
フィルターオプションの値。

FilterOption の返却型

LimitedPendingOrderCount (object)

ショップの保留オーダーの総数が最大値より少ない場合、またはその最大値を示します。atMax フィールドは、この最大値に達したときに表示されます。

フィールド

atMax (Boolean!)
保留中の注文数が最大値に達した場合に設定されます。

count (Int!)
ショップの保留中の注文数。最大 10000 件までに制限されます。

LimitedPendingOrderCount の返却型

Location (object)

物理的な商品が存在する場所を表します。

Connections

inventoryLevels (InventoryLevelConnection!)
ロケーションにストックされている在庫アイテムの在庫レベルのページングされたリスト。

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

フィールド

activatable (Boolean!)
このロケーションが再活性化できるかどうか。

address (LocationAddress!)
ロケーションの LocationAddress オブジェクト。

addressVerified (Boolean!)
ロケーションのアドレスが検証されているかどうか。

deactivatable(Boolean!)
このロケーションが非アクティブにできるかどうか。

deactivatedAt (String)
位置情報が非活性化された日時(位置情報がまだ活性化されている場合は null)。UTC ISO8601 形式に従います、例えば "2019-04-24T13:42:24Z".

deletable (Boolean!)
このロケーションが削除可能かどうか。

fulfillmentService (FulfillmentService)
このロケーションからフルフィルメントを行うサービスプロバイダーの名前。

fulfillsOnlineOrders (Boolean!)
このロケーションがオンライン注文を処理できるかどうかを示します。

hasActiveInventory (Boolean!)
このロケーションがアクティブな在庫を持っているかどうかを示します。

hasUnfulfilledOrders (Boolean!)
このロケーションが未充足の注文を持っているかどうかを示す。

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

inventoryLevel (InventoryLevel)
与えられたインベントリアイテムの単一のインベントリレベル。

引数 詳細
inventoryItemId (ID!) required 返却するインベントリレベルのインベントリアイテム ID を指定します。

isActive (Boolean!)
ロケーションがアクティブであるかどうか。

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

name (String!)
ロケーションの名前。

shipsInventory (Boolean!)
このロケーションが配送料金の計算に使用されるかどうかを示す。

suggestedAddresses ([LocationSuggestedAddress!]!)
このロケーションに対する推奨アドレスのリスト(ない場合は空)。

Location の返却型

Implements

非推奨フィールド

  • isPrimary (Boolean!) deprecated
    その拠点が、在庫を出荷するための主要な拠点であるかどうか。

複数の Locations をページングするための自動生成タイプです。

フィールド

edges ([LocationEdge!]!)
エッジのリスト。

pageInfo (PageInfo!)
ページネーションを補助するための情報。

自動生成されたタイプで、ページネーションの際に 1 つの Location とカーソルを保持します。

フィールド

cursor (String!)
ページネーションで使用するカーソルです。

nodeLocation!)
LocationEdge の末尾の項目。

LocationEdge の返却型

Samples

query
# 最初の10個のロケーションのIDを取得
{
  locations(first:10) {
    edges {
      node {
        id
      }
    }
  }
}
response
{
  "data": {
    "locations": {
      "edges": [
        {
          "node": {
            "id": "gid://shopify/Location/61205381142"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Location/17285971990"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Location/61205348374"
          }
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 12,
      "actualQueryCost": 5,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 995,
        "restoreRate": 50
      }
    }
  }
}
query

# 最初の3回の注文で位置情報を取得
{
  orders(first:3) {
    edges {
      node {
        physicalLocation {
          address {
            address1
            address2
            city
            country
            zip
          }
        }
      }
    }
  }
}
response

  "data": {
    "orders": {
      "edges": [
        {
          "node": {
            "physicalLocation": {
              "address": {
                "address1": "151 O'Connor Street",
                "address2": "1st Floor",
                "city": "Ottawa",
                "country": "Canada",
                "zip": "K2P 2L8"
              }
            }
          }
        },
        {
          "node": {
            "physicalLocation": null
          }
        },
        {
          "node": {
            "physicalLocation": {
              "address": {
                "address1": "151 O'Connor Street",
                "address2": "1st Floor",
                "city": "Ottawa",
                "country": "Canada",
                "zip": "K2P 2L8"
              }
            }
          }
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 11,
      "actualQueryCost": 10,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 990,
        "restoreRate": 50
      }
    }
  }
}
query
# フルフィルメントの位置情報を取得
{
  fulfillment(id: "gid://shopify/Fulfillment/1099547770902") {
    id
    location {
      address {
        address1
        address2
        city
        country
        zip
      }
    }
  }
}
response
{
  "data": {
    "fulfillment": null
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 3,
      "actualQueryCost": 1,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 999,
        "restoreRate": 50
      }
    }
  }
}
query
# ロケーションに入荷したアイテムの数量を取得
{
  inventoryItem(id: "gid://shopify/InventoryItem/19848949301270") {
    id
    inventoryLevel(locationId: "gid://shopify/Location/17285971990") {
      item {
        variant {
          displayName
        }
      }
      incoming
      location {
        address {
          address1
          address2
          city
          country
          zip
        }
      }
    }
  }
}
response
{
  "data": {
    "inventoryItem": {
      "id": "gid://shopify/InventoryItem/19848949301270",
      "inventoryLevel": {
        "item": {
          "variant": {
            "displayName": "Rough Snowflake Camisole - Default Title"
          }
        },
        "incoming": 0,
        "location": {
          "address": {
            "address1": "151 O'Connor Street",
            "address2": "1st Floor",
            "city": "Ottawa",
            "country": "Canada",
            "zip": "K2P 2L8"
          }
        }
      }
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 6,
      "actualQueryCost": 6,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 994,
        "restoreRate": 50
      }
    }
  }
}
query
# Get a specific location using the `node` field and a GraphQL fragment
{
  node(id:"gid://shopify/Location/17285971990") {
    id
    ... on Location {
      name
      shipsInventory
      address {
        address1
        address2
        city
        country
        zip
      }
    }
  }
}
response
{
  "data": {
    "node": {
      "id": "gid://shopify/Location/17285971990",
      "name": "Shopify Ottawa Office",
      "shipsInventory": true,
      "address": {
        "address1": "151 O'Connor Street",
        "address2": "1st Floor",
        "city": "Ottawa",
        "country": "Canada",
        "zip": "K2P 2L8"
      }
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 2,
      "actualQueryCost": 2,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 998,
        "restoreRate": 50
      }
    }
  }
}

LocationAddress (object)

ロケーションのアドレスを表します。

フィールド

address1 (String)
その場所の住所の 1 行目です。

address2 (String)
その場所の住所の 2 行目。

city (String)
位置情報の都市名。

country (String)
位置情報の国名。

countryCode (String)
位置情報の 2 文字の国コード。

formatted ([String!]!)
場所の住所のフォーマットされたバージョン。

latitude (Float)
位置情報の緯度座標です。

longitude (Float)
位置情報の経度座標。

phone (String)
位置情報の電話番号。

province (String)
位置情報の都道府県名。

provinceCode (String)
住所の地域を表すコード(都道府県、州、区など)。例えば、QC はカナダのケベック州を意味します。

zip (String)
位置情報の郵便番号。

LocationAddress の返却型

LocationSuggestedAddress (object)

ロケーションの推奨アドレスを表します。

フィールド

address1 (String)
提案されたアドレスの 1 行目。

address2 (String)
提案されたアドレスの 2 行目。

city (String)
提案されたアドレスの都市名です。

country (String)
提案されたアドレスの国。

countryCode (CountryCode)
提案された住所の国コードです。

formatted ([String!]!)
提案された住所のフォーマットされたバージョンです。

province (String)
提案された住所の都道府県です。

provinceCode (String)
提案された住所の州コード。

zip (String)
提案された住所の郵便番号です。

LocationSuggestedAddress の返却型

NavigationItem (object)

基本的なリンク属性を持つ、ナビゲーションアイテムです。

フィールド

id (String!)
ナビゲーションアイテムのユニークな識別子。

title (String!)
ナビゲーション・アイテムの名前。

url (URL!)
ナビゲーションアイテムがリンクするページの URL。

ResourceLimit (object)

リソースリミットは、そのリソースが持つ制限を表します。

フィールド

available (Boolean!)
リソースが利用可能かどうか。

quantityAvailableInt)
利用可能な数量。null の場合、利用可能な数量は無制限です。

quantityLimit (Int)
リソースの数量制限。null の場合、数量は無制限です。

quantityUsed (Int)
リソースの使用量。null の場合、使用された数量は取得できません。

ResourceLimit の返却型

Shop (object)

ショップオブジェクトを表す。

Connections

assignedFulfillmentOrders (FulfillmentOrderConnection!)
フルフィルメント・サービスに割り当てられたフルフィルメント・オーダーのページングされたリスト。

引数 詳細
after ( String ) 指定されたカーソルの後に来る要素を返します。
assignmentStatus ( FulfillmentOrderAssignmentStatus ) 返却すべきフルフィルメントオーダーのアサイメントステータスです。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
locationIds ( [ID!] ) ロケーション ID のリストで指定された特定のロケーションに対してのみフルフィルメント注文を返します。
reverse ( Boolean ) 対象となるリストの順序を反転させます。 デフォルト値:false
sortKey ( FulfillmentOrderSortKeys ) 対象となるリストを、与えられたキーでソートします。デフォルト値: ID です。

availableChannelApps (AppConnection!)
現在ショップにインストールされていない販売チャンネルのリスト。

引数 詳細
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
reverse ( Boolean ) 対象となるリストの順序を反転させます。 デフォルト値:false

currencySettings (CurrencySettingConnection!)
ショップの通貨設定。

引数 詳細
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
reverse ( Boolean ) 対象となるリストの順序を反転させます。 デフォルト値:false

customerTags (StringConnection!)
顧客のアカウントに追加されたタグのリストです。

引数 詳細
first ( Int ) required リストから最初の n 個の要素までを返します。

draftOrderTags (StringConnection!)
ドラフトオーダーに追加されたタグのリスト。

引数 詳細
first ( Int ) required リストから最初の n 個の要素までを返します。

fulfillmentOrders (FulfillmentOrderConnection!)
マーチャントが管理するフルフィルメントオーダーとサードパーティのフルフィルメントオーダーのページングされたリスト。

| 引数 | 詳細 |
| --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| after ( String ) | 指定されたカーソルの後に来る要素を返します。 |
| before ( String ) | 指定されたカーソルの前にある要素を返します。 |
| first ( Int ) | リストから最初の n 個の要素までを返します。 |
| includeClosed ( Boolean ) | 閉じたフルフィルメント注文を含めるかどうか。デフォルト値:false |
| last ( Int ) | リストから最後の n 個の要素までを返します。 | デフォルト値:false |
| query ( String ) | サポートされているフィルタパラメータ.。
assigned_location_id
status
詳細な検索構文を見る |
| reverse ( Boolean ) | 対象となるリストの順序を反転させます。 デフォルト値:false。 |
| sortKey ( FulfillmentOrderSortKeys ) | 対象となるリストを、与えられたキーでソートします。デフォルト値: ID です。 |

metafields (MetafieldConnection!)
リソースに属するメタフィールドのリスト。

引数 詳細
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
namespace ( String ) フィルタリングの対象となるメタフィールドの名前空間です。
reverse ( Boolean ) 対象となるリストの順序を反転させます。 デフォルト値:false

orderTags (StringConnection!)
注文に追加されたタグのリストです。

引数 詳細
first ( Int ) required リストから最初の n 個の要素までを返します。
sort ( ShopTagSort ) ソートタイプ。デフォルト値です。ALPHABETICAL

privateMetafields (PrivateMetafieldConnection!)
リソースに属するプライベート・メタフィールドのリスト。

引数 詳細
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
namespace ( String ) フィルタリングの対象となるメタフィールドの名前空間です。
reverse ( Boolean ) 対象となるリストの順序を反転させます。 デフォルト値:false

productImages (ImageConnection!)
ショップの全商品の全画像

引数 詳細
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
crop ( CropRegion ) 指定された領域に従って画像をクロップします。この引数は非推奨です。代わりに Image.transformedSrccrop を使用してください。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
maxHeight ( Int ) 画像の高さを 1 から 2048 までのピクセル数で指定します。この引数は非推奨です。代わりにImage.transformedSrcmaxHeightを使用してください。
maxWidth ( Int ) 画像の幅を 1 ~ 2048 の間でピクセル単位で指定します。この引数は非推奨です。代わりにImage.transformedSrcmaxWidthを使用してください。
reverse ( Boolean ) 対象となるリストの順序を反転させます。 デフォルト値:false
scale ( Int ) 高解像度の網膜ディスプレイのための画像サイズの乗数。1 から 3 の間でなければなりません。この引数は推奨されません。代わりにImage.transformedSrcscaleを使用してください。デフォルト値:1
sortKey ( ProductImageSortKeys ) 基礎となるリストを、与えられたキーでソートします。デフォルトの値です。CREATED_AT

productTags (StringConnection!)
製品に追加されたタグのリスト。

引数 詳細
first ( Int ) required リストから最初の n 個の要素までを返します。

productTypes (StringConnection!)
製品に追加されるタイプ。

引数 詳細
first ( Int ) リストから最初の n 個の要素までを返します。

productVendors (StringConnection!)
製品に追加されたベンダー。

引数 詳細
first ( Int ) required リストから最初の n 個の要素までを返します。

search (SearchResultConnection!)
admin の検索結果を返します。

引数 詳細
after ( String ) 指定されたカーソルの後に来る要素を返します。
first ( Int ) required リストから最初の n 個の要素までを返します。
query ( String ) required フィルタリングするための検索クエリです。
types ( SearchResultType!) ) 絞り込みを行う検索結果の種類です。

StorefrontAccessTokenConnection! (SearchResultConnection!)
プライベート・アプリケーションのストアフロント・アクセストークン。アプリケーションごとにスコープされています。

引数 詳細
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返します。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
reverse ( Boolean ) 対象となるリストの順序を反転させます。 デフォルト値:false

フィールド

alerts ([ShopAlert!]!)
Shopify の管理画面に表示されるアラートメッセージ。

analyticsToken (String!)
ショップのレポートやダッシュボードを照会するために必要なトークンです。

billingAddress (MailingAddress!)
ショップの請求先住所情報。

checkoutApiSupported (Boolean!)
ショップがチェックアウト API によるチェックアウトをサポートしているかどうかを指定します。

contactEmail (String!)
ショップの公開用の連絡先メールアドレス。お客様はこのメールを使ってショップオーナーと連絡を取ります。

countriesInShippingZones (CountriesInShippingZones!)
ショップの配送地域に定義されている国。

currencyCode (CurrencyCode!)
ショップの通貨を表す 3 文字のコードです。

currencyFormats (CurrencyFormats!)
お店での通貨の表示方法です。

customerAccounts (ShopCustomerAccountsSetting!)
ショップのカスタマーアカウント要件の優先順位。

description (String)
検索エンジンの結果で使用されるショップのメタディスクリプション。

domains ([Domain!]!)
ショップに設定されたドメイン。

email (String!)
ショップオーナーの電子メールアドレス。Shopify はショップオーナーとのコミュニケーションにこのメールアドレスを使用します。

enabledPresentmentCurrencies ([CurrencyCode!]!)
ショップで有効になっている予約通貨です。

features (ShopFeatures!)
ショップの機能です。

fulfillmentServices ([FulfillmentService!]!)
ショップにインストールされているフルフィルメントサービスのリスト。

ianaTimezone (String!)
IANA で定義されているショップのタイムゾーン。

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

limitedPendingOrderCount (LimitedPendingOrderCount!)
ショップの保留オーダーの数です。最大 10000 件までに制限されます。

metafield (Metafield)
リソースに属している名前空間とキーによるメタフィールドを返します。

引数 詳細
key ( String! ) required 指定されたカーソルの後に来る要素を返します。
namespace ( String! ) required 指定されたカーソルの前にある要素を返します。

myshopifyDomain (String!)
ショップの.myshopify.com ドメイン名。

name (String!)
ショップの名前。

navigationSettings ([NavigationItem!]!)
ショップのナビゲーション設定。

orderNumberFormatPrefix (String!)
注文番号の前に表示されるプレフィックスです。

orderNumberFormatSuffix (String!)
注文番号の後に表示されるサフィックス。

paymentSettings (PaymentSettings!)
支払いに関する設定です。

plan (ShopPlan!)
ショップのプラン。

primaryDomain (Domain!)
ショップのプライマリドメイン名。

privateMetafield (PrivateMetafield)
リソースに属する、名前空間とキーによるプライベートメタフィールドを返します。

引数 詳細
key ( String! ) required 指定されたカーソルの後に来る要素を返します。
namespace ( String! ) required 指定されたカーソルの前にある要素を返します。

publicationCountInt!)
出版物の数を公開します。

resourceLimits (ShopResourceLimits!)
ショップのリソース制限。

richTextEditorUrl (URL!)
リッチテキストエディターの URL。

searchFilters (SearchFilterOptions!)
検索フィルターオプションのリスト。

setupRequired (Boolean!)
ショップに未処理のセットアップ手順があるかどうか。

shipsToCountries ([CountryCode!]!)
ショップが出荷する国。

shopPolicies ([ShopPolicy!]!)
ショップに関連するすべてのポリシーのリスト。

taxShipping (Boolean!)
配送時に税金がかかるかどうかを指定します。

taxesIncluded (Boolean!)
商品価格に適用される税金が含まれているかどうかの設定。

timezoneAbbreviation (String!)
ショップのタイムゾーンの略語。

timezoneOffset (String!)
ショップのタイムゾーンのオフセット

timezoneOffsetMinutes (Int!)
ショップのタイムゾーンオフセットを分数で表したもの。

translations ([PublishedTranslation!]!)
リソースに関連する翻訳。

引数 詳細
locale ( String! ) required 翻訳ロケールをフィルタリングします。

unitSystem (UnitSystem!)
お店の単位系です。

uploadedImagesByIds ([Image!]!)
ショップにアップロードされた画像の一覧を ID で取得します。

引数 詳細
imageIds([ID!]!) required アップロードされた画像の ID です。

url (URL!)
ショップのストアフロントの URL です。

weightUnit (WeightUnit!)
ショップの商品や配送に使用する重量の単位。

Shop の返却型

Shop のミューテーション

shopifyPaymentsUpdate
Shopify Payments のアカウントとゲートウェイのプロパティを更新します。

Implements

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

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