returnableFulfillment

query

Lookup a returnable fulfillment by ID.

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 returnable fulfillment, which is an order that has been delivered and is eligible to be returned to the merchant.

Was this section helpful?

Retrieve a returnable fulfillment and its line items.

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query {
6    returnableFulfillment(id: "gid://shopify/ReturnableFulfillment/607470790") {
7      id
8      fulfillment {
9        id
10        status
11      }
12      returnableFulfillmentLineItems(first: 5) {
13        edges {
14          node {
15            quantity
16            fulfillmentLineItem {
17              id
18              lineItem {
19                id
20                originalUnitPriceSet {
21                  shopMoney {
22                    amount
23                    currencyCode
24                  }
25                }
26                quantity
27                requiresShipping
28                taxable
29                unfulfilledQuantity
30              }
31            }
32          }
33        }
34      }
35    }
36  }`,
37);
38
39const data = await response.json();
40

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 -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/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 } } } } } } }"
}'

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 data = await response.json();

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
              }
            }
          }
        }
      }
    }
  }`,
});

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

1{
2  "returnableFulfillment": {
3    "id": "gid://shopify/ReturnableFulfillment/607470790",
4    "fulfillment": {
5      "id": "gid://shopify/Fulfillment/607470790",
6      "status": "SUCCESS"
7    },
8    "returnableFulfillmentLineItems": {
9      "edges": [
10        {
11          "node": {
12            "quantity": 2,
13            "fulfillmentLineItem": {
14              "id": "gid://shopify/FulfillmentLineItem/667843070",
15              "lineItem": {
16                "id": "gid://shopify/LineItem/571194661",
17                "originalUnitPriceSet": {
18                  "shopMoney": {
19                    "amount": "10.0",
20                    "currencyCode": "USD"
21                  }
22                },
23                "quantity": 2,
24                "requiresShipping": true,
25                "taxable": true,
26                "unfulfilledQuantity": 0
27              }
28            }
29          }
30        }
31      ]
32    }
33  }
34}