post

/order/refund

Refund/Cancel an order in the Joom system. Call this API if you cannot fulfill the order for any reason. Joom will notify the user their order has been cancelled shipped and refund them upon completion of this request.

Returns

If the order is not already refunded and all the parameters are correct, the API will mark the order as refunded and return a HTTP status code of 200.

Request Body

Schema
object
id
string

Joom’s unique identifier for the order (order_id in the Order object)

required
reason_code
integer

Order refund reason code. Possible values: 1 - unable to fulfill for some reason not listed here (please provide a note with this reason code), 2 - product variation is out of stock, 3 - shipping address is invalid.

2 validations + required
reason_note
string

A note to the user explaining reason for the refund. This field is required if reason_code is 1 (other)

Responses

Schema
object
code
number

Contains the status code for the request, 0 means success and any other number implies a failure

1 validation + required
message
string

Sometimes will store a human readable status message to aid in debugging. It is generally used only for errors

required

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
host