API Reference

Refund an Order

post
https://tophatter.com/merchant_api/v1/orders/refund.json

Refund Reasons

ReasonDescription
no_buyer_communication_regarding_sizeThe size and/or color the customer requested is not available, or you're not able to determine which size and/or color the customer wants.
incorrect_buyers_addressThe customer's shipping address is not valid and you're not able to determine what the customer's valid shipping address is.
buyer_requested_through_ticketThe customer requested a refund via a support ticket.
buyer_requested_through_resolution_centerThe customer requested a refund via the resolution center.
buyer_requested_a_returnThe customer has returned the product.
delay_in_shippingThere will be a significant delay in shipping, which will likely leave the customer unsatisfied.
out_of_stockYou no longer have the item in stock.
in_stock_items_damagedYou have this product in stock, but it is damaged.
untrackableThe order has been lost while in transit to the customer.
otherNone of the other options are applicable.
Body Params
int32
required

The order_id of the order you wish to refund.

string
required

The type of refund. The only acceptable values are full and partial.

string
required

The reason for the refund. See the "Refund Reasons" below for the complete list of acceptable reasons.

fees
array of strings

The fees you would like to refund. Only required for partial refunds. Must be one or more of the following values: buyer_fee, shipping_fee, expedited_shipping_fee, and lot_upsell_fee. When you retrieve an order the available_refunds field will tell you which fees can be refunded in a partial refund.

fees
Response

Updated less than a minute ago

Language
Credentials
Basic
base64
:
Request
Response 
 Choose an example:
application/json
Updated less than a minute ago