Vendor Order Return API

This API allows vendors to manage order returns and refunds.

Endpoints Overview

Method	Endpoint	Description
GET	`/api/v1/catalog/vendor/order-returns/`	List all return requests for the vendor's orders.
PATCH	`/api/v1/catalog/vendor/order-returns/<int:id>/approve-reject/`	Approve or reject a return request.
PATCH	`/api/v1/catalog/vendor/order-returns/<int:id>/process-refund/`	Refund approved orders

Vendor Order Return API

1. List All Return Requests

Endpoint

URL: /api/v1/catalog/vendor/order-returns/
Method: GET
Permission Required: IsAuthenticated (Vendor Only)

Description

Retrieves a list of all return requests for the vendor's orders.

Example Request

This is the example request

GET /api/v1/catalog/vendor/order-returns/

Success

{
    "pageSize": 20,
    "count": 2,
    "page_count": 1,
    "active_page": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 10,
            "order_id": "ORD12345",
            "customer": "John Doe",
            "reason": "Received a damaged product",
            "status": "Pending",
            "requested_at": "2025-03-10 14:00:00"
        }
    ]
}

2. Approve a Return Request

Endpoint

URL: /api/v1/catalog/vendor/order-returns/<int:id>/approve-reject/
Method: PATCH
Permission Required: IsAuthenticated (Vendor Only)

Description

Allows vendors to approve a return request.

Example Request

This is the example request

PATCH /api/v1/catalog/vendor/order-returns/38/approve-reject/

Request Body

This is the request body

{
    "has_approved": true
}

Success

{
    "message": "Return request updated successfully."
}

Error

{
  "error": "Approval status is required."
}

3. Reject a Return Request

Endpoint

URL: /api/v1/catalog/vendor/order-returns/<int:id>/approve-reject/
Method: PATCH
Permission Required: IsAuthenticated (Vendor Only)

Description

Allows vendors to reject a return request.

Example Request

This is the example request

PATCH /api/v1/catalog/vendor/order-returns/38/approve-reject/

Request Body

This is the request body

{
    "has_approved": false,
    "rejection_reason": "Product damaged"
}

Success

{
    "message": "Return request updated successfully."
}

Error

{
  "error": "Approval status is required."
}

4. Refund a Return Request

Endpoint

URL: /api/v1/catalog/vendor/order-returns/<int:id>/process-refund/
Method: PATCH
Permission Required: IsAuthenticated (Vendor Only)

Description

Allows vendors to refund a return request.

Example Request

This is the example request

PATCH /api/v1/catalog/vendor/order-returns/38/process-refund/

Success

{
    "message": "Refund processed successfully and email notification sent."
}