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 Modes

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

ModeDescriptionConstraint
fully_receivedReceives the complete expected quantityNone
short_receivedReceives one less unit than expectedExpected quantity must be greater than 1
excess_receivedReceives one more unit than expectedNone
partially_receivedReceives only 1 unit regardless of expected quantityExpected quantity must be greater than 1

Dispositions

DispositionConstraint
returned_to_inventoryNone
reworkedAccount must have rework feature enabled
disposeNone
donateNone
return_to_merchantNone
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 255

Return Merchandise Authorization unique identifier.

string
enum
required

Sandbox return completion method.

Allowed:
string
enum
required

Item conclusion status at ShipMonk.

Allowed:
Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json