ReturnableFulfillment - admin-graphql - OBJECT

Version: 2025-01

Description:

A returnable fulfillment, which is an order that has been delivered and is eligible to be returned to the merchant.

Access Scopes

`read_orders` access scope or `read_marketplace_orders` access scope. Also: Requires the `read_returns` access scope.

Fields

• fulfillment: Fulfillment! - The fulfillment that the returnable fulfillment refers to.
• id: ID! - The unique ID of the Returnable Fulfillment.

Connections

• returnableFulfillmentLineItems: ReturnableFulfillmentLineItemConnection!

Related queries

• returnableFulfillment Lookup a returnable fulfillment by ID.
• returnableFulfillments List of returnable fulfillments.

Related mutations

Related Unions

Examples

• Retrieve a returnable fulfillment and its line items.

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"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 } } } } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    returnableFulfillment(id: \"gid://shopify/ReturnableFulfillment/607470790\") {\n      id\n      fulfillment {\n        id\n        status\n      }\n      returnableFulfillmentLineItems(first: 5) {\n        edges {\n          node {\n            quantity\n            fulfillmentLineItem {\n              id\n              lineItem {\n                id\n                originalUnitPriceSet {\n                  shopMoney {\n                    amount\n                    currencyCode\n                  }\n                }\n                quantity\n                requiresShipping\n                taxable\n                unfulfilledQuantity\n              }\n            }\n          }\n        }\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    returnableFulfillment(id: \"gid://shopify/ReturnableFulfillment/607470790\") {\n      id\n      fulfillment {\n        id\n        status\n      }\n      returnableFulfillmentLineItems(first: 5) {\n        edges {\n          node {\n            quantity\n            fulfillmentLineItem {\n              id\n              lineItem {\n                id\n                originalUnitPriceSet {\n                  shopMoney {\n                    amount\n                    currencyCode\n                  }\n                }\n                quantity\n                requiresShipping\n                taxable\n                unfulfilledQuantity\n              }\n            }\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    returnableFulfillment(id: \"gid://shopify/ReturnableFulfillment/607470790\") {\n      id\n      fulfillment {\n        id\n        status\n      }\n      returnableFulfillmentLineItems(first: 5) {\n        edges {\n          node {\n            quantity\n            fulfillmentLineItem {\n              id\n              lineItem {\n                id\n                originalUnitPriceSet {\n                  shopMoney {\n                    amount\n                    currencyCode\n                  }\n                }\n                quantity\n                requiresShipping\n                taxable\n                unfulfilledQuantity\n              }\n            }\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    returnableFulfillment(id: \"gid://shopify/ReturnableFulfillment/607470790\") {\n      id\n      fulfillment {\n        id\n        status\n      }\n      returnableFulfillmentLineItems(first: 5) {\n        edges {\n          node {\n            quantity\n            fulfillmentLineItem {\n              id\n              lineItem {\n                id\n                originalUnitPriceSet {\n                  shopMoney {\n                    amount\n                    currencyCode\n                  }\n                }\n                quantity\n                requiresShipping\n                taxable\n                unfulfilledQuantity\n              }\n            }\n          }\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  returnableFulfillment(id: \"gid://shopify/ReturnableFulfillment/607470790\") {\n    id\n    fulfillment {\n      id\n      status\n    }\n    returnableFulfillmentLineItems(first: 5) {\n      edges {\n        node {\n          quantity\n          fulfillmentLineItem {\n            id\n            lineItem {\n              id\n              originalUnitPriceSet {\n                shopMoney {\n                  amount\n                  currencyCode\n                }\n              }\n              quantity\n              requiresShipping\n              taxable\n              unfulfilledQuantity\n            }\n          }\n        }\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "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
                  }
                }
              }
            }
          ]
        }
      }
    }
  }