v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Sales

Return a sale

Initializes a return for an existing closed sale and returns the newly created SAVED return sale. Use this endpoint to start the return workflow before adding refund payments or finalizing the returned items. See the tutorial for more information.

🔒 Requires: sales:write users:read scopes

post/sales/{sale_id}/actions/return

Path parameters

sale_idstring required

A valid sale ID.

Response