return Reason Definitions
Requires access scope.
Returns the full library of available return reason definitions.
Use this query to retrieve the standardized return reasons available for creating returns. Filter by IDs or handles to get specific definitions.
Only non-deleted reasons should be shown to customers when creating new returns. Deleted reasons have been replaced with better alternatives and are no longer recommended. However, they remain valid options and may still appear on existing returns.
ReturnReasonDefinitionConnection arguments
- after (String)
- before (String)
- first (Int)
- handles ([String!])
- ids ([ID!])
- last (Int)
- query (String)
- reverse (Boolean)
- sortKey (ReturnReasonDefinitionSortKeys)
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to handleshandles•[String!]
A list of return reason definition handles to filter by.
- •[ID!]
A list of return reason definition IDs to filter by.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Return
Key Reason Definition Sort Keys Default:ID Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Anchor to Possible returnsPossible returns
- edges ([ReturnReasonDefinitionEdge!]!)
- nodes ([ReturnReasonDefinition!]!)
- pageInfo (PageInfo!)
- Anchor to edgesedges•[Return
Reason Definition Edge!]! non-null The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
- Anchor to nodesnodes•[Return
Reason Definition!]! non-null A list of nodes that are contained in ReturnReasonDefinitionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
- Anchor to pageInfopage•Page
Info Info! non-null An object that’s used to retrieve cursor information about the current page.