Skip to main content

List return codes

Gets all valid return codes.

Responses
200

A collection of all valid return codes.

Schema OPTIONAL
Resource object[] OPTIONAL

The resource on which the action was taken.

Code int32 OPTIONAL

The numerical code for the return code.

Name string OPTIONAL

The name of the return code.

AddToStock boolean OPTIONAL

If true, any return using this code is suggested to restock the product. This is just used to suggest default behaviour - the actual choice is entirely up to the author of the return.

DefaultReturnAction int32 OPTIONAL

The default return action for this return code. This is used to determine what type of refund should be created when a return is created using this return code. This is just used to suggest default behaviour - the actual choice is entirely up to the author of the return.

Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.