> For the complete documentation index, see [llms.txt](https://eshop.gitbook.io/eshopbox-developers/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://eshop.gitbook.io/eshopbox-developers/order/shipper-integration-wrapper-api/return.md).

# Return

Effortlessly generate Air Waybills (AWBs) for shipments and easily schedule reverse pickups for returned items, simplifying the return process for customers.

## Create return

<mark style="color:green;">`POST`</mark>/api/v1/shipping/return

return Create API

**Headers**

| Name          | Value              |
| ------------- | ------------------ |
| Content-Type  | `application/json` |
| Authorization | `Bearer <token>`   |

**Body**

<table data-header-hidden><thead><tr><th width="202"></th><th></th><th></th><th></th></tr></thead><tbody><tr><td><strong>Name</strong></td><td><strong>Required</strong></td><td><strong>Remarks</strong></td><td><strong>Type</strong></td></tr><tr><td>channelId</td><td>No</td><td>The identifier for the sales channel</td><td>String</td></tr><tr><td>customerOrderId</td><td>Yes</td><td>The unique ID of the customer's order</td><td>String</td></tr><tr><td>shipmentId</td><td>Yes</td><td>The unique ID of the shipment</td><td>String</td></tr><tr><td>orderDate</td><td>No</td><td>The date and time when the order was placed. In case, not provided, current date and time will be considered as order date.</td><td>datetime (format: YYYY-MM-DD HH:MM)</td></tr><tr><td>isCOD</td><td>Yes</td><td>Indicates if the order is Cash on Delivery (COD). true if order is COD, false if order is prepaid</td><td>Boolean</td></tr><tr><td>invoiceTotal</td><td>Yes</td><td>The total amount of the invoice. (inclusive of all the taxes)</td><td>number</td></tr><tr><td>shippingMode</td><td>No</td><td>The mode of shipping (e.g., Standard, Express)</td><td>string</td></tr><tr><td>invoice.number</td><td> </td><td>Invoice number of the forward order</td><td>string</td></tr><tr><td>invoice.date</td><td> </td><td>Invoice date of the forward order</td><td>date time</td></tr><tr><td>ewaybillNumber</td><td>No</td><td>E-way bill number</td><td>string</td></tr><tr><td>qcDetails.qc_color</td><td>No</td><td>Quality check color as mentioned on the product.</td><td>string</td></tr><tr><td>qcDetails.qc_brand</td><td>No</td><td>Quality check brand as mentioned on the product</td><td>string</td></tr><tr><td>qcDetails.qc_serial_no</td><td>No</td><td>Quality check serial number as mentioned on the product</td><td>string</td></tr><tr><td>qcDetails.qc_size</td><td>No</td><td>Quality check size as mentioned on the product</td><td>string</td></tr><tr><td>qcDetails.qc_product_name</td><td>No</td><td>Quality check product name as mentioned on the product</td><td>string</td></tr><tr><td>qcDetails.qc_product_image</td><td>No</td><td>Quality check product image</td><td>string</td></tr><tr><td>shippingAddress.locationCode</td><td>Yes</td><td>Location code of the delivery address. It is unique for each location. It is created as a location in your Eshopbox workspace.</td><td>string</td></tr><tr><td>qcDetails.qc_ean_barcode</td><td>No</td><td>Quality check EAN barcode as mentioned on the product</td><td>string</td></tr><tr><td>shippingAddress.locationName</td><td>No</td><td>Location name<br>*Mandatory if location code is blank or location is not created in Eshopbox.</td><td>string</td></tr><tr><td>shippingAddress.companyName</td><td>No</td><td>Company name<br>*Mandatory if location code is blank or location is not created in Eshopbox.</td><td>string</td></tr><tr><td>shippingAddress.contactPerson</td><td>No</td><td>Contact person<br>*Mandatory if location code is blank or location is not created in Eshopbox.</td><td>string</td></tr><tr><td>shippingAddress.contactNumber</td><td>No</td><td>Contact number<br>*Mandatory if location code is blank or location is not created in Eshopbox.</td><td>string</td></tr><tr><td>shippingAddress.addressLine1</td><td>No</td><td>Address line 1<br>*Mandatory if location code is blank or location is not created in Eshopbox.</td><td>string</td></tr><tr><td>shippingAddress.addressLine2</td><td>No</td><td>Address line 2<br>*Mandatory if location code is blank or location is not created in Eshopbox.</td><td>string</td></tr><tr><td>shippingAddress.city</td><td>No</td><td>City<br>*Mandatory if location code is blank or location is not created in Eshopbox.</td><td>string</td></tr><tr><td>shippingAddress.state</td><td>No</td><td>State<br>*Mandatory if location code is blank or location is not created in Eshopbox.</td><td>string</td></tr><tr><td>shippingAddress.pincode</td><td>No</td><td>Country<br>*Mandatory if location code is blank or location is not created in Eshopbox.</td><td>string</td></tr><tr><td>shippingAddress.gstin</td><td>No</td><td>GSTIN<br>*Mandatory if location code is blank or location is not created in Eshopbox.</td><td>string</td></tr><tr><td>items.itemID</td><td>Yes</td><td>Unique identifier for the item like sku, ESIN, EAN etc</td><td>string</td></tr><tr><td>items.productTitle</td><td>Yes</td><td>Title of the product</td><td>string</td></tr><tr><td>items.quantity</td><td>Yes</td><td>Quantity of the item to be returned</td><td>number</td></tr><tr><td>items.itemTotal</td><td>Yes</td><td>Total price for the item (inclusive of taxes).</td><td>number</td></tr><tr><td>items.hsn</td><td>No</td><td>HSN code for the item</td><td>string</td></tr><tr><td>items.mrp</td><td>No</td><td>Maximum Retail Price (MRP) of the item</td><td>number</td></tr><tr><td>items.taxPercentage</td><td>No</td><td>Tax percentage applied to the item</td><td>number</td></tr><tr><td>items.discount</td><td>No</td><td>Discount applied to the item when shipped</td><td>number</td></tr><tr><td>items.length</td><td>Yes</td><td>Length of the item (in cm)</td><td>number</td></tr><tr><td>items.breadth</td><td>Yes</td><td>Breadth of the item (in cm)</td><td>number</td></tr><tr><td>items.height</td><td>Yes</td><td>Height of the item (in cm)</td><td>number</td></tr><tr><td>items.weight</td><td>Yes</td><td>Weight of the item (in gram)</td><td>number</td></tr><tr><td>items.returnReason</td><td>Yes</td><td>Reason for return</td><td>string</td></tr><tr><td>items.productImageUrl</td><td>No</td><td></td><td>string</td></tr><tr><td>returnDimension.length</td><td>Yes</td><td>Length of the return package (in cm)</td><td>number</td></tr><tr><td>returnDimension.breadth</td><td>Yes</td><td>Breadth of the return package (in cm)</td><td>number</td></tr><tr><td>returnDimension.height</td><td>Yes</td><td>Height of the return package (in cm)</td><td>number</td></tr><tr><td>returnDimension.weight</td><td>Yes</td><td>Weight of the return package (in grams)</td><td>number</td></tr><tr><td>pickupLocation.customerName</td><td>No</td><td>Customer name</td><td>string</td></tr><tr><td>pickupLocation.addressLine1</td><td>Yes</td><td>Address line 1 of the pickup address</td><td>string</td></tr><tr><td>pickupLocation.addressLine2</td><td>No</td><td>Address line 2 of the pickup address</td><td>string</td></tr><tr><td>pickupLocation.city</td><td>No</td><td>City</td><td>string</td></tr><tr><td>pickupLocation.state</td><td>No</td><td>State</td><td>string</td></tr><tr><td>pickupLocation.pincode</td><td>Yes</td><td>Pincode</td><td>string</td></tr><tr><td>pickupLocation.country</td><td>Yes</td><td>Country</td><td>string</td></tr><tr><td>pickupLocation.contactPhone</td><td>Yes</td><td>Contact phone</td><td>string</td></tr><tr><td>pickupLocation.email</td><td>Yes</td><td>Email</td><td>string</td></tr></tbody></table>

**Response**

{% tabs %}
{% tab title="200" %}

```json
{
    "courierName": "Self",
    "trackingId": "874320208625",
    "shippingMode": "Express",
    "gstin": "36AAACC1206D2ZG",
    "transporterID": ""
}
```

{% endtab %}

{% tab title="400" %}

```json
{
    "error": {
        "errors": [
            {
                "domain": "global",
                "reason": "badRequest",
                "message": "invalid request"
            }
        ],
        "code": 400,
        "message": "invalid request"
    }
}
```

{% endtab %}
{% endtabs %}

```json
curl --location -g 'https://wms.eshopbox.com/api/v1/shipping/return' \
--header 'Authorization: Bearer <Token>' \
--data-raw '{
    "channelId": "KAPAS KRAFT",
    "customerOrderId": "OD119208447831346000",
    "shipmentId":"2313ewqwre",
    "orderDate": "2020-02-29 15:39:11",
    "isCOD": true,
    "invoiceTotal": 4049.09,
    "shippingMode":"Standard",
    "invoice": {
        "number": "C00011323A000002",
        "date": "2023-06-02 15:39:11"
    },
    "ewaybillNumber":"",
    "shippingAddress": {
        "locationCode": "MCFL00395",
        "locationName": "TEST Warehouse",
        "companyName": "TEST",
        "contactPerson": "SAM",
        "contactNumber": "898898989",
        "addressLine1": "Khasra no 5/16/2,17, Near Subash Chowk, Sohana Road Village Behrampur",
        "addressLine2": "Khasra no 5/16/2,17, Near Subash Chowk",
        "city": "Gurgaon",
        "pincode":"121005",
        "state": "HARYANA",
        "country": "India",
        "gstin": "06AAFCM7888Q1ZE"
    },
    "items": [
        {
            "itemID": "DB9U03FMGWZ",
            "productTitle": "Pace Barnes",
            "quantity": 1,
            "itemTotal": 4049.09,
            "hsn":"122132",
            "mrp":2345.98,
            "discount":123,
            "taxPercentage":12.00,
            "returnReason": "TEST",
            "ean": "2342534", 
            "length": 12,
            "breadth": 18,
            "height": 23,
            "weight": 100,
            "qcDetails":{  
                "qc_color":"red",
                "qc_brand":"duke",
                "qc_serial_no":"212324235",
                "qc_ean_barcode":"sdsrewrt",
                "qc_size":"22",
                "qc_product_name":"TEST",
                "qc_product_image":"IMG.png",
                "qcParamsToCheck" : [
                    "check_price_tag",
                    "check_packaging_box",
                    "check_damaged",
                    "check_used"
                ]
            }
        }
    ],
    "returnDimension": {
        "length": 13.12,
        "breadth": 15.32,
        "height": 56.39,
        "weight": 201.23
    },
    "pickupLocation": {
         "customerName": "John Doe",
        "addressLine1": "Kapas Kraft Apparels Limited",
        "addressLine2": "Banglore",
        "city": "bengluru",
        "state": "Karnataka",
        "pincode": "560005",
        "country": "India",
        "contactPhone": "9998889998",
        "email": "johndoe@gmail.com"
    }
}'
```