Order Details – View for Return

Retrieves order details formatted specifically for return processing.

This endpoint:

Returns only products that still have remaining returnable quantities

Recalculates:
Order totals
Invoice amounts

Reflects the maximum refundable amount based on remaining items

Use this endpoint before:

Creating a reverse order

Calculating return totals

Performing partial returns

What This Endpoint Is Used For

Typical flow:

Call view-for-return

Select products + quantities

Call /reverse-credit-note/totals

Create reverse order

🔑Scopes

orders.read_write - Orders Read & Write

Behavior by Order Status

New / Not Delivered

Returns all products

Quantities = original quantities

Partially Reversed

Returns only remaining quantities

Totals recalculated

Fully Reversed

products = []

products_count = 0

order_total = 0

Business Logic

Remaining Quantity Calculation

remaining_quantity = original_quantity − sum(previous_returns)

Totals

Recalculated based only on remaining items

Represents maximum refundable amount

curl --location 'https://api.zid.sa/v1/managers/store/orders/64086815/view-for-return' \ --header 'Authorization: {{Autherization}}' \ --header 'X-MANAGER-TOKEN: {{Access-Token}}' \ --header 'Accept-Language: en'

{ "status": "object", "order": { "id": 39017136, "invoice_number": 39017136, "code": "XAiG6yjJCW", "store_id": 1, "order_status": { "name": "Ready", "code": "ready" }, "payment_status": "paid", "currency_code": "SAR", "order_total": 346, "order_total_string": "346.00 SAR", "products_count": 3, "products_sum_total_string": "300.87 SAR", "products": [ { "id": "a1e5eb8f-12a7-4a43-97af-f98e0d9af17b", "order_product_id": 60564, "name": "Test file", "sku": "Z.1.17314985477182937", "quantity": 2, "price": 122.99, "price_string": "123.00 SAR", "tax_percentage": 0.15, "total": 245.99, "total_string": "246.00 SAR" } ], "payment": { "invoice": [ { "code": "sub_totals", "value": 300.87, "value_string": "300.87 SAR", "title": "Subtotal" } ] } }, "message": { "type": "success", "code": "MSG_POPUP_OK", "name": "Coupons", "description": "Coupons created successfully" } }

Order Details – View for Return

What This Endpoint Is Used For

Behavior by Order Status

Business Logic

Request

Responses

Order Details – View for Return

What This Endpoint Is Used For#

Behavior by Order Status#

Business Logic#

Request

Responses

What This Endpoint Is Used For

Behavior by Order Status

Business Logic