Anchor to section titled 'undefined'

return
query

Requires read_returns access scope.

Returns a Return resource by ID.

Anchor to section titled 'Arguments'

Arguments

Anchor to id
id
ID!
required

The ID of the Return to return.

Was this section helpful?
Anchor to section titled 'Return possible returns'

Return possible returns

Anchor to Return
Return
Return
Access requirements

Represents a return.

Was this section helpful?

Examples

Hide code
DescriptionCopy
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
        }
      }
    }
  }
}
Hide code
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": ""
          }
        }
      ]
    }
  }
}