Update return · Bigblue Developers

POST/bigblue.storeapi.v1.PublicAPI/UpdateReturn

Updates a return's resolution. You can't change line items, the warehouse or the parcel status. The warehouse sets those.

List the fields to change in update_mask:

resolution_status: Set to OPEN, ACTION_REQUIRED or CLOSED.
manual_resolution: Record the refund method and a note.

update_mask value	Meaning
`resolution_status`	Set to `OPEN`, `ACTION_REQUIRED` or `CLOSED`.
`manual_resolution`	Record the refund method and a note.

Always send resolution_status

resolution_status is updated even when it's not in update_mask. If you only want to add a note, still send the current resolution_status, or it will be reset.

Request body

returnReturnFormrequired

The return, with id set. Only resolution_status and manual_resolution are read.

update_maskstring[]required

Fields to update. At least one, with no duplicates.

At least 1 item · No duplicates

Responses

200The return was updated.

returnReturn

The updated return. resolution_closed_time is set when the resolution is CLOSED.

400The mask is empty or has duplicates, or the ID is invalid.

{
  "code": "invalid_argument",
  "msg": "update_mask value must contain at least 1 item(s)",
  "meta": { "argument": "update_mask" }
}

404No return with this ID exists.

{ "code": "not_found", "msg": "customer return not found" }

POST/bigblue.storeapi.v1.PublicAPI/UpdateReturn

Request: close with a note

{
  "return": {
    "id": "BGBL0K3M9XQ2RT01",
    "resolution_status": "RETURN_RESOLUTION_STATUS_CLOSED",
    "manual_resolution": {
      "refund_method": "RETURN_REFUND_METHOD_MANUAL_OTHER",
      "note": "Refunded 24.90 EUR to the original card"
    }
  },
  "update_mask": ["resolution_status", "manual_resolution"]
}

200

{
  "return": {
    "id": "BGBL0K3M9XQ2RT01",
    "order": "BGBL0K3M9XQ2",
    "status": "RETURN_STATUS_RETURNED",
    "resolution_status": "RETURN_RESOLUTION_STATUS_CLOSED",
    "resolution_closed_time": "2026-03-24T14:02:00Z",
    "manual_resolution": {
      "refund_method": "RETURN_REFUND_METHOD_MANUAL_OTHER",
      "note": "Refunded 24.90 EUR to the original card"
    }
  }
}