Order Return

This APIs are used to list and view order return details.

Order Return API

The Order Return API allows customers to initiate a return request for a specific order item. Customers can use this API to request a return for an item they purchased from the e-commerce platform.

Return list and Return detail page

Return detail page

Statuses

• Returned: The return request has been completed, and the product has been successfully returned to the seller.

• Pending: The return request is pending approval from the seller or the e-commerce platform.

• Accepted: The return request has been accepted by the seller, and further processing is underway.

• Rejected: The return request has been rejected by the seller, and the product will not be accepted for return.

1. Order Return List API

The Order Return List API allows customers to view a list of their past order returns. This feature enables customers to keep track of their returned items, including the status of each return request and relevant details.

Endpoint

• {{baseurl}}/api/v1/customer/order/return/list?page=1

Method

• GET

Request Parameters

• page (optional): The page number for paginated results. If not specified, the API defaults to the first page.

Authorization

• The API requires a valid bearer token in the request header for authentication. Users must include their token in the "Authorization" header to access their account and view the list of order returns.

Response Format

• The API responds with a JSON object containing an array of order return objects. Each object represents a specific return request and includes details such as return ID, order ID, product name, quantity, status, and more.

Example Response:

{
    "success": true,
    "data": {
        "order_returns": [
            {
                "id": 18,
                "return_id": "20230729-16214145",
                "number_of_products": 3,
                "total_amount": 216,
                "initiated_date": "29-07-23",
                "return_status": "rejected"
            },
            {
                "id": 17,
                "return_id": "20230729-16134982",
                "number_of_products": 3,
                "total_amount": 216,
                "initiated_date": "29-07-23",
                "return_status": "returned"
            },
            {
                "id": 16,
                "return_id": "20230728-16073280",
                "number_of_products": 6,
                "total_amount": 5400,
                "initiated_date": "28-07-23",
                "return_status": "accepted"
            },
            {
                "id": 15,
                "return_id": "20230728-16072474",
                "number_of_products": 6,
                "total_amount": 470,
                "initiated_date": "28-07-23",
                "return_status": "pending"
            }
],
        "pagination": {
            "total": 16,
            "count": 15,
            "limit": 15,
            "current_page": 1,
            "total_pages": 2
        }
    },
    "message": "Success",
    "status_code": 200
}

Features

• The Order Return List API provides customers with a comprehensive view of their previous order return requests.

• Customers can easily check the status (Returned, Pending, Accepted, Rejected) of each return and review the details, such as the product name, quantity, and return reason.

Usage

• The Order Return List API is used when customers want to view the list of their past order returns for reference or tracking purposes.

• Customers can access their return history from the "My Returns" or "Order Returns" section of the e-commerce application.

By including the four statuses "Returned," "Pending," "Accepted," and "Rejected" in the description, customers can better understand the different stages of their order return requests.

2. Order Return Details API

The Return Detail API allows customers to view detailed information about a specific return request they have initiated. This API provides access to the return request's status, order details, product information, admin note, and the user's reason for the return.

Endpoint

• {{baseurl}}/api/v1/customer/order/return/return_list_id?lang_code=en

Method

• GET

Request Parameters

• lang_code (optional): A two-letter language code (e.g., "en" for English, "es" for Spanish, etc.) to support language-based localization. If provided, the API returns response messages and descriptions in the specified language.

• return_list_id (required): The unique identifier of the return list. Customers must provide this parameter to access their specific return list.

Authorization

• The API requires a valid bearer token in the request header for authentication. Users must include their token in the "Authorization" header to access their account and view the details of the specific order return.

Response Format

• The API responds with a JSON object containing detailed information about the return request. It includes data such as the return ID, order ID, product name, quantity, return status, return date, admin note, and the user's reason for the return.

Example Response:

{
    "success": true,
    "data": {
        "return_details": [
            {
                "id": 18,
                "return_id": "20230729-16214145",
                "ref_bill_no": "MAJ-2023-07-0192",
                "ref_order_id": "20230729-16051913C",
                "number_of_products": 1,
                "total_amount": 270,
                "coupon_discount": 0,
                "grand_total": 216,
                "initiated_date": "29-07-23",
                "initiated_status": "pending",
                "rejected_date": "29-07-23",
                "rejected_status": "rejected",
                "comments": "ok",
                "user_comments":"not a good product",
                "return_product": [
                    {
                        "serial": 1,
                        "quantity": 3,
                        "product": {
                            "thumbnail": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/71srbo5I7VL._SL1500_.jpg",
                            "name": "NETPLAY Zip-Front Puffer Jacket with Insert Pockets with premium colour of which has high quality",
                            "variations": [
                                {
                                    "attribute": "Size",
                                    "attribute_value": "SMALL",
                                    "attribute_code": null
                                },
                                {
                                    "attribute": "Colour",
                                    "attribute_value": "BLACK",
                                    "attribute_code": "#000000"
                                }
                            ]
                        },
                        "mrp": "440.00",
                        "offer_price": "90.00",
                        "total_price": "270.00"
                    }
                ]
            }
        ]
    },
    "message": "Success",
    "status_code": 200
}

Features

• The Return Detail API provides customers with comprehensive details about their initiated return request, ensuring transparency and clarity regarding the return status and reasons.

• Customers can access the admin note, which may contain specific instructions from the seller or the e-commerce platform regarding the return process.

• The API also includes the user's reason for initiating the return, which helps sellers and the platform understand the customer's needs better.

Usage

• The Return Detail API is used when customers want to view detailed information about a specific return request.

• Customers can access the return details from the "My Orders" or "Return Requests" section of the e-commerce application.

By using the Return Detail API, customers can obtain comprehensive information about their return request, facilitating better communication between customers, sellers, and the e-commerce platform during the return process.

Reorder Return API

The Reorder Return API allows customers to quickly initiate a reorder for items that they previously returned. This feature is useful for customers who wish to repurchase items they had returned in the past.

Endpoint

• {{baseurl}}/api/v1/customer/reorder/return/return_list_id

Method

• GET

Request Parameters

• return_list_id (required): The unique identifier of the return list. Customers must provide this parameter to access their specific return list.

Authorization

• The API requires a valid bearer token in the request header for authentication. Users must include their token in the "Authorization" header to access their account and place reorder return requests.

Response Format

• The API responds with a JSON object indicating the status of the reorder return request. It provides information about the newly created order and the products that were previously returned.

Example Response:

{
    "success": true,
    "message": "Added to cart",
    "status": 200,
    "data": []
}

Features

• The Reorder Return API simplifies the process of reordering previously returned items by using the return_id to recreate the same set of products and quantities in the new order.

• Customers can easily repurchase items that they had returned without manually selecting each product again.

Usage

• The Reorder Return API is used when customers want to quickly repurchase items they had previously returned.

• Customers can initiate the reorder return process from the "My Returns" or "Order Returns" section of the e-commerce application.