Orders

List the refundable items on an order

List the items that can currently be refunded against the order, alongside any service-charge and tip components when they carry a positive balance. Used by the refund flow to render the operator-facing "what can I refund?" picker.

Pass payment_id to scope the list to what can be refunded against a specific payment (tips linked to that payment; items attributed via payment item revenues when available). On single-payment orders the parameter is optional and behaviour matches the unscoped list.

Each entry surfaces the line item's identifier, type, refundable amount and an allocation_hint the refund processor uses when splitting a refund across multiple items. The endpoint never issues a refund itself — POST /shop/orders/{orderId}/payments/{paymentId}/refunds is the write side.

get/shop/orders/{orderId}/refundable-items

Response

The items on the order that can currently be refunded, together with service-charge and tip lines when they carry a positive balance.

Example response

{
  "data": [
    {
      "id": "tip",
      "refundable_amount": 5000
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.