Choose a version:

return

query

Requires read_returns access scope.

Returns a Return resource by ID.

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

Return

•

Return

Represents a return.

decline• ReturnDecline: Additional information about the declined return.
exchangeLineItems • ExchangeLineItemConnection! non-null: The exchange line items attached to the return.
id• ID! non-null: A globally-unique ID.
name• String! non-null: The name of the return.
order• Order! non-null: The order that the return belongs to.
refunds • RefundConnection! non-null: The list of refunds associated with the return.
returnLineItems • ReturnLineItemTypeConnection! non-null: The return line items attached to the return.
returnShippingFees• [ReturnShippingFee!]! non-null: The return shipping fees for the return.
reverseFulfillmentOrders • ReverseFulfillmentOrderConnection! non-null: The list of reverse fulfillment orders for the return.
status• ReturnStatus! non-null: The status of the return.
suggestedRefund• SuggestedReturnRefund: A suggested refund for the return.
totalQuantity• Int! non-null: The sum of all return line item quantities for the return.

Was this section helpful?

Get status and return line items for a return
Get status and return line items for a return (API Version 2024-04 and older)

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query {

return(id: "gid://shopify/Return/945000954") {

status

name

order {

}

returnLineItems(first: 10) {

edges {

node {

... on ReturnLineItem {

fulfillmentLineItem {

lineItem {

name

}

totalWeight {

value

}

quantity

returnReason

returnReasonNote

}

}`,

);

const data = await response.json();

query {
  return(id: "gid://shopify/Return/945000954") {
    status
    name
    order {
      id
    }
    returnLineItems(first: 10) {
      edges {
        node {
          ... on ReturnLineItem {
            fulfillmentLineItem {
              lineItem {
                name
              }
            }
            totalWeight {
              value
            }
          }
          quantity
          returnReason
          returnReasonNote
        }
      }
    }
  }
}

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 { return(id: \"gid://shopify/Return/945000954\") { status name order { id } returnLineItems(first: 10) { edges { node { ... on ReturnLineItem { fulfillmentLineItem { lineItem { name } } totalWeight { value } } quantity returnReason returnReasonNote } } } } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query {
    return(id: "gid://shopify/Return/945000954") {
      status
      name
      order {
        id
      }
      returnLineItems(first: 10) {
        edges {
          node {
            ... on ReturnLineItem {
              fulfillmentLineItem {
                lineItem {
                  name
                }
              }
              totalWeight {
                value
              }
            }
            quantity
            returnReason
            returnReasonNote
          }
        }
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    return(id: "gid://shopify/Return/945000954") {
      status
      name
      order {
        id
      }
      returnLineItems(first: 10) {
        edges {
          node {
            ... on ReturnLineItem {
              fulfillmentLineItem {
                lineItem {
                  name
                }
              }
              totalWeight {
                value
              }
            }
            quantity
            returnReason
            returnReasonNote
          }
        }
      }
    }
  }`,
});

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 {
    return(id: "gid://shopify/Return/945000954") {
      status
      name
      order {
        id
      }
      returnLineItems(first: 10) {
        edges {
          node {
            ... on ReturnLineItem {
              fulfillmentLineItem {
                lineItem {
                  name
                }
              }
              totalWeight {
                value
              }
            }
            quantity
            returnReason
            returnReasonNote
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"return": {

"status": "OPEN",

"name": "#1001-R1",

"order": {

"id": "gid://shopify/Order/625362839"

"returnLineItems": {

"edges": [

{

"node": {

"fulfillmentLineItem": {

"lineItem": {

"name": "Draft - 151cm"

}

"totalWeight": {

"value": 1500

"quantity": 1,

"returnReason": "UNKNOWN",

"returnReasonNote": ""

}

]

}