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

この記事について

この記事は、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

Shipping and fulfillment APIs (MUTATIONS)

MUTATIONS

deliveryProfileCreate

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

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation deliveryProfileCreate($profile: DeliveryProfileInput!) {
  deliveryProfileCreate(profile: $profile) {
    profile {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "profile": {}
}

引数 | Arguments

Argument	Description
profile (DeliveryProfileInput!) required	配送プロファイルの入力フィールドを指定します。

DeliveryProfileInput フィールド | DeliveryProfileInput 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!])
削除するゾーン。

返却フィールド | Return fields

profile (DeliveryProfile)
作成された配送プロファイルです。

userErrors ([UserError!]!)
ミューテーションを実行して発生したエラーのリストです。

deliveryProfileRemove

配送プロファイルの削除／解除をエンキューします。

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation deliveryProfileRemove($id: ID!) {
  deliveryProfileRemove(id: $id) {
    job {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
id (ID!) required	削除するプロファイルの ID です。

返却フィールド | Return fields

job (Job)
ミューテーションによって引き起こされたプロファイル削除ジョブです。

userErrors ([UserError!]!)
ミューテーションを実行して発生したエラーのリストです。

deliveryProfileUpdate

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

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation deliveryProfileUpdate($id: ID!, $profile: DeliveryProfileInput!) {
  deliveryProfileUpdate(id: $id, profile: $profile) {
    profile {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "profile": {}
}

引数 | Arguments

Argument	Description
id (ID!) required	更新するプロファイルの ID です。
leaveLegacyModeProfiles (Boolean)	このプロファイルがレガシーモードを残すべきかどうかを指定します。
profile (DeliveryProfileInput!) required	配送プロファイルの入力フィールドを指定します。

DeliveryProfileInput フィールド | DeliveryProfileInput 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!])
削除するゾーン。

返却フィールド | Return fields

profile (DeliveryProfile)
更新された配送プロファイルです。

userErrors ([UserError!]!)
ミューテーションを実行して発生したエラーのリストです。

deliverySettingUpdate

ストアの配送設定を行います。

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation deliverySettingUpdate($setting: DeliverySettingInput!) {
  deliverySettingUpdate(setting: $setting) {
    setting {
      legacyModeProfiles
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "setting": {}
}

引数 | Arguments

Argument	Description
settings (DeliverySettingInput!) required	デリバリーショップのレベル設定の入力フィールドを指定します。

DeliverySettingInput フィールド | DeliverySettin 入力フィールド |gInput fields

legacyModeProfiles (Boolean)

マルチロケーション配送プロファイル機能のレガシーコンパティビリティモードを有効にします。

返却フィールド | Return fields

setting (DeliverySetting)
更新されたデリバリーショップレベルの設定です。

userErrors ([UserError!]!)
ミューテーションを実行した際に発生したエラーのリスト。

deliveryShippingOriginAssign

レガシー互換モードのプロファイルを使用しているときに、ロケーションを出荷元として割り当てることができます。

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation deliveryShippingOriginAssign($locationId: ID!) {
  deliveryShippingOriginAssign(locationId: $locationId) {
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "locationId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
located (ID!) required	出荷元として指定する場所の ID です。

返却フィールド | Return fields

userErrors ([UserError!]!)
ミューテーションを実行した際に発生したエラーのリスト。

fulfillmentCancel

フルフィルメントをキャンセルします。

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentCancel($id: ID!) {
  fulfillmentCancel(id: $id) {
    fulfillment {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
id (ID!) required	キャンセルするフルフィルメントの ID です。

返却フィールド | Return fields

fulfillment (Fulfillment)
キャンセルされたフルフィルメントです。

userErrors ([UserError!]!)
ミューテーションを実行した際に発生したエラーのリスト。

fulfillmentCreate

非推奨の警告
フルフィルメントを管理するには、新しい fulfillmentOrder API を使用します。

注文のフルフィルメントを作成します。

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

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentCreate($input: FulfillmentInput!) {
  fulfillmentCreate(input: $input) {
    fulfillment {
      id
    }
    order {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": {
    "orderId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
    "locationId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
  }
}

引数 | Arguments

Argument	Description
input (FulfillmentInput!) required	フルフィルメントの作成に使用される入力フィールドです。

FulfillmentInput フィールド | FulfillmentInput 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。

返却フィールド | Return fields

fulfillment (Fulfillment)
作成されたフルフィルメントです。

order (Order)
フルフィルメントが作成された注文です。

userErrors ([UserError!]!)
ミューテーションを実行して発生したエラーのリストです。

fulfillmentCreateV2

1 つまたは複数のフルフィルメント注文のフルフィルメントを作成します。

フルフィルメント注文は、同じ注文に関連付けられ、同じロケーションに割り当てられます。

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentCreateV2($fulfillment: FulfillmentV2Input!) {
  fulfillmentCreateV2(fulfillment: $fulfillment) {
    fulfillment {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "fulfillment": {
    "lineItemsByFulfillmentOrder": [
      {
        "fulfillmentOrderId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
      }
    ]
  }
}

引数 | Arguments

Argument	Description
fulfillment (FulfillmentV2Input!) required	フルフィルメント注文からフルフィルメントを作成するために使用される入力フィールドです。
message (String)	フルフィルメント要求に対するオプションのメッセージ。

FulfillmentV2Input フィールド | Return fields FulfillmentV2Input

lineItemsByFulfillmentOrder ([FulfillmentOrderLineItemsInput!]!) required
fulfillment_order_idとfulfillment_order_line_itemsのペアで、各フルフィルメントオーダーに対してフルフィルメントされなければならないフルフィルメントオーダーのラインアイテムを表します。

任意のペアについて、フルフィルメント注文の行項目が空白のままであれば、関連するフルフィルメント注文 ID のすべてのフルフィルメント注文の行項目が完了します。

notifyCustomer (Boolean)
顧客に通知されるかどうか。true に設定すると、フルフィルメントが作成されたときに通知が送信されます。

trackingInfo (FulfillmentTrackingInput)
フルフィルメントのトラッキング情報（トラッキング URL、トラッキング番号、フルフィルメントに関連する会社など）。

返却フィールド | Return fields

fulfillment (Fulfillment)
作成されたフルフィルメントです。

userErrors ([UserError!]!)
ミューテーションを実行した際に発生したエラーのリスト。

fulfillmentOrderAcceptCancellationRequest

フルフィルメントサービスに送信されたフルフィルメントオーダーのキャンセル要求を受理する。

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

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentOrderAcceptCancellationRequest($id: ID!) {
  fulfillmentOrderAcceptCancellationRequest(id: $id) {
    fulfillmentOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
id (ID!) required	キャンセル要求に関連したフルフィルメントオーダーの ID です。
message (String)	キャンセル要求を受理した理由。

返却フィールド | Return fields

fulfillmentOrder (FulfillmentOrder)
キャンセル要求が受け入れられたフルフィルメントオーダー。

userErrors ([UserError!]!)
ミューテーションを実行する際に発生したエラーのリスト。

fulfillmentOrderAcceptFulfillmentRequest

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

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

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentOrderAcceptFulfillmentRequest($id: ID!) {
  fulfillmentOrderAcceptFulfillmentRequest(id: $id) {
    fulfillmentOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
id (ID!) required	フルフィルメントリクエストに関連するフルフィルメントオーダーの ID です。
message (String)	フルフィルメント要求を受理した理由。

返却フィールド | Return fields

fulfillmentOrder (FulfillmentOrder)
フルフィルメント要求が受理されたフルフィルメントオーダーです。

userErrors ([UserError!]!)
ミューテーションを実行する際に発生したエラーのリスト。

fulfillmentOrderCancel

フルフィルメントオーダーをキャンセルしたとマークします。

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentOrderCancel($id: ID!) {
  fulfillmentOrderCancel(id: $id) {
    fulfillmentOrder {
      id
    }
    replacementFulfillmentOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
id (ID!) required	キャンセルされたことを表すフルフィルメントオーダーの ID です。

返却フィールド | Return fields

fulfillmentOrder (FulfillmentOrder)
キャンセルとしてマークされたフルフィルメントオーダー。

replacementFulfillmentOrder (FulfillmentOrder)
キャンセルされたフルフィルメントオーダーを置き換えるために作成されたフルフィルメントオーダー。

userErrors ([UserError!]!)
ミューテーションを実行する際に発生したエラーのリスト。

fulfillmentOrderClose

進行中のフルフィルメント注文に未完了のマークを付けることで、フルフィルメントサービスが残りのアイテムを出荷できなく、フルフィルメント注文の完了を示します。

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

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentOrderClose($id: ID!) {
  fulfillmentOrderClose(id: $id) {
    fulfillmentOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
id (ID!) required	未配送であるとマークするフルフィルメントオーダーの ID です。
message (String)	フルフィルメントオーダーを未配送としてマークする理由。

返却フィールド | Return fields

fulfillmentOrder (FulfillmentOrder)
不完全と判定されたフルフィルメントオーダー。

userErrors ([UserError!]!)
ミューテーションを実行して発生したエラーのリストです。

fulfillmentOrderHold

未処理のフルフィルメントオーダーにフルフィルメントホールドを適用します。

必要なアクセス
アプリは、write_merchant_managed_fulfillment_ordersまたはwrite_third_party_fulfillment_ordersのいずれかのアクセススコープを持っている必要があります。

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentOrderHold($id: ID!, $fulfillmentHold: FulfillmentOrderHoldInput!) {
  fulfillmentOrderHold(id: $id, fulfillmentHold: $fulfillmentHold) {
    fulfillmentOrder {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "fulfillmentHold": {
    "reason": "placeholder"
  }
}

引数 | Arguments

Argument	Description
fulfillmentHold (FulfillmentOrderHoldInput!) required	フルフィルメントオーダーに適用されたフルフィルメントホールドの詳細です。
id (ID!) required	フルフィルメントホールドが適用されているフルフィルメントオーダーの ID です。

FulfillmentOrderHoldInput フィールド | FulfillmentOrderHol 入力フィールド |dInput fields

notifyMerchant (Boolean)
フルフィルメントホールドに関する通知をマーチャントが受け取るかどうか。

reason (FulfillmentHoldReason!) required
フルフィルメントホールドの理由です。

reasonNotes (String)
フルフィルメントホールドの理由に関する追加情報。

返却フィールド | Return fields

fulfillmentOrder (FulfillmentOrder)
フルフィルメントホールドが適用されたフルフィルメントオーダーです。

userErrors ([FulfillmentOrderHoldUserError!]!)
ミューテーションを実行して発生したエラーのリストです。

fulfillmentOrderMove

フルフィルメントオーダーを新しい場所に移動します。

必要なアクセス
アプリは、正しいフルフィルメントオーダーのアクセススコープを持っている必要があります。

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentOrderMove($id: ID!, $newLocationId: ID!) {
  fulfillmentOrderMove(id: $id, newLocationId: $newLocationId) {
    movedFulfillmentOrder {
      id
    }
    originalFulfillmentOrder {
      id
    }
    remainingFulfillmentOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "newLocationId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
id (ID!) required	移動するフルフィルメントオーダーの ID です。
newLocation (ID!) required	フルフィルメントオーダーが移動される場所の ID です。

返却フィールド | Return fields

movedFulfillmentOrder (FulfillmentOrder)
新しい場所に移動することができたすべてのアイテムを表す新しいフルフィルメントオーダーです。

originalFulfillmentOrder (FulfillmentOrder)
移動されたフルフィルメントオーダー。成功すると、このフルフィルメントオーダーは閉じられます。

remainingFulfillmentOrder (FulfillmentOrder)
元の場所にまだ割り当てられているアイテムを表す新しいフルフィルメント オーダー。これは、元のフルフィルメントオーダー上のすべてのラインアイテムが、新しいロケーションにストックされていないために移動できなかった場合に作成されます。

userErrors ([UserError!]!)
ミューテーションを実行して発生したエラーのリストです。

fulfillmentOrderOpen

予定されているフルフィルメント注文をオープンにします。

必要なアクセス
アプリは、write_merchant_managed_fulfillment_ordersまたはwrite_third_party_fulfillment_ordersのいずれかのアクセススコープを持っている必要があります。

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentOrderOpen($id: ID!) {
  fulfillmentOrderOpen(id: $id) {
    fulfillmentOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
id (ID!) required	オープンとしてマークするフルフィルメントオーダーの ID です。

返却フィールド | Return fields

fulfillmentOrder (FulfillmentOrder)
オープンとマークされたフルフィルメントオーダー。

userErrors ([UserError!]!)
ミューテーションを実行して発生したエラーのリストです。

fulfillmentOrderRejectCancellationRequest

フルフィルメントサービスに送信されたフルフィルメントオーダーのキャンセル要求を拒否する。

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

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentOrderRejectCancellationRequest($id: ID!) {
  fulfillmentOrderRejectCancellationRequest(id: $id) {
    fulfillmentOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
id (ID!) required	キャンセル要求に関連するフルフィルメントオーダーの ID。
message (String)	キャンセル要求を拒否する理由（オプション）。

返却フィールド | Return fields

fulfillmentOrder (FulfillmentOrder)
キャンセル要求が拒否されたフルフィルメントオーダー。

userErrors ([UserError!]!)
ミューテーションを実行して発生したエラーのリストです。

fulfillmentOrderRejectFulfillmentRequest

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

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

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentOrderRejectFulfillmentRequest($id: ID!) {
  fulfillmentOrderRejectFulfillmentRequest(id: $id) {
    fulfillmentOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
id (ID!) required	フルフィルメントリクエストに関連するフルフィルメントオーダーの ID です。
message (String)	フルフィルメント要求を拒否するオプションの理由。

返却フィールド | Return fields

fulfillmentOrder (FulfillmentOrder)
フルフィルメント要求が拒否されたフルフィルメントオーダー。

userErrors ([UserError!]!)
ミューテーションを実行する際に発生したエラーのリスト。

fulfillmentOrderReleaseHold

フルフィルメント注文の保留を解除します。

必要なアクセス
アプリが、write_merchant_managed_fulfillment_orders または write_third_party_fulfillment_orders のアクセススコープを持っている必要があります。

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentOrderReleaseHold($id: ID!) {
  fulfillmentOrderReleaseHold(id: $id) {
    fulfillmentOrder {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
id (ID!) required	フルフィルメントホールドを解除するフルフィルメントオーダーの ID です。

返却フィールド | Return fields

fulfillmentOrder (FulfillmentOrder)
保留が解除されたフルフィルメントオーダー。

userErrors ([FulfillmentOrderReleaseHoldUserError!]!)
ミューテーションを実行して発生したエラーのリストです。

fulfillmentOrderReschedule

スケジュールされたフルフィルメントオーダーを再スケジュールします。

必要なアクセス
アプリがwrite_merchant_managed_fulfillment_orders または write_third_party_fulfillment_orders のアクセススコープを持っている必要があります。

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentOrderReschedule($id: ID!, $fulfillAt: DateTime!) {
  fulfillmentOrderReschedule(id: $id, fulfillAt: $fulfillAt) {
    fulfillmentOrder {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "fulfillAt": "placeholder"
}

引数 | Arguments

Argument	Description
fulfillAt (DateTime!) required	フルフィルメントオーダーの新しいフルフィルメントアットの日付。
id (ID!) required	スケジュールを変更するフルフィルメントオーダーの ID です。

返却フィールド | Return fields

fulfillmentOrder (FulfillmentOrder)
新しい fulfill at date に更新されたフルフィルメントオーダーです。

userErrors ([FulfillmentOrderRescheduleUserError!]!)
ミューテーションを実行して発生したエラーのリストです。

fulfillmentOrderSubmitCancellationRequest

フルフィルメントオーダーのフルフィルメントサービスへのキャンセル要求を送信します。

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

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentOrderSubmitCancellationRequest($id: ID!) {
  fulfillmentOrderSubmitCancellationRequest(id: $id) {
    fulfillmentOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
id (ID!) required	キャンセル要求に関連したフルフィルメントオーダーの ID です。
message (String)	キャンセル要求の理由（オプション）を指定します。

返却フィールド | Return fields

fulfillmentOrder (FulfillmentOrder)
キャンセルが要求されたフルフィルメントオーダー。

userErrors ([UserError!]!)
ミューテーションを実行した際に発生したエラーのリスト。

fulfillmentOrderSubmitFulfillmentRequest

フルフィルメントオーダーのフルフィルメントサービスにフルフィルメントリクエストを送信します。

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

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentOrderSubmitFulfillmentRequest($id: ID!) {
  fulfillmentOrderSubmitFulfillmentRequest(id: $id) {
    originalFulfillmentOrder {
      id
    }
    submittedFulfillmentOrder {
      id
    }
    unsubmittedFulfillmentOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
fulfillmentOrderLineItems ([FulfillmentOrderLineItemInput!]) required	フルフィルメントを要求されるフルフィルメントオーダーのラインアイテムです。 空白の場合、フルフィルメントオーダーのすべてのラインアイテムがフルフィルメントのために要求されます。
id (ID!) required	フルフィルメント要求に関連するフルフィルメントオーダーの ID。
message (String)	フルフィルメント要求に対するオプションのメッセージ。
notifyCustomer (Boolean)	このフルフィルメント注文に対してフルフィルメントが作成されたときに、顧客に通知するかどうか。
shippingMethod (String)	FREE_SHIPPING のような ShippingMethod コードへの参照です。

FulfillmentOrderLineItemInput フィールド | FulfillmentOrderLineItemInput fields

id (ID!) required
フルフィルメントオーダーのラインアイテムの ID です。

quantity (Int!) required
フルフィルメント注文のラインアイテムの数量です。

返却フィールド | Return fields

originalFulfillmentOrder (FulfillmentOrder)
フルフィルメントを要求するためのオリジナルのフルフィルメントオーダー。

submittedFulfillmentOrder (FulfillmentOrder)
フルフィルメント サービスに提出されたフルフィルメント オーダー。

これはオリジナルのフルフィルメントオーダーのフィールドと同じです。

この例外は、部分的なフルフィルメント リクエスト、またはキャンセルされた、または不完全なフルフィルメント オーダーのフルフィルメント リクエストです。

unsubmittedFulfillmentOrder (FulfillmentOrder)
このフィールドは、部分的なフルフィルメント要求に対してのみ存在する。

これは、フルフィルメントサービスに提出されていない残りのラインアイテムを持つ新しいフルフィルメントオーダーを表します。

userErrors ([UserError!]!)
ミューテーションを実行して発生したエラーのリストです。

fulfillmentServiceCreate

フルフィルメントサービスを作成します。

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

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentServiceCreate($name: String!) {
  fulfillmentServiceCreate(name: $name) {
    fulfillmentService {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "name": "placeholder"
}

引数 | Arguments

Argument	Description
callbackUrl (URL)	フルフィルメントサービスへのリクエストを送信するための URL です。
fulfillmentOrdersOptIn (Boolean)	フルフィルメントサービスが、フルフィルメント注文に基づいた新しいフルフィルメントリクエストフローを使用するかどうか。 デフォルト値：false
inventoryManagement (Boolean)	フルフィルメントサービスが製品のインベントリを管理し、Shopify に更新情報を提供するかどうかを指定します。 デフォルト値：false
name (String) required	フルフィルメントサービスの名前です。
trackingSupport (Boolean)	フルフィルメントサービスがパッケージの追跡番号を提供するかどうか。 デフォルト値：false

返却フィールド | Return fields

fulfillmentService (FulfillmentService)
作成されたフルフィルメントサービスです。

userErrors ([UserError!]!)
ミューテーションを実行した際に発生したエラーのリストです。

fulfillmentServiceDelete

フルフィルメントサービスを削除します。

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

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentServiceDelete($id: ID!) {
  fulfillmentServiceDelete(id: $id) {
    deletedId
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
destinationLocationId (ID)	フルフィルメントサービスが削除された後に、在庫やコミットメントが再配置される場所の ID です。
id (ID!) required	削除するフルフィルメント・サービスの ID です。

返却フィールド | Return fields

deletedId (ID)
削除されたフルフィルメントサービスの ID です。

userErrors ([UserError!]!)
ミューテーションを実行して発生したエラーのリストです。

fulfillmentServiceUpdate

フルフィルメントサービスの更新を行います。

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

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentServiceUpdate($id: ID!) {
  fulfillmentServiceUpdate(id: $id) {
    fulfillmentService {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
callbackUrl (URL)	フルフィルメントサービスへのリクエストを送信するための URL です。
fulfillmentOrdersOptIn (Boolean)	フルフィルメントサービスが、フルフィルメント注文に基づく新しいフルフィルメントリクエストフローを使用するかどうか。
id (ID!) required	フルフィルメントサービスの ID。
name (String) required	フルフィルメント・サービスの名前。
trackingSupport (Boolean)	フルフィルメント・サービスがパッケージの追跡番号を提供するかどうか。

返却フィールド | Return fields

fulfillmentService (FulfillmentService)
更新されたフルフィルメントサービスです。

userErrors ([UserError!]!)
ミューテーションを実行する際に発生したエラーのリスト。

fulfillmentTrackingInfoUpdate

非推奨の警告
フルフィルメントを管理するには、新しい fulfillmentOrder API を使用します。

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

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

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentTrackingInfoUpdate($fulfillmentId: ID!, $trackingInfoUpdateInput: TrackingInfoUpdateInput!) {
  fulfillmentTrackingInfoUpdate(
    fulfillmentId: $fulfillmentId
    trackingInfoUpdateInput: $trackingInfoUpdateInput
  ) {
    fulfillment {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "fulfillmentId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "trackingInfoUpdateInput": {}
}

引数 | Arguments

Argument	Description
fulfillmentId (ID!)	フルフィルメントの ID です。
trackingInfoUpdateInput (TrackingInfoUpdateInput!) required	ミューテーションの入力です。

TrackingInfoUpdateInput フィールド | TrackingInfoUpdateInput fields

notifyCustomer (Boolean)
このアップデートとこのフルフィルメントの今後のアップデートについて顧客に通知するかどうかを示します。

trackingCompany (String)
トラッキング会社の名前です。

trackingDetails ([TrackingInfoInput!])
フルフィルメントに関連する 1 つまたは複数のトラッキング URL および番号からなるトラッキング情報。

返却フィールド | Return fields

fulfillment (Fulfillment)
トラッキング情報付きの更新されたフルフィルメントです。

userErrors ([UserError!]!)
ミューテーションを実行した際に発生したエラーのリスト。

fulfillmentTrackingInfoUpdateV2

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

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation fulfillmentTrackingInfoUpdateV2($fulfillmentId: ID!, $trackingInfoInput: FulfillmentTrackingInput!) {
  fulfillmentTrackingInfoUpdateV2(
    fulfillmentId: $fulfillmentId
    trackingInfoInput: $trackingInfoInput
  ) {
    fulfillment {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "fulfillmentId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "trackingInfoInput": {}
}

引数 | Arguments

Argument	Description
fulfillmentId (ID!) required	フルフィルメントの ID です。
notifyCustomer (Boolean)	このフルフィルメントの今回の更新および今後の更新について顧客に通知するかどうか。
trackingInfoUpdateInput (TrackingInfoUpdateInput!) required	トラッキング URL、番号、および会社を含む、ミューテーションのトラッキング入力。

FulfillmentTrackingInput フィールド | FulfillmentTrackin 入力フィールド |gInput fields

company (String)
追跡会社の名前です。

number (String)
フルフィルメントのトラッキング番号。

url (URL)
フルフィルメントをトラッキングするための URL。

返却フィールド | Return fields

fulfillment (Fulfillment)
トラッキング情報付きの更新されたフルフィルメントです。

userErrors ([UserError!]!)
ミューテーションを実行した際に発生したエラーのリスト。

shippingPackageDelete

配送パッケージを削除します。

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation shippingPackageDelete($id: ID!) {
  shippingPackageDelete(id: $id) {
    deletedId
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
id (ID!)	配送パッケージの ID です。

返却フィールド | Return fields

deletedId (ID)
削除された配送パッケージの ID です。

userErrors ([UserError!]!)
ミューテーションを実行して発生したエラーのリストです。

shippingPackageMakeDefault

配送パッケージをデフォルトの配送パッケージとして設定します。

デフォルトの配送パッケージは、チェックアウト時の送料計算に使用されるパッケージです。

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation shippingPackageMakeDefault($id: ID!) {
  shippingPackageMakeDefault(id: $id) {
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
id (ID!)	デフォルトに設定する配送パッケージの ID です。

返却フィールド | Return fields

userErrors ([UserError!]!)
ミューテーションを実行した際に発生したエラーのリスト。

shippingPackageUpdate

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

参考例 | Interactive example

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使います。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

Query

mutation shippingPackageUpdate($id: ID!) {
  shippingPackageUpdate(id: $id) {
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数 | Arguments

Argument	Description
id (ID!) required	更新する配送パッケージの ID です。

返却フィールド | Return fields

userErrors ([UserError!]!)
ミューテーションを実行した際に発生したエラーのリスト。

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