Order Return Requests

Payloads for the order.return-request.created, order.return-request.item-approved, and order.return-request.item-denied topics.

A return request covers one or more lines from a single order. It opens with a status of pending for every requested line, and Sibi staff then approve or deny each line individually. Because decisions are made per line, a single request can produce multiple itemApproved and itemDenied events over its lifetime.

Return Request Created

This event is triggered when a return request is first opened. The event will have a topic of order.return-request.created.

When a request is created, every line on it is pending review.

returnRequestId

The unique identifier for the return request.

orderId

The identifier of the order the returned lines belong to.

items

The lines requested for return. Always contains at least one entry. Each entry has:

• orderLineItemId - The identifier of the order line being returned.
• quantity - The number of units requested for return. Always a positive integer.
• condition - The condition of the item being returned. One of UNOPENED, OPENED-UNUSED, INSTALLED, or DAMAGED.
• requestReason - The reason provided for returning this line.

Example payload

{
  "topic": "order.return-request.created",
  "data": {
    "returnRequestId": "RET-12345XYZ",
    "orderId": "ORD-12345XYZ",
    "items": [
      {
        "orderLineItemId": "OLI-0001",
        "quantity": 2,
        "condition": "UNOPENED",
        "requestReason": "Ordered the wrong size"
      }
    ]
  }
}

Return Request Item Approved

This event is triggered when a single requested line is approved. The event will have a topic of order.return-request.item-approved. One event fires per approved line, so a request with several approved lines produces several events.

returnRequestId

The unique identifier for the return request the line belongs to.

orderId

The identifier of the order the returned line belongs to.

orderLineItemId

The identifier of the approved order line.

quantity

The number of units approved for return. Always a positive integer.

Example payload

{
  "topic": "order.return-request.item-approved",
  "data": {
    "returnRequestId": "RET-12345XYZ",
    "orderId": "ORD-12345XYZ",
    "orderLineItemId": "OLI-0001",
    "quantity": 2
  }
}

Return Request Item Denied

This event is triggered when a single requested line is denied. The event will have a topic of order.return-request.item-denied. One event fires per denied line, so a request with several denied lines produces several events.

returnRequestId

The unique identifier for the return request the line belongs to.

orderId

The identifier of the order the returned line belongs to.

orderLineItemId

The identifier of the denied order line.

denialReason

The reason the line was denied, as recorded on the decision.

Example payload

{
  "topic": "order.return-request.item-denied",
  "data": {
    "returnRequestId": "RET-12345XYZ",
    "orderId": "ORD-12345XYZ",
    "orderLineItemId": "OLI-0001",
    "denialReason": "Item is outside the return window"
  }
}