【Shopify.dev和訳】Admin API/GraphQL ref/Shipping & fulfillment⑤
この記事について
この記事は、Admin APIs/GraphQL reference/Shipping and fulfillmentの記事を和訳したものです。
記事内で使用する画像は、公式ドキュメント内の画像を引用して使用させていただいております。
Shopify アプリのご紹介
Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。
Shopify アプリである、「らくらく日本語フォント設定｜リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。
Shipping and fulfillment APIs (INPUTS, ENUMS)
INPUTS
DeliveryCountryInput
国を指定するための入力フィールド。
入力フィールド | Input fields
code (CountryCode)
国のカントリーコード。
includeAllProvinces (Boolean)
利用可能なすべての州をこの国に関連付ける。
provinces ([DeliveryProvinceInput!])
この国に関連付けられている地域を指定します。
restOfWorld (Boolean)
Rest of World を国として使用する。
DeliveryLocationGroupZoneInput
ロケーショングループとプロファイルに関連付けられた配送ゾーンの入力フィールドです。
入力フィールド | Input fields
countries ([DeliveryCountryInput!])
ゾーンに関連付ける国。
id (ID)
ゾーンのグローバルに一意な識別子。
methodDefinitionsToCreate ([DeliveryMethodDefinitionInput!])
作成するメソッド定義です。
methodDefinitionsToUpdate ([DeliveryMethodDefinitionInput!])
更新するメソッド定義を指定します。
name (String)
ゾーンの名前です。
DeliveryMethodDefinitionInput
メソッド定義の入力フィールド。
入力フィールド | Input fields
active (Boolean)
レート計算時にこのメソッド定義を使用するかどうか。
conditionsToUpdate ([DeliveryUpdateConditionInput!])
更新する方法定義の条件。
description (String)
メソッド定義の説明です。
id (ID)
メソッド定義のグローバルに一意な識別子。メソッド定義を更新する際にのみ使用します。
name (String)
メソッド定義の名前です。
participant (DeliveryParticipantInput)
メソッド定義に適用する参加者。
priceConditionsToCreate ([DeliveryPriceConditionInput!])
メソッド定義に適用する価格条件を入力します。
rateDefinition (DeliveryRateDefinitionInput)
メソッド定義に適用するレート定義です。
weightConditionsToCreate ([DeliveryWeightConditionInput!])
メソッド定義に適用される重量条件を指定します。
DeliveryParticipantInput
参加者の入力欄です。
入力フィールド | Input fields
adaptToNewServices (Boolean)
新しく利用できるサービスを含めるべきかどうかを示すフラグ。
carrierServiceId (ID)
キャリアサービスのグローバル識別子。
fixedFee (MoneyInput)
この参加者に対するマーチャント設定の固定料金。
id (ID)
参加者のグローバルに一意な識別子。
participantServices ([DeliveryParticipantServiceInput!])
参加者が提供するサービスとそのアクティブステータス。
percentageOfRateFee (Float)
このパーティシパントのマーチャント設定のパーセンテージオブレートフィー。
DeliveryParticipantServiceInput
参加者が提供するサービスの入力欄。
入力フィールド | Input fields
active (Boolean!) required
サービスがアクティブかどうか。
name (String!) required
サービスの名前です。
DeliveryPriceConditionInput
メソッド定義の価格ベースの条件の入力フィールド。
入力フィールド | Input fields
criteria (MoneyInput)
価格の基準です。
operator (DeliveryConditionOperator)
比較に使用する演算子。
DeliveryProfileInput
配送プロファイルの入力欄です。
入力フィールド | Input fields
conditionsToDelete ([ID!])
削除する条件。
locationGroupsToCreate ([DeliveryProfileLocationGroupInput!])
プロファイルに作成されるロケーショングループ。
locationGroupsToDelete ([ID!])
プロファイル内で削除されるロケーショングループを指定します。
locationGroupsToUpdate ([DeliveryProfileLocationGroupInput!])
プロファイル内で更新されるロケーショングループ。
methodDefinitionsToDelete ([ID!])
削除するメソッド定義を指定します。
name (String)
プロファイルの名前です。
profileLocationGroups ([DeliveryProfileLocationGroupInput!])
プロファイルに関連付けられたロケーショングループ。
sellingPlanGroupsToAssociate ([ID!])
このプロファイルに関連付けられる販売計画グループ。
sellingPlanGroupsToDissociate ([ID!])
このプロファイルに関連付けられていない販売プラングループです。
variantsToAssociate ([ID!])
このプロファイルに関連づけられる製品バリアント ID。
variantsToDissociate ([ID!])
このプロファイルから切り離され、デフォルトプロファイルに戻される製品バリアント ID。
zonesToDelete ([ID!])
削除するゾーン。
DeliveryProfileLocationGroupInput
プロファイルに関連付けられた配送先グループの入力フィールドです。
入力フィールド | Input fields
id (ID)
LocationGroup のグローバルに一意な識別子。
Location ([ID!])
このロケーショングループに移動されるロケーションのロケーション ID。
zonesToCreate ([DeliveryLocationGroupZoneInput!])
作成するゾーンを指定します。
zonesToUpdate ([DeliveryLocationGroupZoneInput!])
更新するゾーンを指定します。
DeliveryProvinceInput
地域を指定する入力欄です。
入力フィールド | Input fields
code (String!) required
地域のコードです。
DeliveryRateDefinitionInput
レート定義の入力フィールド。
入力フィールド | Input fields
id (ID)
レート定義のグローバルに一意な識別子。
price (MoneyInput!) required
レート定義の価格です。
DeliverySettingInput
ショップレベルの配送設定を行う入力フィールドです。
入力フィールド | Input fields
legacyModeProfiles (Boolean)
マルチロケーション配送プロファイル機能のレガシーコンパティビリティモードを有効にします。
DeliveryUpdateConditionInput
メソッド定義の条件を更新するための入力フィールド。
入力フィールド | Input fields
criteria (Float)
条件のクライテリアの値です。
criteriaUnit (String)
条件の基準の単位。
field (DeliveryConditionField)
使用するフィールド。total_weight または total_price のいずれか。
id (ID!) required
条件のグローバルに一意な識別子。
operator (DeliveryConditionOperator)
比較に使用する演算子。
DeliveryWeightConditionInput
メソッド定義の重量ベースの条件の入力フィールド。
入力フィールド | Input fields
criteria (WeightInput)
重量の基準です。
operator (DeliveryConditionOperator)
比較に使用する演算子。
FulfillmentInput
フルフィルメントの作成に使用される入力フィールドです。
入力フィールド | Input fields
lineItems ([FulfillmentLineItemInput!])
フルフィルメントの対象となるラインアイテムを指定します。
locationId (ID!) required
フルフィルメントの対象となるロケーションの ID です。
notifyCustomer (Boolean)
顧客に通知するかどうかを指定します。true に設定すると、フルフィルメントが作成されたときに通知が送信されます。
orderId (ID!) required
フルフィルメントされる注文の ID です。
shippingMethod (String)
Free Shipping などの配送方法への参照です。
trackingCompany (String)
追跡会社の名前です。
trackingNumbers ([String!])
フルフィルメントに関連するトラッキング番号です。
trackingUrls ([String!])
フルフィルメントをトラッキングするための URL。
FulfillmentLineItemInput
フルフィルメントに注文からのラインアイテムを含めるために使用される入力フィールドです。
入力フィールド | Input fields
id (ID!) required
ラインアイテムの ID です。
quantity (Int)
履行されるべきラインアイテムの数量です。
FulfillmentOrderHoldInput
フルフィルメントオーダーに適用されるフルフィルメントホールドの入力引数。
入力フィールド | Input fields
notifyMerchant (Boolean)
フルフィルメントホールドに関する通知をマーチャントが受け取るかどうか。
reason (FulfillmentHoldReason!) required
フルフィルメントホールドの理由です。
reasonNotes (String)
フルフィルメントホールドの理由に関する追加情報。
FulfillmentOrderLineItemInput
フルフィルメントオーダーからラインアイテムを含めるために使用される入力フィールドです。
入力フィールド | Input fields
id (ID!) required
フルフィルメントオーダーのラインアイテムの ID です。
quantity (Int!) required
フルフィルメント注文のラインアイテムの数量です。
FulfillmentOrderLineItemsInput
指定されたフルフィルメントオーダーのうち、フルフィルメントされるべきラインアイテムを含むために使用される入力フィールドです。
入力フィールド | Input fields
fulfillmentOrderId (ID!) required
フルフィルメントオーダーの ID。
fulfillmentOrderLineItems ([FulfillmentOrderLineItemInput!])
フルフィルメントされるフルフィルメントオーダーのラインアイテム。空白にすると、フルフィルメントオーダーのすべてのラインアイテムが履行されます。
FulfillmentOriginAddressInput
入力欄には、フルフィルメントが発生した場所の住所を入力します。
入力フィールド | Input fields
address1 (String)
フルフィルメントする場所の住所。
address2 (String)
住所の 2 行目。通常は、アパート、スイート、またはユニットの番号です。
city (String)
フルフィルメント施設がある都市。
countryCode (String!) required
フルフィルメントの所在地の国。
provinceCode (String)
フルフィルメントの所在地の都道府県。
zip (String)
フルフィルメントの所在地の郵便番号。
FulfillmentTrackingInput
トラッキング情報に使用可能なすべてのフィールドを指定するための入力フィールドです。
入力フィールド | Input fields
company (String)
追跡会社の名前です。
number (String)
フルフィルメントのトラッキング番号。
url (URL)
フルフィルメントをトラッキングするための URL。
FulfillmentV2Input
フルフィルメント注文からフルフィルメントを作成するために使用される入力フィールドです。
入力フィールド | Input fields
lineItemsByFulfillmentOrder ([FulfillmentOrderLineItemsInput!]!) required
fulfillment_order_idとfulfillment_order_line_itemsのペアで、各フルフィルメントオーダーに対して履行されなければならないフルフィルメントオーダーのラインアイテムを表します。
任意のペアについて、フルフィルメント注文の行項目が空白のままであれば、関連するフルフィルメント注文 ID のすべてのフルフィルメント注文の行項目が満たされます。
notifyCustomer (Boolean)
顧客に通知されるかどうか。true に設定すると、フルフィルメントが作成されたときに通知が送信されます。
trackingInfo (FulfillmentTrackingInput)
フルフィルメントのトラッキング情報（トラッキング URL、トラッキング番号、フルフィルメントに関連する会社など）。
TrackingInfoInput
トラッキング情報のフィールドを指定します。
入力フィールド | Input fields
number (String)
フルフィルメントのトラッキング番号です。
url (String)
フルフィルメントをトラッキングするための URL です。
TrackingInfoUpdateInput
トラッキング情報を更新するために可能なすべてのフィールドを指定します。
入力フィールド | Input fields
notifyCustomer (Boolean)
この更新とこのフルフィルメントの今後の更新について顧客に通知するかどうかを示します。
trackingCompany (String)
トラッキング会社の名前。
trackingDetails ([TrackingInfoInput!])
フルフィルメントに関連する 1 つまたは複数のトラッキング URL および番号からなるトラッキング情報。
ENUMS
DeliveryConditionField
条件が適用されるフィールドタイプ。
値 | Values
TOTAL_PRICE
条件は、注文の合計金額に対してチェックします。
TOTAL_WEIGHT
注文の総重量を確認するための条件。
DeliveryConditionField を返す型 | Types that return DeliveryConditionField
DeliveryConditionOperator
条件を満たしているかどうかを判断するための演算子です。
値 | Values
vGREATER_THAN_OR_EQUAL_TO
条件は、フィールドが基準よりも大きいか等しいかをチェックします。
LESS_THAN_OR_EQUAL_TO
条件は、フィールドが基準より小さいか等しいかをチェックします。
DeliveryConditionOperator を返す型 | Types that return DeliveryConditionOperator
DeliveryLegacyModeBlockedReason
その理由は、ショップが多拠点配送のプロファイルモードに完全に移行できないことにあります。
値 | Values
MULTI_LOCATION_DISABLED
マルチロケーションが無効になっています。
NO_LOCATIONS_FULFILLING_ONLINE_ORDERS
オンライン注文に対応できるロケーションがありません。
DeliveryLegacyModeBlockedReason を返す型 | Types that return DeliveryLegacyModeBlockedReason
DeliveryMethodDefinitionType
さまざまなタイプのメソッドの定義でフィルタリングすることができます。
値 | Values
MERCHANT
静的なマーチャント定義のレート。
PARTICIPANT
動的な参加者のレート。
DeliveryMethodType
配送方法が持つ可能性のある方法の種類。
値 | Values
LOCAL
地域の配送方法。
NONE
配送方法がありません。
PICK_UP
配送方法をピックアップする。
RETAIL
小売店ですぐに商品をお届けする配送方法です。
SHIPPING
配送方法を表します。
DeliveryMethodType を返す型 | Types that return DeliveryMethodType
FulfillmentDisplayStatus
フルフィルメントの表示状態です。
値 | Values
ATTEMPTED_DELIVERY
配送完了と表示されます。
CANCELED
キャンセルされたと表示されます。
CONFIRMED
確認されたと表示される。
DELIVERED
配送されたと表示されます。
FAILURE
失敗と表示されます。
FULFILLED
履行されたと表示される。
IN_TRANSIT
移動中と表示される。
LABEL_PRINTED
ラベルが印刷されたと表示される。
LABEL_PURCHASE
購入されたラベルとして表示される。
LABEL_VOIDED
無効化されたラベルが表示された。
MARKED_AS_FULFILLED
フルフィルメントとして印をつけたと表示される。
NOT_DELIVERED
配送されていないと表示される。
OUT_FOR_DELIVERY
未配送と表示される。
PICKED_UP
受け取り済みと表示される。
READY_FOR_PICKUP
集荷の準備ができていると表示される。
SUBMITTED
提出済みと表示されます。
FulfillmentDisplayStatus を返す型 | Types that return FulfillmentDisplayStatus
FulfillmentEventSortKeys
FulfillmentEvent クエリの有効なソートキーのセットです。
値 | Values
HAPPENED_AT
happened_atの値でソートします。
ID
idの値でソートします。
RELEVANCE
検索時（接続時にqueryパラメータが指定されている場合）に、検索語との関連性で結果をソートします。検索クエリが指定されていない場合、このソートキーは確定的ではないため、使用しないでください。
FulfillmentEventStatus
イベントステータスは、フルフィルメントの状態を表すものです。
値 | Values
ATTEMPTED_DELIVERY
配信が試行されました。
CONFIRMED
フルフィルメントが確認されました。
DELIVERED
フルフィルメントは正常に配信されました。
FAILURE
フルフィルメントの要求が失敗しました。
IN_TRANSIT
フルフィルメントは配送中です。
LABEL_PRINTED
購入した配送ラベルが印刷されました。
LABEL_PURCHASE
配送ラベルが購入された。
OUT_FOR_DELIVERY
フルフィルメントが配送中です。
READY_FOR_PICKUP
フルフィルメントは、集荷の準備ができています。
FulfillmentEventStatus を返す型 | Types that return FulfillmentEventStatus
FulfillmentHoldReason
フルフィルメントホールドの理由について
値 | Values
AWAITING_PAYMENT
支払いが保留されているため、フルフィルメントホールドが適用されています。
HIGH_RISK_OF_FRAUD
フルフィルメントの保留は、詐欺のリスクが高いために適用されます。
INCORRECT_ADDRESS
住所が間違っているため、フルフィルメントの保留が適用されています。
INVENTORY_OUT_OF_STOCK
在庫がないため、フルフィルメントの保留が適用されています。
OTHER
フルフィルメントの保留が他の理由で適用されている。
FulfillmentHoldReason を返す型 | Types that return FulfillmentHoldReason
FulfillmentOrderAction
フルフィルメントオーダーに対して行うことができるアクションです。
値 | Values
CANCEL_FULFILLMENT_ORDER
フルフィルメントオーダーをキャンセルします。このアクションに対応するミューテーションは、FulfillmentOrderCancel です。
CREATE_FULFILLMENT
フルフィルメントオーダーの選択されたラインアイテムのフルフィルメントを作成します。このアクションに対応するミューテーションは FulfillmentCreateV2 です。
EXTERNAL
Shopify の外でフルフィルメントプロセスを開始するために外部 URL を開きます。
MARK_AS_OPEN
フルフィルメント注文をオープンとしてマークします。
MOVE
フルフィルメント注文を移動します。このアクションに対応するミューテーションは FulfillmentOrderMove です。
REQUEST_CANCELLATION
フルフィルメント オーダーのフルフィルメント サービスにキャンセル要求を送信する。このアクションに対応するミューテーションは FulfillmentOrderSubmitCancellationRequest です。
REQUEST_FULFILLMENT
フルフィルメントオーダーの選択されたラインアイテムを満たすためのリクエストをフルフィルメントサービスに送信します。このアクションに対応するミューテーションは FulfillmentOrderSubmitFulfillmentRequest です。
FulfillmentOrderAction を返す型 | Types that return FulfillmentOrderAction
FulfillmentOrderAssignmentStatus
フルフィルメントオーダーのフィルタリングに使用されるアサインメントステータス。
値 | Values
CANCELLATION_REQUESTED
マーチャントが以前受理したフルフィルメントリクエストのキャンセルを要求したフルフィルメントオーダー。
FULFILLMENT_ACCEPTED
マーチャントのフルフィルメント要求が受理されたフルフィルメント注文。要求されたアイテムを完全に満たすために、これらのフルフィルメントオーダーに任意の数のフルフィルメントを作成することができます。
FULFILLMENT_REQUESTED
マーチャントがフルフィルメントを要求したフルフィルメント注文です。
FulfillmentOrderMerchantRequestKind
マーチャントがフルフィルメントサービスに依頼できる内容。
値 | Values
CANCELLATION_REQUEST
マーチャントが受理したフルフィルメントオーダーまたは進行中のフルフィルメントオーダーのキャンセルを要求しました。
FULFILLMENT_REQUEST
マーチャントがフルフィルメント注文のフルフィルメントを要求しました。
FulfillmentOrderMerchantRequestKind を返す型 | Types that return FulfillmentOrderMerchantRequestKind
FulfillmentOrderRequestStatus
フルフィルメントオーダーのリクエストステータス。
値 | Values
ACCEPTED
フルフィルメントサービスは、マーチャントのフルフィルメントリクエストを受け入れた。
CANCELLATION_ACCEPTED
フルフィルメントサービスはマーチャントのフルフィルメントキャンセル要求を受理しました。
CANCELLATION_REJECTED
フルフィルメントサービスは、マーチャントのフルフィルメントキャンセル要求を拒否しました。
CANCELLATION_REQUESTED
マーチャントは、このフルフィルメント注文のキャンセルを要求しました。
CLOSED
フルフィルメントサービスは、フルフィルメント注文を完了せずに閉じました。
REJECTED
フルフィルメントサービスは、マーチャントのフルフィルメントリクエストを拒否しました。
SUBMITTED
マーチャントはこのフルフィルメント注文に対してフルフィルメントを要求しました。
UNSUBMITTED
新規に作成されたフルフィルメント注文の最初のリクエストステータスです。これは、フルフィルメント サービスに割り当てられていないフルフィルメント注文の唯一の有効な要求ステータスです。
FulfillmentOrderRequestStatus を返す型 | Types that return FulfillmentOrderRequestStatus
FulfillmentOrderSortKeys
FulfillmentOrder クエリの有効なソートキーのセットです。
値 | Values
ID
ID の値でソートします。
RELEVANCE
検索時（接続時にqueryパラメータが指定されている場合）に、検索語との関連性で結果をソートします。検索クエリが指定されていない場合、このソートキーは確定的ではないため、使用しないでください。
FulfillmentOrderStatus
フルフィルメントオーダーのステータス。
値 | Values
CANCELLED
フルフィルメントオーダーがマーチャントによってキャンセルされました。
CLOSED
フルフィルメントオーダーは完了し、終了しました。
INCOMPLETE
フルフィルメントオーダーは要求どおりに完了できません。
IN_PROGRESS
フルフィルメントの注文は処理中です。
ON_HOLD
フルフィルメントの注文は保留されており、処理することができません。
OPEN
フルフィルメントの注文が開始されました。
SCHEDULED
フルフィルメントの注文は、フルフィルメントの予定です。
FulfillmentOrderStatus を返す型 | Types that return FulfillmentOrderStatus
FulfillmentServiceType
フルフィルメントサービスの種類です。
値 | Values
GIFT_CARD
ギフトカードによるフルフィルメント。
MANUAL
マーチャントによるマニュアルフルフィルメント。
THIRD_PARTY
第三者のフルフィルメントサービスによるフルフィルメント。
FulfillmentServiceType を返す型 | Types that return FulfillmentServiceType
FulfillmentStatus
フルフィルメントの状態です。
値 | Values
CANCELLED
フルフィルメントがキャンセルされました。
ERROR
フルフィルメントのリクエストにエラーがありました。
FAILURE
フルフィルメント要求が失敗しました。
OPEN
サードパーティのフルフィルメントサービスがフルフィルメントを承認し、処理しています。
PENDING
Shopify はフルフィルメントを作成し、サードパーティのフルフィルメントサービスがopenまたはsuccessに移行するのを待っています。
SUCCESS
フルフィルメントは正常に完了しました。
FulfillmentStatus を返す型 | Types that return FulfillmentStatus
MethodDefinitionSortKeys
MethodDefinition クエリの有効なソート・キーのセットです。
値 | Values
ID
idの値でソートします。
RATE_PROVIDER_TYPE
rate_provider_typeの値でソートします。
RELEVANCE
検索時（接続時にqueryパラメータが指定されている場合）に、検索語との関連性で結果をソートします。検索クエリが指定されていない場合、このソートキーは決定性がないため、使用しないでください。
ProfileItemSortKeys
ProfileItem クエリの有効なソートキーのセット。
値 | Values
CREATED_AT
created_atの値でソートします。
ID
IDの値でソートします。
INVENTORY_TOTAL
inventory_totalの値でソートします。
PRODUCT_TYPE
Product_typeの値でソートします。
PUBLISHED_AT
published_atの値でソートします。
RELEVANCE
検索時（接続時にqueryパラメータが指定されている場合）に、検索語との関連性で結果をソートします。検索クエリが指定されていない場合、このソートキーは決定性がないため、使用しないでください。
TITLE
titleの値でソートします。
UPDATED_AT
updated_atの値でソートします。
VENDOR
venderの値でソートします。
Shopify アプリのご紹介
Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。
Shopify アプリである、「らくらく日本語フォント設定｜リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。
Discussion