Choose a version:

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

ReturnableFulfillment

•

ReturnableFulfillment

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

fulfillment• Fulfillment! non-null: The fulfillment that the returnable fulfillment refers to.
id• ID! non-null: The unique ID of the Returnable Fulfillment.
returnableFulfillmentLineItems • ReturnableFulfillmentLineItemConnection! non-null: The list of returnable fulfillment line items.

Was this section helpful?

Retrieve a returnable fulfillment and its line items.

Open in GraphiQL

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

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-07/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

{

"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

}

]

}