Skip to main content
Required scopes: returns_write

Arguments

String
A key of your choosing. Repeating a call with the same key and the same arguments returns the first run rather than starting another.
[ID!]!
required
The ids of the returns to act on (1–500). Returns the action does not apply to are reported as skipped, not as an error.
Boolean!
required
Whether to notify each customer.

Returns

One run of a return action over a set of returns. A run works through its returns in the background; poll returnActionRun until status is no longer RUNNING.

Example