2月 21, 2026

交換の作成、手数料の追加、返品ラインの削除、返品の計算が可能な新しいreturn API

2月 21, 2026

新APIによる返品の交換作成、手数料追加、返品ラインの削除、返品の計算

ShopifyのGraphQL Admin APIは、EC事業者が状況に応じて柔軟に返品・交換を管理できるよう、新たなAPIを導入しました。しかし、これらのAPIを適切に活用するためには専門的な知識が必要となります。

技術的課題の定義と現状分析

ShopifyのAPIを用いて返品・交換を管理する際、以下のような挑戦があります。

交換商品に対する新しいFulfillmentOrderの作成
返品ラインから商品を削除する機能
返品前に金額を計算し、適切な手数料や割引を適用する機能

具体的な技術的ソリューションの提案

2024年7月のGraphQL Admin APIでは、新たなreturn APIを使用して交換の基本要素とやり取りすることが可能になりました。具体的には、以下の3つの新機能が提供されています。

returnCreate mutation: 交換ラインアイテムを含む返品を作成し、新しいFulfillmentOrderを生成します。
returnLineItemRemoveFromReturn mutation: 返品から返品ラインを削除します。
returnCalculate query: 返品作成前に金額を計算します。

実装手順とコード例

1. returnCreate mutationの使用:


mutation {
  returnCreate(input: {
    order: "gid://shopify/Order/1",
    returnMerchandiseAuthorization: "gid://shopify/ReturnMerchandiseAuthorization/1",
    note: "Customer returned items",
    returnLineItems: [{
      lineItem: "gid://shopify/LineItem/1",
      quantity: 1,
      restockType: RETURN,
      location: "gid://shopify/Location/1"
    }],
    exchangeLineItems: [{
      variant: "gid://shopify/ProductVariant/1",
      quantity: 1
    }]
  }) {
    return {
      id
    }
    userErrors {
      field
      message
    }
  }
}

2. returnLineItemRemoveFromReturn mutationの使用:


mutation {
  returnLineItemRemoveFromReturn(input: {
    returnId: "gid://shopify/Return/1",
    returnLineItemId: "gid://shopify/ReturnLineItem/1"
  }) {
    returnLineItem {
      id
    }
    userErrors {
      field
      message
    }
  }
}

3. returnCalculate queryの使用:


query {
  returnCalculate(returnMerchandiseAuthorizationId: "gid://shopify/ReturnMerchandiseAuthorization/1", returnLineItems: [{
    lineItem: "gid://shopify/LineItem/1",
    quantity: 1,
    restockType: RETURN,
    location: "gid://shopify/Location/1"
  }], exchangeLineItems: [{
    variant: "gid://shopify/ProductVariant/1",
    quantity: 1
  }]) {
    calculatedReturn {
      id
    }
    userErrors {
      field
      message
    }
  }
}