/
Orders / Return

Orders / Return

Owned by Don Pflaster (Unlicensed)
Last updated: Dec 18, 2014 by J Cobb
NameOrders Return
DescriptionCreate a return for an order.
TypePOST
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
amountThe amount you wish to returndecimalRequired
cancel_orderTransition the order state to canceled post-acceptance.booleanOptional
reviewer_idThe ID of a user belonging to the brokerageintegerRequired if cancel_order is true
reasonThe reason for the cancellation. Must be one of:

'Tickets No Longer Available',
'Tickets Priced Incorrectly',
'Duplicate Order',
'Fraudulent Order',
'Test Order',
'Other'

stringRequired if cancel_order is true
notesNotes about the cancellationstringOptional if cancel_order is true

 

Examples

RequestResponse
/v9/orders/12345/return 
{ "amount":"15.00" }

 

See Orders / Show

Related content