Processes

Review a return process

Changed on

Tells 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.

post/v1/ops/ecommerce/review

Request

  • Base URL
    https://api.byrever.com
  • Auth
    API key in header x-rever-api-key

Request body

override_authorizationboolean

When true, REVER also approves the process's pending authorization once the reviews are accepted. The refund override is not applied to that authorization.

platform_process_idstring

Deprecated: use process_id. Read when process_id is empty, and must also hold the REVER process id: a platform order or return id is not found.

process_idstring

REVER id of the return process being reviewed. Required unless the deprecated platform_process_id is set.

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.

OpspbReviewItemsResponse required

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 SubmitProcessReviews removed and replaced with ReviewItemsGeneric

    • info

      added the new APPROVED enum value to the request property //

    • info

      added the new DECLINED enum value to the request property //

    • info

      added the new MISSING enum value to the request property //

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • breaking

      added to the request property allOf list

    • breaking

      the / request property type changed from no type to object

    • warning

      removed from the / request property allOf list

    • warning

      removed from the request property allOf list

    • info

      the endpoint scheme security API Key was 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