Review a return process
Changed onTells REVER the outcome of the warehouse review of a return. The outcome decides the refund, the restock and the emails the customer receives.
- Send one review per returned unit. An item returned with quantity 2 needs two entries in reviews.
- Review every returned unit in the same request. A request that leaves units out is rejected, unless the store is set up to mark unreviewed units as MISSING.
- Use MISSING for a unit that was expected but not received.
- Use refund_override only to change the amount REVER refunds.
REVER validates the request before answering and processes it asynchronously: a 200 means the reviews were accepted, not that the refund has been issued.
For a process that is already reviewed, REVER compares how many reviews each item has per status. If they match, it returns 200 and changes nothing, otherwise 400. Other fields, such as reject_reason or should_restock, are not compared. When REVER added MISSING reviews for units the request left out, a retry has to include them.
Request
- Base URLhttps://api.byrever.com
- AuthAPI key in header x-rever-api-key
Request body
Example request
{
"process_id": "retp_38Fv8eXCCjU7cG0XnrZ2DaWDqzj",
"refund_override": {
"amount": {
"amount": "1200",
"currency_code": "EUR"
},
"reason": "The order is partially broken",
"requested": true
},
"reviews": [
{
"line_item_id": "PD12341N32",
"reject_reason": "The T-shirt was used and broken",
"status": "APPROVED"
}
]
}Response
OK - Reviews submitted.
Changes
- breaking
request property
//was restricted to a list of enum values - breaking
the request property
became required - breaking
the request property
//became required - info
api operation id
SubmitProcessReviewsremoved and replaced withReviewItemsGeneric - info
added the new
APPROVEDenum value to the request property// - info
added the new
DECLINEDenum value to the request property// - info
added the new
MISSINGenum value to the request property// - info
added the non-success response with the status
- info
added the non-success response with the status
- breaking
- breaking
added to the
request propertyallOflist - breaking
the
/request property type changed from no type toobject - warning
removed from the
/request propertyallOflist - warning
removed from the
request propertyallOflist - info
the endpoint scheme security
API Keywas removed from the API - info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
// - info
added the new optional request property
// - info
added the new optional request property
// - info
added the new optional request property
// - info
added the new optional request property
// - info
added the new optional request property
// - info
added the new optional request property
// - info
added the new optional request property
// - info
the request property
became optional - info
the request property
became optional
- breaking