Choose a version:

returnableFulfillment

query

Returns a ReturnableFulfillment resource by ID.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the ReturnableFulfillment to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to ReturnableFulfillmentReturnableFulfillment •ReturnableFulfillment: A delivered order that's eligible to be returned to the merchant. Provides the items from completed fulfillments that customers can select when initiating a return.

Use returnable fulfillments to determine which items are eligible for return before creating a Return with the returnCreate mutation. The line items show quantities that are available for return.

Learn more about building return management workflows.

Was this section helpful?

Examples

Retrieve a returnable fulfillment and its line items.

Description

A returnable fulfillment contains fulfillment line items that are eligible for a return. To create a return, use the `returnCreate` or `returnRequest` mutations. The `id` of each `fulfillmentLineItem` returned in this query can be used in the mutation input.

Query

query {
  returnableFulfillment(id: "gid://shopify/ReturnableFulfillment/607470790") {
    id
    fulfillment {
      id
      status
    }
    returnableFulfillmentLineItems(first: 5) {
      edges {
        node {
          quantity
          fulfillmentLineItem {
            id
            lineItem {
              id
              originalUnitPriceSet {
                shopMoney {
                  amount
                  currencyCode
                }
              }
              quantity
              requiresShipping
              taxable
              unfulfilledQuantity
            }
          }
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { returnableFulfillment(id: \"gid://shopify/ReturnableFulfillment/607470790\") { id fulfillment { id status } returnableFulfillmentLineItems(first: 5) { edges { node { quantity fulfillmentLineItem { id lineItem { id originalUnitPriceSet { shopMoney { amount currencyCode } } quantity requiresShipping taxable unfulfilledQuantity } } } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    returnableFulfillment(id: "gid://shopify/ReturnableFulfillment/607470790") {
      id
      fulfillment {
        id
        status
      }
      returnableFulfillmentLineItems(first: 5) {
        edges {
          node {
            quantity
            fulfillmentLineItem {
              id
              lineItem {
                id
                originalUnitPriceSet {
                  shopMoney {
                    amount
                    currencyCode
                  }
                }
                quantity
                requiresShipping
                taxable
                unfulfilledQuantity
              }
            }
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    returnableFulfillment(id: "gid://shopify/ReturnableFulfillment/607470790") {
      id
      fulfillment {
        id
        status
      }
      returnableFulfillmentLineItems(first: 5) {
        edges {
          node {
            quantity
            fulfillmentLineItem {
              id
              lineItem {
                id
                originalUnitPriceSet {
                  shopMoney {
                    amount
                    currencyCode
                  }
                }
                quantity
                requiresShipping
                taxable
                unfulfilledQuantity
              }
            }
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    returnableFulfillment(id: "gid://shopify/ReturnableFulfillment/607470790") {
      id
      fulfillment {
        id
        status
      }
      returnableFulfillmentLineItems(first: 5) {
        edges {
          node {
            quantity
            fulfillmentLineItem {
              id
              lineItem {
                id
                originalUnitPriceSet {
                  shopMoney {
                    amount
                    currencyCode
                  }
                }
                quantity
                requiresShipping
                taxable
                unfulfilledQuantity
              }
            }
          }
        }
      }
    }
  }`,
});

Response

{
  "returnableFulfillment": {
    "id": "gid://shopify/ReturnableFulfillment/607470790",
    "fulfillment": {
      "id": "gid://shopify/Fulfillment/607470790",
      "status": "SUCCESS"
    },
    "returnableFulfillmentLineItems": {
      "edges": [
        {
          "node": {
            "quantity": 2,
            "fulfillmentLineItem": {
              "id": "gid://shopify/FulfillmentLineItem/667843070",
              "lineItem": {
                "id": "gid://shopify/LineItem/571194661",
                "originalUnitPriceSet": {
                  "shopMoney": {
                    "amount": "10.0",
                    "currencyCode": "USD"
                  }
                },
                "quantity": 2,
                "requiresShipping": true,
                "taxable": true,
                "unfulfilledQuantity": 0
              }
            }
          }
        }
      ]
    }
  }
}

Retrieve a returnable fulfillment and its line items.

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query {

returnableFulfillment(id: "gid://shopify/ReturnableFulfillment/607470790") {

fulfillment {

status

}

returnableFulfillmentLineItems(first: 5) {

edges {

node {

quantity

fulfillmentLineItem {

lineItem {

originalUnitPriceSet {

shopMoney {

amount

currencyCode

}

quantity

requiresShipping

taxable

unfulfilledQuantity

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  returnableFulfillment(id: "gid://shopify/ReturnableFulfillment/607470790") {
    id
    fulfillment {
      id
      status
    }
    returnableFulfillmentLineItems(first: 5) {
      edges {
        node {
          quantity
          fulfillmentLineItem {
            id
            lineItem {
              id
              originalUnitPriceSet {
                shopMoney {
                  amount
                  currencyCode
                }
              }
              quantity
              requiresShipping
              taxable
              unfulfilledQuantity
            }
          }
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { returnableFulfillment(id: \"gid://shopify/ReturnableFulfillment/607470790\") { id fulfillment { id status } returnableFulfillmentLineItems(first: 5) { edges { node { quantity fulfillmentLineItem { id lineItem { id originalUnitPriceSet { shopMoney { amount currencyCode } } quantity requiresShipping taxable unfulfilledQuantity } } } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    returnableFulfillment(id: "gid://shopify/ReturnableFulfillment/607470790") {
      id
      fulfillment {
        id
        status
      }
      returnableFulfillmentLineItems(first: 5) {
        edges {
          node {
            quantity
            fulfillmentLineItem {
              id
              lineItem {
                id
                originalUnitPriceSet {
                  shopMoney {
                    amount
                    currencyCode
                  }
                }
                quantity
                requiresShipping
                taxable
                unfulfilledQuantity
              }
            }
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    returnableFulfillment(id: "gid://shopify/ReturnableFulfillment/607470790") {
      id
      fulfillment {
        id
        status
      }
      returnableFulfillmentLineItems(first: 5) {
        edges {
          node {
            quantity
            fulfillmentLineItem {
              id
              lineItem {
                id
                originalUnitPriceSet {
                  shopMoney {
                    amount
                    currencyCode
                  }
                }
                quantity
                requiresShipping
                taxable
                unfulfilledQuantity
              }
            }
          }
        }
      }
    }
  }`,
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    returnableFulfillment(id: "gid://shopify/ReturnableFulfillment/607470790") {
      id
      fulfillment {
        id
        status
      }
      returnableFulfillmentLineItems(first: 5) {
        edges {
          node {
            quantity
            fulfillmentLineItem {
              id
              lineItem {
                id
                originalUnitPriceSet {
                  shopMoney {
                    amount
                    currencyCode
                  }
                }
                quantity
                requiresShipping
                taxable
                unfulfilledQuantity
              }
            }
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"returnableFulfillment": {

"id": "gid://shopify/ReturnableFulfillment/607470790",

"fulfillment": {

"id": "gid://shopify/Fulfillment/607470790",

"status": "SUCCESS"

"returnableFulfillmentLineItems": {

"edges": [

{

"node": {

"quantity": 2,

"fulfillmentLineItem": {

"id": "gid://shopify/FulfillmentLineItem/667843070",

"lineItem": {

"id": "gid://shopify/LineItem/571194661",

"originalUnitPriceSet": {

"shopMoney": {

"amount": "10.0",

"currencyCode": "USD"

}

"quantity": 2,

"requiresShipping": true,

"taxable": true,

"unfulfilledQuantity": 0

}

]

}