Get Return
This REST API is used to get the item details available in the return and certain information from the forward journey such as Sale Order Code, Shipment Code etc and the addresses specific to the return from Uniware using either shipmentCode or reversePickupCode.
Tip
It is recommended to check out Notes for the reader. You might find this helpful as it contains Guidelines for using API references and Terminologies used here.
Basic Information
| NAME | DETAILS |
|---|---|
| Endpoint: | /services/rest/v1/oms/return/get |
| Request Type: | POST |
| Scheme: | HTTPS |
| Header (Content-Type): | application/json |
| Header (Authorization): | bearer {access-token}, Eg.: bearer b30f3aea-7978-49bb-9ea7-33eddfc80afa |
| Header (Facility): | facility code as in Uniware (refer FAQs) |
Request Payload
{
"reversePickupCode":"RP0003",
"shipmentCode":null
}Request Payload Details
Tip
To get the item details available in the retur it is required to provide either
shipmentCodeorreversePickupCode.
| LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|---|
| 1 | reversePickupCode | string | Reverse pickup code | Opt | - |
| 2 | shipmentCode | string | Shipping package code | Opt | - |
Response Payload
{
"successful": true,
"message": "string",
"errors": [
{
"code": 0,
"fieldName": "string",
"description": "string",
"message": "string",
"errorParams": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
}
],
"warnings": [
{
"code": 0,
"message": "string",
"description": "string"
}
],
"returnSaleOrderItems": [
{
"skuCode": "product_001",
"saleOrderItemCode": "product_001-1",
"saleOrderItemStatus": "NOT_RECEIVED",
"channelProductId": "product_001",
"shipmentCode": "VIVE00292",
"saleOrderCode": "SO00743",
"reversePickupCode": "RP0096",
"inventoryType": null,
"marketplaceReturnReason": "",
"putawayQcComment": null,
"itemName": "001_Product",
"itemTypeImageUrl": "https://www.w3schools.com/w3css/img_lights.jpg",
"itemTypePageUrl": "https://cdn.pixabay.com/photo/2015/04/23/22/00/tree-736885__340.jpg",
"courierStatus": null,
"trackingStatus": null,
"customerImageUrl": "www.vb.com",
"returnRemarks": null
}
],
"returnAddressDetailsList": [
{
"name": "Abhilash",
"addressLine1": "Kolkata",
"addressLine2": "",
"city": "Kolkata",
"state": "WB",
"country": "IN",
"pincode": "123456",
"phone": "8888888888",
"email": null,
"type": "SHIPPING"
},
{
"name": "Abhilash",
"addressLine1": "Kolkata",
"addressLine2": "",
"city": "Kolkata",
"state": "WB",
"country": "IN",
"pincode": "123456",
"phone": "8888888888",
"email": null,
"type": "PICKUP"
},
{
"name": "Abhilash",
"addressLine1": "Kolkata",
"addressLine2": "",
"city": "Kolkata",
"state": "WB",
"country": "IN",
"pincode": "123456",
"phone": "8888888888",
"email": null,
"type": "BILLING"
}
],
"returnSaleOrderValue": {
"returnStatus": "CREATED",
"shipmentCode": null,
"saleOrderCode": "SO07713",
"reversePickupCode": "RP1048",
"trackingNumber": null,
"shippingProviderCode": null,
"courierName": null,
"returnCreatedDate": "2023-11-22 15:34:18",
"channelReturnCreatedDate": "2023-11-22 15:34:18",
"returnDeliveryDate": null,
"rtoTrackingNumber": null,
"rtoShippingProviderCode": null,
"rtoCourierName": null,
"rtoReason": null,
"inventoryReceivedDate": 1713345896000,
"returnCompletedDate": 1713345886000,
"returnInvoiceCode": "INVSO-00015",
"putawayCode": "PC1005367",
"boxSpecification": {
"boxLength": null,
"boxWidth": null,
"boxHeight": null,
"boxWeight": 0.01
}
},
"customFieldValues": [
{
"fieldName": "string",
"fieldValue": {},
"valueType": "string",
"displayName": "string",
"required": true,
"possibleValues": [
"string"
]
}
]
}Response Payload Details
| LEVEL | PARAMETER | TYPE | DESCRIPTION | NOTES |
|---|---|---|---|---|
| 1 | successful | true | Request success status | - |
| 2 | message | string | Response message | - |
| 3 | errors | list | List of errors (if any) | - |
| 3.1 | code | boolean | Error code | - |
| 3.2 | fieldName | string | Field with error | - |
| 3.3 | description | string | Error description | - |
| 3.4 | message | string | Error message | - |
| 3.5 | errorParams | object | Parameters with error | - |
| 3.5.1 | additionalProp1 | object | Parameter 1 with error | - |
| 3.5.2 | additionalProp2 | object | Parameter 2 with error | - |
| 3.5.3 | additionalProp3 | object | Parameter 3 with error | - |
| 4 | warnings | list | List of warnings (if any) | - |
| 4.1 | code | number | Warning code | - |
| 4.2 | message | string | Warning message | - |
| 4.3 | description | string | Warning description | - |
| 5 | returnSaleOrderItems | object | Return Sale Order Items | - |
| 5.1 | saleOrderItemCode | string | Sale order item code | - |
| 5.2 | channelProductId | string | channel Product Id | - |
| 5.4 | saleOrderCode | string | Sale order code | - |
| 5.5 | reversePickupCode | string | Reverse Pickup Code | - |
| 5.6 | inventoryType | string | Inventory Type | e.g. GOOD_INVENTORY, BAD_INVENTORY |
| 5.7 | marketplaceReturnReason | string | marketplace Return Reason | - |
| 5.8 | putawayQcComment | string | putaway Qc Comment | - |
| 5.9 | itemName | string | Item name | - |
| 5.10 | itemTypeImageUrl | string | Item type image link | - |
| 5.11 | itemTypePageUrl | string | Item type page link | - |
| 5.12 | courierStatus | string | Courier Status | - |
| 5.13 | trackingStatus | string | Tracking Status | - |
| 5.14 | customerImageUrl | string | Customer Image Url | - |
| 5.15 | skuCode | string | Item SKU code | - |
| 5.16 | saleOrderItemStatus | string | sale order item status code | values are NOT_RECEIVED or RECEIVED |
| 5.17 | returnRemarks | string | return remarks, if any | - |
| 6 | returnAddressDetailsList | list | Return Address Details List | - |
| 6.1 | name | string | Customer name | - |
| 6.2 | addressLine1 | string | Precise address | - |
| 6.3 | addressLine2 | string | Additional address information | - |
| 6.4 | city | string | City name | - |
| 6.5 | state | string | State name | - |
| 6.6 | country | string | Country name | - |
| 6.7 | pincode | string | Area pincode | - |
| 6.8 | phone | string | Contact no. | - |
| 6.9 | string | Email ID | - | |
| 6.10 | type | string | Type of Return Address | BILLING, PICKUP, SHIPPING |
| 7 | returnSaleOrderValue | list | Return sale order value | - |
| 7.1 | returnStatus | string | Return Status | - |
| 7.2 | shipmentCode | string | Shipment Code | - |
| 7.3 | saleOrderCode | string | Sale Order Code | - |
| 7.4 | reversePickupCode | string | Reverse Pickup Code | - |
| 7.5 | trackingNumber | string | Tracking Number | - |
| 7.6 | shippingProviderCode | string | Shipping Provider Code | - |
| 7.7 | courierName | string | Courier Name | - |
| 7.8 | returnCreatedDate | date | Return Created Date | - |
| 7.9 | channelReturnCreatedDate | date | Channel Return Created Date | - |
| 7.10 | returnDeliveryDate | date | Return Delivery Date | - |
| 7.11 | rtoTrackingNumber | string | RTO Tracking Number | - |
| 7.12 | rtoShippingProviderCode | string | RTO Shipping Provider Code | - |
| 7.13 | rtoCourierName | string | RTO Courier Name | - |
| 7.14 | rtoReason | string | RTO Reason | - |
| 7.15 | boxSpecification | Object | Box Specification | - |
| 7.15.1 | boxLength | integer | Box Length | - |
| 7.15.2 | boxWidth | integer | Box Width | - |
| 7.15.3 | boxHeight | integer | Box Height | - |
| 7.15.4 | boxWeight | integer | Box Weight | - |
| 7.16 | inventoryReceivedDate | date | Inventory received Date | e.g. 1713345896000 |
| 7.17 | returnCompletedDate | date | Return completed date | e.g. 1713345886000 |
| 7.18 | returnInvoiceCode | string | Return invoice code (Credit Note) | Only generated for return cases |
| 7.19 | putawayCode | string | putaway code | - |
| 8 | customFieldValues | list | Custom field details | - |
| 8.1 | fieldName | string | Custom field name | - |
| 8.2 | fieldValue | object | Custom field value | - |
| 8.3 | valueType | string | Value type | - |
| 8.4 | displayName | string | Name to be displayed | - |
| 8.5 | required | boolean | true if required | - |
| 8.6 | possibleValues | list | Possible values for custom field | - |
Error Codes
Refer Response Codes section to know about specific errors codes.