v3

latestOpenAPI 3.1.02026-08-0619186200.1 KB

Returns

Complete Return

This endpoint simulates the full return lifecycle on Sandbox environment. It can't be used in production!

The return goes through arrival, check-in, receiving, grading, and completion based on the specified completion mode and disposition.

Completion mode changes how many units are received of the FIRST item in the return. Other items are always fully received.

Mode	Description	Constraint
fully_received	Receives the complete expected quantity	None
short_received	Receives one less unit than expected	Expected quantity must be greater than 1
excess_received	Receives one more unit than expected	None
partially_received	Receives only 1 unit regardless of expected quantity	Expected quantity must be greater than 1

Disposition	Constraint
returned_to_inventory	None
reworked	Account must have rework feature enabled
dispose	None
donate	None
return_to_merchant	None

post/v1/integrations/sandbox/complete-return

rmastring required

Return Merchandise Authorization (RMA) number; must be unique per return and is used as the upsert key.

completion_mode'fully_received' | 'short_received' | 'excess_received' | 'partially_received' required

final_disposition'reworked' | 'returned_to_inventory' | 'return_to_merchant' | 'dispose' | 'donate' required

Success

statusinteger required