Orders / Return

Name	Orders Return
Description	Create a return for an order.
Type	POST
URL	/v9/orders/:id/return

Long Description

A return on an order is a reduction in the value of the order, with the expectation that you will refund all or part of the funds to the buyer.

Note that if the amount exceeds the total of the order, it will create a return for the value of the order total, and a penalty for the remaining value.

Performing a return will automatically create a corresponding credit memo for the amount.

Parameters

Name	Description	Value Type	Required
amount	The amount you wish to return	decimal	Required
cancel_order	Transition the order state to canceled post-acceptance.	boolean	Optional
reviewer_id	The ID of a user belonging to the brokerage	integer	Required if cancel_order is true
reason	The reason for the cancellation. Must be one of: 'Tickets No Longer Available', 'Tickets Priced Incorrectly', 'Duplicate Order', 'Fraudulent Order', 'Test Order', 'Other'	string	Required if cancel_order is true
notes	Notes about the cancellation	string	Optional if cancel_order is true

Examples

Request

Response

/v9/orders/12345/return

{ "amount":"15.00" }

See Orders / Show