Skip to main content
Anchor to ReturnRequestPayload

ReturnRequestPayload

payload

Return type for returnRequest mutation.

•Return

The requested return.

•[ReturnUserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•mutation

Creates a return request that requires merchant approval before processing. The return has its status set to REQUESTED and the merchant must approve or decline it.

Use this mutation when customers initiate returns that need review. After creating a requested return, use returnApproveRequest to approve it or returnDeclineRequest to decline it.

For returns that should be immediately open for processing, use the returnCreate mutation instead.

Learn more about building return management workflows.

Arguments

•ReturnRequestInput!
required

The input fields for requesting a return.



Was this section helpful?