📈

【Shopify.dev和訳】Admin API/GraphQL ref/Shipping & fulfillment①

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

この記事について

この記事は、Admin APIs/GraphQL reference/Shipping and fulfillmentの記事を和訳したものです。

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

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

Shipping and fulfillment APIs (OBJECTS 前半)

In this section

チェックアウト時にカスタム送料を表示したり、アプリを店舗のフルフィルメントサービスとして登録し、そのフルフィルメントを管理したりすることができます。

  • CountriesInShippingZones - ストアの配送地域に登録されている国です。

  • DeliveryAvailableService - 配送サービスが利用可能な国。

  • DeliveryCarrierService - 配送業者またはサービス提供者に関する情報です。

  • DeliveryCarrierServiceAndLocations - 配送サービスとサービス利用可能なストアのロケーションのセットです。

  • DeliveryCondition - 配送方法が注文に適用されるために通過しなければならない条件です。

  • DeliveryConditionCriteria - フィールドが満たさなければならない基準(重量または価格)です。

  • DeliveryConditionField - 条件が適用されるフィールド・タイプです。

  • DeliveryConditionOperator - 条件を満たすかどうかを判断するための演算子です。

  • DeliveryCountry - 配送区域の定義に使われる国です。

  • DeliveryCountryAndZone - 配送区域の名前を持つ国です。

  • DeliveryCountryCodeOrRestOfWorld - ISO 3166-1 α2 の国コードと Rest Of World を示すフラグです。

  • DeliveryCountryCodesOrRestOfWorld - ISO 3166-1 アルファ 2 国コードのリスト、または「Rest of World」です。

  • DeliveryCountryInput - 国を指定するための入力フィールドです。

  • DeliveryLegacyModeBlocked - ショップが完全な多拠点配送プロファイルモードへの変換をブロックしているかどうかを示します。ショップがブロックされている場合は、ブロックの理由も返されます。

  • DeliveryLegacyModeBlockedReason - お店が完全なマルチロケーション配送プロファイルモードへの変換をブロックされている理由です。

  • DeliveryLocationGroup - ロケーショングループは、複数の配送プロファイルでゾーンと配送方法を共有するアクティブなロケーションのコレクションです。

  • DeliveryLocationGroupZone - ロケ地グループとゾーンを配送プロファイルの関連するメソッド定義とリンクします。

  • DeliveryLocationGroupZoneInput - ロケーショングループとプロファイルに関連付けられた配送ゾーンの入力フィールドです。

  • DeliveryMethod - 配送方法です。

  • DeliveryMethodDefinition - メソッド定義は、配送レートと、そのメソッドが適用されるために満たすべき条件を記述します。

  • DeliveryMethodDefinitionCounts - ゾーン内の方法定義の数で、商人が所有する定義と参加者が所有する定義に分けられます。

  • DeliveryMethodDefinitionInput - メソッド定義の入力フィールド。

  • DeliveryMethodDefinitionType - フィルタリングする方法定義のさまざまなタイプです。

  • DeliveryMethodType - 配送方法が持つことができる可能な方法の種類です。

  • DeliveryParticipant - キャリアが定義したレートで、マーチャントが定義した固定料金またはレートに対するパーセンテージ料金の可能性があります。

  • DeliveryParticipantInput - 参加者の入力フィールドです。

  • DeliveryParticipantService - 参加者が提供するサービスです。

  • DeliveryParticipantServiceInput - 参加者が提供するサービスの入力フィールドです。

  • DeliveryPriceConditionInput - メソッド定義の価格ベースの条件の入力フィールドです。

  • DeliveryProductVariantsCount - プロファイル内の製品バリアントの数です。このカウントは 500 が上限です。

  • DeliveryProfile - 複数のロケーション、製品ごとの配送のためのプロファイルです。

  • DeliveryProfileInput - 配送プロファイルの入力フィールドです。

  • DeliveryProfileItem - この配送プロファイルの一部である製品と関連するバリアントのサブセットです。

  • DeliveryProfileLocationGroup - 配送プロファイルに関連付けられたゾーンにロケーショングループをリンクします。

  • DeliveryProfileLocationGroupInput - プロファイルに関連付けられた配送ロケーショングループの入力フィールドです。

  • DeliveryProvince - ゾーンを定義するために使用される地域です。

  • DeliveryProvinceInput - 地域を指定するための入力フィールドです。

  • DeliveryRateDefinition - DeliveryMethodDefinition の商人定義のレートです。

  • DeliveryRateDefinitionInput - レート定義の入力フィールドです。

  • DeliveryRateProvider - レート定義または参加者によって提供されるレートです。

  • DeliverySetting - デリバリーショップレベルの設定です。

  • DeliverySettingInput - ショップレベルのデリバリー設定の入力フィールドです。

  • DeliveryUpdateConditionInput - メソッド定義の条件を更新するための入力フィールドです。

  • DeliveryWeightConditionInput - メソッド定義の重量ベースの条件を入力するための入力フィールドです。

  • DeliveryZone - ゾーンとは、配送プロファイル内の配送方法を含む地理的なエリアのことです。

  • DraftFulfillment - フルフィルメントサービスごとにグループ化された未達成のラインアイテムを返します。各ドラフトフルフィルメントには、そのフルフィルメントが配送を必要とするかどうか、配送ラベルが印刷できるかどうかなどの追加情報が含まれています。

  • EditableProperty - 属性の編集可能な情報です。

  • Fulfillment - フルフィルメントを表します。Shopify では、フルフィルメントは、注文内の 1 つまたは複数のアイテムの出荷を表します。注文が完全に履行された場合、それは注文に含まれるすべてのアイテムが顧客に送られたことを意味します。1 つの注文に対して複数のフルフィルメントが存在することがあります。

  • FulfillmentDisplayStatus - フルフィルメントの表示状態です。

  • FulfillmentEvent - 一度に一つのフルフィルメントを記述するイベント。

  • FulfillmentEventSortKeys - FulfillmentEvent クエリの有効なソートキーのセット。

  • FulfillmentEventStatus - イベントステータス' は、フルフィルメントのステータスを記述する。

  • FulfillmentHold - フルフィルメント注文に現在適用されているフルフィルメントの保留です。

  • FulfillmentHoldReason - フルフィルメントの保留の理由です。

  • FulfillmentInput - フルフィルメントの作成に使用される入力フィールドです。

  • FulfillmentLineItem - フルフィルメントに含まれる注文のラインアイテムを表します。

  • FulfillmentLineItemInput - フルフィルメントに注文のラインアイテムを含めるために使用する入力フィールドです。

  • FulfillmentOrder - フルフィルメント注文を表します。Shopify では、フルフィルメント オーダーは、同じ場所でフルフィルメントされる 1 つ以上のアイテムのグループを表します。ある場所の注文に対して、複数のフルフィルメント オーダーが存在することがあります。

  • FulfillmentOrderAction - フルフィルメント オーダーに対して実行可能なアクションです。

  • FulfillmentOrderAssignedLocation - フルフィルメント オーダーの割り当てられたロケーションを表し、フルフィルメント オーダーが作成されたロケーションのスナップショットです。割り当てられたロケーションはフルフィルメントを実行することが期待されます。

  • FulfillmentOrderAssignmentStatus - フルフィルメント オーダーのフィルタリングに使用される割り当てステータスです。

  • FulfillmentOrderDestination - フルフィルメントの際にアイテムが送られるべき宛先を表します。

  • FulfillmentOrderHoldInput - フルフィルメント注文に適用されるフルフィルメント ホールド用の入力引数です。

  • FulfillmentOrderInternationalDuties - フルフィルメント オーダーに関連する国際的な義務。

  • FulfillmentOrderLineItem - フルフィルメント オーダーに属するライン アイテムを表します。

  • FulfillmentOrderLineItemInput - フルフィルメント オーダーからライン アイテムを含めるために使用される入力フィールド。

  • FulfillmentOrderLineItemsInput - 指定されたフルフィルメント オーダーのラインアイテムを含むために使用される入力フィールドです。

  • FulfillmentOrderLocationForMove - フルフィルメント オーダーが移動できる可能性のある場所です。

  • FulfillmentOrderMerchantRequest - フルフィルメントサービスに対するマーチャントのリクエストを表します。

  • FulfillmentOrderMerchantRequestKind - マーチャントがフルフィルメントサービスに対して行うことができるリクエストの種類です。

  • FulfillmentOrderRequestStatus - フルフィルメント オーダーのリクエスト ステータス。

  • FulfillmentOrderSortKeys - FulfillmentOrder クエリの有効なソート キーのセットです。

  • FulfillmentOrderStatus - フルフィルメント オーダーのステータスです。

  • FulfillmentOrderSupportedAction - フルフィルメント オーダーがサポートするメソッドの 1 つを表します。

  • FulfillmentService - フルフィルメント サービスを表します。フルフィルメント サービスは、ストア オーナーに代わって注文を準備し、出荷するサードパーティ サービスです。

  • FulfillmentServiceType - フルフィルメントサービスのタイプです。

  • FulfillmentStatus - フルフィルメントのステータスです。

  • FulfillmentTrackingInfo - フルフィルメントのトラッキング情報を表します。

  • FulfillmentTrackingInput - トラッキング情報のすべての可能なフィールドを指定するために使用される入力フィールドです。

  • FulfillmentV2Input - フルフィルメントの注文からフルフィルメントを作成するために使用される入力フィールドです。

  • MethodDefinitionSortKeys - MethodDefinition クエリに有効なソートキーのセットです。

  • ProfileItemSortKeys - ProfileItem クエリに有効なソートキーのセットです。

  • ShippingMethod - 配送のための配送方法です。

  • ShippingRate - 注文に適用される配送料です。

  • TrackingInfoInput - トラッキング情報のフィールドを指定します。

  • TrackingInfoUpdateInput - トラッキング情報を更新するために可能なすべてのフィールドを指定します。

  • deliveryProfileCreate - 配送プロファイルを作成します。

  • deliveryProfileRemove - 配送プロファイルの削除/解除を待ち受けます。

  • deliveryProfileUpdate - 配送プロファイルを更新します。

  • deliverySettingUpdate - ショップの配送設定を行います。

  • deliveryShippingOriginAssign - レガシー互換モードのプロファイルの間、配送元としてロケーションを割り当てます。

  • fulfillmentCancel - フルフィルメントをキャンセルする

  • fulfillmentCreate - 注文に対するフルフィルメントを作成する

  • fulfillmentCreateV2 - 1 つまたは複数のフルフィルメント注文のフルフィルメントを作成します。フルフィルメント注文は、同じ注文に関連付けられ、同じ場所に割り当てられます。

  • fulfillmentOrderAcceptCancellationRequest - フルフィルメント注文のためにフルフィルメント サービスに送信されたキャンセル要求を受け入れる。

  • fulfillmentOrderAcceptFulfillmentRequest - フルフィルメント注文のためにフルフィルメント サービスに送信されたフルフィルメント リクエストを受け入れます。

  • fulfillmentOrderCancel - フルフィルメント注文をキャンセルとしてマークします。

  • fulfillmentOrderClose - 進行中のフルフィルメント注文を不完全としてマークし、フルフィルメント サービスが残りのアイテムを出荷できず、フルフィルメント注文を閉じる意図があることを示します。

  • fulfillmentOrderHold - 未処理のフルフィルメント注文にフルフィルメントの保留を適用する。

  • fulfillmentOrderMove - フルフィルメント注文を新しい場所に移動する。

  • fulfillmentOrderOpen - スケジュールされたフルフィルメント注文をオープンとしてマークする。

  • fulfillmentOrderRejectCancellationRequest - フルフィルメント注文のためにフルフィルメント サービスに送信されたキャンセル要求を拒否する。

  • fulfillmentOrderRejectFulfillmentRequest - フルフィルメント注文のためにフルフィルメント サービスに送信されたフルフィルメント リクエストを拒否します。

  • fulfillmentOrderReleaseHold - フルフィルメント注文の保留を解除する。

  • fulfillmentOrderReschedule - スケジュールされたフルフィルメント注文を再スケジュールする。

  • fulfillmentOrderSubmitCancellationRequest - フルフィルメント注文のフルフィルメント サービスにキャンセル要求を送信します。

  • fulfillmentOrderSubmitFulfillmentRequest - フルフィルメント注文のフルフィルメント サービスにフルフィルメント リクエストを送信します。

  • fulfillmentServiceCreate - フルフィルメント サービスを作成する。

  • fulfillmentServiceDelete - フルフィルメント サービスを削除する。

  • fulfillmentServiceUpdate - フルフィルメント サービスを更新する。

  • fulfillmentTrackingInfoUpdate - フルフィルメントのトラッキング情報を更新します。

  • fulfillmentTrackingInfoUpdateV2 - フルフィルメントのトラッキング情報を更新します。

  • shippingPackageDelete - 配送パッケージを削除する

  • shippingPackageMakeDefault - 配送パッケージをデフォルトの配送パッケージとして設定します。デフォルトの配送パッケージは、チェックアウト時に送料を計算するために使用されるパッケージです。

  • shippingPackageUpdate - カスタム配送パッケージを更新します。

UNIONS

DeliveryConditionCriteria

演算子に基づいて、フィールドが満たすべき基準(重量または価格)を設定します。

対応可能な型 | Possible types

DeliveryRateProvider

定義されたレートまたは参加者から提供されたレート。

対応可能な型 | Possible types

OBJECTS

CountriesInShippingZones

内容 | On this page

フィールド | Fields

countryCodes ([CountryCode!]!)
配送地域で定義されている国。

includeRestOfWorld (Boolean!)
他の国がいずれかの配送地域で定義されているかどうか。

CountriesInShippingZones を返す型 | Types that return CountriesInShippingZones

DeliveryAvailableService

配送サービス内容と対象国について。

内容 | On this page

フィールド | Fields

countries (DeliveryCountryCodesOrRestOfWorld!)
配送サービス提供者が出荷する国です。

name (String!)
配送サービスの名前です。

DeliveryAvailableService を返す型 | Types that return DeliveryAvailableService

DeliveryCarrierService

配送業者やサービス提供者に関する情報です。

内容 | On this page

フィールド | Fields

availableServicesForCountries ([DeliveryAvailableService!]!)
与えられた配送先に対して提供されるサービス。

Argument Description
countryCodes ([CountryCode]!) 宛先の国コード。
origin ([ID!]) 可能な起源の位置。
restOfWorld (Boolean!) required 他の国を目的地として使用する。

formattedName (String)
サービスプロバイダーの適切にフォーマットされた名前で、すぐに表示できます。

icon (Image!)
サービス提供者のロゴ。

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

name (String)
サービス提供者の名前。

DeliveryCarrierService を返す型 | Types that return DeliveryCarrierService

実装 | Implements

サンプル | Samples

sample 1
# 配送業者サービスのIDを取得
{
  availableCarrierServices {
    carrierService {
      id
    }
  }
}
OUTPUT 1
{
  "data": {
    "availableCarrierServices": [
      {
        "carrierService": {
          "id": "gid://shopify/DeliveryCarrierService/17248583702"
        }
      }
    ]
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 2,
      "actualQueryCost": 2,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 998,
        "restoreRate": 50
      }
    }
  }
}
sample 2
# 配送業者のIDを取得する
{
  carrierService(id: "gid://shopify/DeliveryCarrierService/17248583702") {
    name
  }
}
OUTPUT 2
{
  "data": {
    "carrierService": {
      "name": "canada_post"
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 1,
      "actualQueryCost": 1,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 999,
        "restoreRate": 50
      }
    }
  }
}
sample 3
# 配送業者サービスの表示名を取得
{
  carrierService(id: "gid://shopify/DeliveryCarrierService/17248583702") {
    formattedName
  }
}
OUTPUT 3
{
  "data": {
    "carrierService": {
      "formattedName": "Canada Post (Discounted rates from Shopify Shipping)"
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 1,
      "actualQueryCost": 1,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 999,
        "restoreRate": 50
      }
    }
  }
}

DeliveryCarrierServiceAndLocations

配送サービスと、サービスを利用できるストアのセットです。

内容 | On this page

フィールド | Fields

carrierService (DeliveryCarrierService!)
配送サービスです。

locations ([Location!]!)
この配送サービスをサポートするロケーション。

DeliveryCarrierServiceAndLocations を返す型 | Types that return DeliveryCarrierServiceAndLocations

DeliveryCondition

メソッドの定義が注文に適用されるために通過しなければならない条件。

内容 | On this page

フィールド | Fields

conditionCriteria (DeliveryConditionCriteria!)
演算子に基づいて、フィールドが満たすべき基準(重量または価格)。

field (DeliveryConditionField!)
演算子を使って、基準単位を比較するフィールド。

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

operator (DeliveryConditionOperator!)
フィールドと基準を比較するための演算子。

DeliveryCondition を返す型 | Types that return DeliveryCondition

実装 | Implements

サンプル | Samples

sample 1
# 配送条件のIDを取得
{
  deliveryProfiles (first: 1) {
    edges {
      node {
        profileLocationGroups {
          locationGroupZones (first: 2) {
            edges {
              node {
                methodDefinitions (first:2) {
                  edges {
                    node {
                      methodConditions {
                        id
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
OUTPUT 2
{
  "data": {
    "deliveryProfiles": {
      "edges": [
        {
          "node": {
            "profileLocationGroups": [
              {
                "locationGroupZones": {
                  "edges": [
                    {
                      "node": {
                        "methodDefinitions": {
                          "edges": [
                            {
                              "node": {
                                "methodConditions": []
                              }
                            }
                          ]
                        }
                      }
                    },
                    {
                      "node": {
                        "methodDefinitions": {
                          "edges": [
                            {
                              "node": {
                                "methodConditions": []
                              }
                            }
                          ]
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 20,
      "actualQueryCost": 16,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 984,
        "restoreRate": 50
      }
    }
  }
}
sample 2

# 配送方法が注文に適用されるために通過しなければならない条件を取得する
{
  deliveryProfiles (first: 1) {
    edges {
      node {
        profileLocationGroups {
          locationGroupZones (first: 2) {
            edges {
              node {
                methodDefinitions (first:2) {
                  edges {
                    node {
                      methodConditions {
                        id
                        operator
                        field
                        conditionCriteria {
                          ... on Weight {
                            value
                          }
                          ... on MoneyV2 {
                            amount
                            currencyCode
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
OUTPUT 2
{
  "data": {
    "deliveryProfiles": {
      "edges": [
        {
          "node": {
            "profileLocationGroups": [
              {
                "locationGroupZones": {
                  "edges": [
                    {
                      "node": {
                        "methodDefinitions": {
                          "edges": [
                            {
                              "node": {
                                "methodConditions": []
                              }
                            }
                          ]
                        }
                      }
                    },
                    {
                      "node": {
                        "methodDefinitions": {
                          "edges": [
                            {
                              "node": {
                                "methodConditions": []
                              }
                            }
                          ]
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 24,
      "actualQueryCost": 16,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 984,
        "restoreRate": 50
      }
    }
  }
}

DeliveryCountry

配送地域を定義するときに使用される国。

内容 | On this page

フィールド | Fields

code (DeliveryCountryCodeOrRestOfWorld!)
この国の ISO 3166-1 alpha-2 国コードと Rest Of World を示すフラグ。

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

name (String!)
この国の名前。

provinces ([DeliveryProvince!]!)
この国に関連する地域。

translatedName (String!)
ユーザーロケールに基づいて翻訳された国の名前。

DeliveryCountry を返す型 | Types that return DeliveryCountry

実装 | Implements

サンプル | Samples

Sample 1
# 配送国のIDを取得
{
  deliveryProfiles (first: 1) {
    edges {
      node {
        profileLocationGroups {
          locationGroupZones (first: 2) {
            edges {
              node {
                zone {
                  id
                  countries {
                    id
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
OUTPUT 1
{
  "data": {
    "deliveryProfiles": {
      "edges": [
        {
          "node": {
            "profileLocationGroups": [
              {
                "locationGroupZones": {
                  "edges": [
                    {
                      "node": {
                        "zone": {
                          "id": "gid://shopify/DeliveryZone/41308061718",
                          "countries": [
                            {
                              "id": "gid://shopify/DeliveryCountry/146074271766"
                            }
                          ]
                        }
                      }
                    },
                    {
                      "node": {
                        "zone": {
                          "id": "gid://shopify/DeliveryZone/41308160022",
                          "countries": [
                            {
                              "id": "gid://shopify/DeliveryCountry/146074304534"
                            }
                          ]
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 12,
      "actualQueryCost": 12,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 988,
        "restoreRate": 50
      }
    }
  }
}
Sample 2
# 製品を配送できる国や地域を取得する
{
  deliveryProfiles (first: 1) {
    edges {
      node {
        profileLocationGroups {
          locationGroupZones (first: 2) {
            edges {
              node {
                zone {
                  id
                  countries {
                    id
                    name
                    code {
                      countryCode
                    }
                    provinces {
                      id
                      code
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
OUTPUT 2
{
  "data": {
    "deliveryProfiles": {
      "edges": [
        {
          "node": {
            "profileLocationGroups": [
              {
                "locationGroupZones": {
                  "edges": [
                    {
                      "node": {
                        "zone": {
                          "id": "gid://shopify/DeliveryZone/41308061718",
                          "countries": [
                            {
                              "id": "gid://shopify/DeliveryCountry/146074271766",
                              "name": "Canada",
                              "code": {
                                "countryCode": "CA"
                              },
                              "provinces": [
                                {
                                  "id": "gid://shopify/DeliveryProvince/1672077344790",
                                  "code": "AB"
                                },
                                {
                                  "id": "gid://shopify/DeliveryProvince/1672077377558",
                                  "code": "BC"
                                },
                                {
                                  "id": "gid://shopify/DeliveryProvince/1672077410326",
                                  "code": "MB"
                                },
                                {
                                  "id": "gid://shopify/DeliveryProvince/1672077443094",
                                  "code": "NB"
                                },
                                {
                                  "id": "gid://shopify/DeliveryProvince/1672077475862",
                                  "code": "NL"
                                },
                                {
                                  "id": "gid://shopify/DeliveryProvince/1672077508630",
                                  "code": "NT"
                                },
                                {
                                  "id": "gid://shopify/DeliveryProvince/1672077541398",
                                  "code": "NS"
                                },
                                {
                                  "id": "gid://shopify/DeliveryProvince/1672077574166",
                                  "code": "NU"
                                },
                                {
                                  "id": "gid://shopify/DeliveryProvince/1672077606934",
                                  "code": "ON"
                                },
                                {
                                  "id": "gid://shopify/DeliveryProvince/1672077639702",
                                  "code": "PE"
                                },
                                {
                                  "id": "gid://shopify/DeliveryProvince/1672077672470",
                                  "code": "QC"
                                },
                                {
                                  "id": "gid://shopify/DeliveryProvince/1672077705238",
                                  "code": "SK"
                                },
                                {
                                  "id": "gid://shopify/DeliveryProvince/1672077738006",
                                  "code": "YT"
                                }
                              ]
                            }
                          ]
                        }
                      }
                    },
                    {
                      "node": {
                        "zone": {
                          "id": "gid://shopify/DeliveryZone/41308160022",
                          "countries": [
                            {
                              "id": "gid://shopify/DeliveryCountry/146074304534",
                              "name": "Rest of World",
                              "code": {
                                "countryCode": null
                              },
                              "provinces": []
                            }
                          ]
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 16,
      "actualQueryCost": 16,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 984,
        "restoreRate": 50
      }
    }
  }
}

DeliveryCountryAndZone

配送地域の名前をもつ国。

内容 | On this page

フィールド | Fields

country (DeliveryCountry!)
配送地域の国を指定します。

zone (String!)
配送地域の名前。

DeliveryCountryAndZone を返す型 | Types that return DeliveryCountryAndZone

DeliveryCountryCodeOrRestOfWorld

ISO 3166-1α2 の国コードと、Rest Of World を示すフラグです。

内容 | On this page

フィールド | Fields

countryCode (CountryCode)
国コードです。

restOfWorld (Boolean!)
Rest of World が適用されるかどうかを示します。

DeliveryCountryCodeOrRestOfWorld を返す型 | Types that return DeliveryCountryCodeOrRestOfWorld

DeliveryCountryCodesOrRestOfWorld

ISO 3166-1 alpha-2 の国コードまたは「Rest of World」のリストです。

内容 | On this page

フィールド | Fields

countryCodes ([CountryCode!]!)
適用可能な国コードのリスト。

restOfWorld (Boolean!)
Rest of World が適用されるかどうかを示す。

DeliveryCountryCodesOrRestOfWorld を返す型 | Types that return DeliveryCountryCodesOrRestOfWorld

DeliveryLegacyModeBlocked

ストアが複数配送プロファイルモードへの変換をブロックされているかどうか。

ストアがブロックされている場合は、ブロックの理由も返されます。

内容 | On this page

フィールド | Fields

blocked (Boolean!)
ストアが複数配配送元の変更ができるかどうか。

reasons ([DeliveryLegacyModeBlockedReason!])
ストアが複数配送元への変換を制御されている理由。

DeliveryLegacyModeBlocked を返す型 | Types that return DeliveryLegacyModeBlocked

DeliveryLocationGroup

ロケーショングループとは、配送プロファイル間で配送エリアや配送方法を共有するアクティブなロケーションの集まりです。

内容 | On this page

接続先 | Connections

location (LocationConnection!)
このロケーション・グループの一部であるアクティブなロケーションのリスト。

Argument Description
after (String) 指定されたカーソルの後にある要素を返します。
before (String) 指定されたカーソルの前にある要素を返します。
first (Int) リストの最初から n 個目の要素までを返します。
includeInactive (Boolean) true の場合、非アクティブになっているロケーションも含める。
デフォルト値 : false
includeLegacy (Boolean) true の場合、フルフィルメントサービスのレガシーロケーションも含めます。
デフォルト値 : false
last (Int) リストの最後から n 個目の要素までを返します。
query (String) サポートされるフィルタパラメータ :

active
address1
address2
city
country
legacy
name
province
zip

フィルターの使い方については、詳細な検索構文を参照してください。
reverse (Boolean) 対象となるリストの順序を逆にします。
デフォルト値 : false
sortKey (LocationSortKeys) 対象となるリストを、指定されたキーでソートします。
デフォルト値 : NAME

フィールド | Fields

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

DeliveryLocationGroup を返す型 | Types that return DeliveryLocationGroup

実装 | Implements

サンプル | Samples

Sample 1
# 配送先グループのIDを取得
{
  deliveryProfiles(first: 1) {
    edges {
      node {
        profileLocationGroups {
          locationGroup {
            id
          }
        }
      }
    }
  }
}
OUTPUT 1
{
  "data": {
    "deliveryProfiles": {
      "edges": [
        {
          "node": {
            "profileLocationGroups": [
              {
                "locationGroup": {
                  "id": "gid://shopify/DeliveryLocationGroup/20576075798"
                }
              }
            ]
          }
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 5,
      "actualQueryCost": 5,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 995,
        "restoreRate": 50
      }
    }
  }
}
Sample 2
# 配送プロファイル内で、共通の配送プロパティを持つオリジンロケーションのグループを取得する
{
  deliveryProfiles (first: 1) {
    edges {
      node {
        profileLocationGroups {
          locationGroup {
            id
            locations (first: 3) {
              edges {
                node {
                  id
                  name
                }
              }
            }
          }
        }
      }
    }
  }
}
OUTPUT 2
{
  "data": {
    "deliveryProfiles": {
      "edges": [
        {
          "node": {
            "profileLocationGroups": [
              {
                "locationGroup": {
                  "id": "gid://shopify/DeliveryLocationGroup/20576075798",
                  "locations": {
                    "edges": [
                      {
                        "node": {
                          "id": "gid://shopify/Location/17285971990",
                          "name": "Shopify Ottawa Office"
                        }
                      }
                    ]
                  }
                }
              }
            ]
          }
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 10,
      "actualQueryCost": 8,
      "throttleStatus": {
        "maximumAvailable": 1000,
        "currentlyAvailable": 992,
        "restoreRate": 50
      }
    }
  }
}

DeliveryLocationGroupZone

内容 | On this page

接続先 | Connections

methodDefinitions (DeliveryMethodDefinitionConnection!)
デリバリー・プロファイルのゾーンとロケーション・グループに関連するメソッド定義です。

Argument Description
after (String) 指定されたカーソルの後にある要素を返します。
before (String) 指定されたカーソルの前にある要素を返します。
eligible (Boolean) 適格または不適格なメソッドの定義のみを返します。
first (Int) リストの最初から n 個目の要素までを返します。
last (Int) リストの最後から n 個目の要素までを返します。
reverse (Boolean) 対象となるリストの順序を逆にします。
デフォルト値 : false
sortKey (MethodDefinitionsSortKeys) 対象となるリストを、指定されたキーでソートします。
デフォルト値 : NAME
type (DeliveryMethodDefinitionType) マーチャントまたはスタッフのメソッド定義のみを返します。

フィールド | Fields

methodDefinitionCounts (DeliveryMethodDefinitionCounts!)
このゾーンにあるメソッド定義の数。

zone (DeliveryZone!)
配送プロファイルのロケーショングループに関連するゾーン。

DeliveryLocationGroupZone を返す型 | Types that return DeliveryLocationGroupZone

複数の DeliveryLocationGroupZones をページングするための自動生成される型です。

内容 | On this page

フィールド | Fields

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

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

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

内容 | On this page

フィールド | Fields

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

node (DeliveryLocationGroupZone!)
デリバリーロケーショングループゾーンエッジの最後にあるアイテム。

DeliveryLocationGroupZoneEdge を返す型 | Types that return DeliveryLocationGroupZoneEdge

DeliveryMethod

配送方法。

内容 | On this page

フィールド | Fields

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

methodType (DeliveryMethodType!)
配送方法の型です。

DeliveryMethod を返す型 | Types that return DeliveryMethod

実装 | 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

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