> 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/returns.md).

# Returns

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

| Attributes                         | Type            | Description                                                               |
| ---------------------------------- | --------------- | ------------------------------------------------------------------------- |
| `customerReturnNumber`             | `string`        | A unique Number against a sales channel Return Request  (R)               |
| `customerOrderNumber`              | `string`        | Unique Number against Each Sales Channel (R)                              |
| `externalChannelID`                | `string`        | Sales Channel Name of a workspace (R)                                     |
| `pickup_type`                      | `string`        | pick up type of request must be "`reverse`" (R)                           |
| `refundAmount`                     | `number`        | Amount to be refund for this particular return request (R)                |
| `isCOD`                            | `string`        | Type of order `Enum : 0 , 1`(1 if order is cod,0 if order is prepaid) (R) |
| `return_request_date`              | `string`        | return request date time                                                  |
| `repaymentType`                    | `string`        | Type of pickup `Enum:bank,originalPaymentMode` (R)                        |
| `optional`                         | `object`        | If repayment type is bank, Then optional detail must be filled            |
| `optional.bankDetails`             | `object`        | Bank details, used for refund process.                                    |
| `bankDetails.beneficiaryName`      | `string`        | `beneficiaryName of account`                                              |
| `bankDetails.beneficiaryAccountNo` | `string`        | account number of customer                                                |
| `bankDetails.beneficiaryIfscCode`  | `string`        | ifsc code of bank                                                         |
| `pickupAddress`                    | `object`        | Pick up address of returned items (R)                                     |
| `pickupAddress.customerName`       | `string`        | pickup customer Name                                                      |
| `pickupAddress.addressLine1`       | `string`        | pickup address                                                            |
| `pickupAddress.addressLine2`       | `string`        | pickup adress                                                             |
| `pickupAddress.city`               | `string`        | pickup city                                                               |
| `pickupAddress.state`              | `string`        | pickup state                                                              |
| `pickupAddress.postalCode`         | `string`        | pickup state                                                              |
| `pickupAddress.countryCode`        | `string`        | pickup country code                                                       |
| `pickupAddress.countryName`        | `string`        | pickup country name                                                       |
| `pickupAddress.contactPhone`       | `string`        | pickup contact number                                                     |
| `pickupAddress.email`              | `string`        | pickup email address                                                      |
| `items`                            | `array[object]` | The return items object                                                   |
| {% endtab %}                       |                 |                                                                           |

{% tab title="Sample Json" %}

```php
{
	 "externalChannelID": "TATA CLIQ VELOCY KAPAS KRAFT",
    "customerReturnNumber": "R4115823",
    "customerOrderNumber": "300975272",
    "pickup_type": "reverse",
    "refundAmount": 0,
    "return_request_date": "2019-12-11 21:04:59",
    "repaymentType": "bank",
    "optional":{
		"bankDetails":{
			"beneficiaryName":"John Doe",
			"beneficiaryAccountNo":"1234567899999",
			"beneficiaryIfscCode":"SIB0003222"
		}
	},
   "pickupAddress": {
       "customerName": "John Doe",
        "addressLine1": "Kapas Kraft Apparels Limited",
        "addressLine2": "Banglore",
        "city": "bengluru",
        "state": "Karnataka",
        "postalCode": "560005",
        "countryCode": "IN",
        "countryName": "India",
        "contactPhone": "9998889998",
        "email": "johndoe@gmail.com"
    },
    "items": [
        {
            "lineItemSequenceNumber": 81730,
            "itemID": "5050409110942",
            "quantity": 1,
            "returnReason": "Not satisfied with size or fit",
            "itemImage": "CA001CL95LVWCLRKS-90678.jpg",
            "additionalInfo": {
                "image": null,
                "comments": null
            }
        }
    ]
}
```

{% endtab %}
{% endtabs %}

The **`Items`** Object

| Attributes                       | Type     | Description                                     |
| -------------------------------- | -------- | ----------------------------------------------- |
| `items[].lineItemSequenceNumber` | `string` | incremental id of the item in created order (R) |
| `items[].itemID`                 | `string` | variant id of the item (seller SKU code) (R)    |
| `items[].quantity`               | `string` | quantity of the item (R)                        |
| `items[].returnReason`           | `string` | reason for return                               |
| `items[].itemImage`              | `string` | item original image                             |
| `items[].additionalInfo`         | `object` | the additional item details                     |

The **`additionalInfo`** Object

| Attributes                | Type     | Description          |
| ------------------------- | -------- | -------------------- |
| `additionalInfo.image`    | `string` | delivered item image |
| `additionalInfo.comments` | `string` | comments on image    |

**`Enum: isCOD`**

| Attribute | Description                   |
| --------- | ----------------------------- |
| 0         | created order must be Prepaid |
| 1         | created order must be COD     |

### Enum: repaymentType

| Attribute           | Description                                            |
| ------------------- | ------------------------------------------------------ |
| bank                | if refund mode is bank, optional detail must be filled |
| originalPaymentMode | if refund mode is OPM. optional details not required.  |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://eshop.gitbook.io/eshopbox-developers/order/returns.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.