Skip to main content

Mark order items as returned (refund)

PUT 
/financing/v1/applications/:applicationId/order/return

When some or all order items were returned by the customer to you (after delivery), use /financing/v1/applications/{applicationId}/order/return resource where {applicationId} is the application ID you received in the response of /financing/v1/applications after its creation.

If you want to cancel some items before marking those items as sent or delivered, use Mark order items as cancelled operation.

📘 For additional examples and more information, please refer to the Technical guide: Manage your orders.

Financing typeSupported
DEFERRED_PAYMENTYES
PAY_IN_THREEYES
Application stateAvailability
PROCESSINGNO
REJECTEDNO
CANCELLEDNO
READYYES

Use /financing/v1/applications/{applicationId}/order/return resource with an empty request to mark all order items (the whole order) as returned at once.

If you want to mark specific order item(s) as returned, you can pass a list of them in the items array, including quantity per item. Each item is identified by the combination of code, ean, name, and type — these must match the values used in the original Create application request. Alternatively, you can omit the items field and simply include totalPrice — in that case, the total refund amount is deducted from the order.

💡 TIP: Optionally, you can specify the amount (in the field totalPrice) that should be returned if it differs from the sum of the items' prices.

💡 TIP: Use an empty request if marking last (those not yet not marked) item(s) on order as returned.

⚠️ If multiple properties (code, ean, name or type) are used for identifying some order item, it all must exact match the item data.

Partial refunds vs. order state...
  • "items": [] present (empty array): We treat this as an amount-only partial refund. The order totalPrice is reduced by the refunded amount, but the order state does not change (remains SENT/DELIVERED).
  • items omitted or empty body {}: We treat this as a full return of the remaining items. The order totalPrice is reduced accordingly (possibly to zero) and the order state becomes RETURNED.

This distinction prevents accidental full returns when a partner does not send the items field for partial refunds.

If the request was successfully processed, you receive HTTP status code 200 and object of information about changed order plus basic information about respective application (ID, state, substate).

In other cases, you may receive errors similar to the following ones:

Status codeCodeExplanation
400INVALID_REQUESTRequest was not well formatted (malformed request syntax, size too large, etc.)
404OBJECT_NOT_FOUNDThe requested resource could not be found
422NOT_SUPPORTEDThe operation is not supported. Check the error response for details.

System notification. Some or all order items were returned by customer back to e-shop. Based on application financing type and partner setting, credit note may be issued.

Request​

Responses​

Order items or whole order is marked as returned