post

/orders/cancel

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 that their order has been cancelled 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 Parameters

1 Query Parameter

Request Body

Schema
object
reason
string

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

note
string

A note to the user explaining reason for the refund. This field is required if reason_code is “unableToFulfill”

Responses

Schema
object
code
integer

Status code for the request: 0 for success, any other number for failure

1 validation + required
message
string

Human readable description of what went wrong if code is not 0

data
object

An order

Send a Test Request

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