Return Completed
This REST API is used to notify the Partner when the return has been completed in Uniware.
Tip
- The access token received in response is required in Header (Authorization) in all subsequent API requests.
- 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 |
---|---|
BaseUrl: | https://{PartnerBaseUrl} |
Endpoint: | /completeReturn |
Request Type: | POST |
Scheme: | HTTPS |
Header (Content-Type): | application/json |
Header (Authorization): | token value(got from Authentication |
Request Payload
{
"orderId": "5955731816755",
"returnId": "WEAR-46917",
"shippingPackageCode": "WEAR-46917",
"courierName": "PROSHIP",
"status": "RETURNED",
"returnReason": "RTO",
"type": "RTO - Return To Origin",
"createdOn": "Jul 16, 2024 12:00:57 PM",
"completedAt": "Jul 19, 2024 10:29:48 AM",
"facilityCode": "wearcomet",
"trackingNumber": "19108910167974",
"invoiceNumber": "VBRIN0140",
"orderItems": [
{
"orderItemId": "SO1777-10-3",
"bundleIdentifier": "SO1777-10",
"skuCode": "sj1",
"customFieldValues": [
{
"name": "Rewardspointsamount",
"value": null
}
]
}
],
"customFieldValues": [
]
}
Request Payload Details
LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
---|---|---|---|---|---|
1 | orderId | string | Sale order code | Yes | - |
2 | returnId | string | Return id | Yes | - |
3 | facilityCode | string | Uniwre warehouse code | Yes | - |
4 | shippingPackageCode | string | Shipment code | Condi | Only for type = “RTO - Return To Origin” for RTO |
5 | courierName | string | Courier name | Yes | - |
6 | status | string | Return status | Yes | for CIR, it is “COMPLETED”, for RTO it is “RETURNED” |
7 | returnReason | string | Return reason | Yes | - |
8 | type | string | Return type | Yes | “CUSTOMER_RETURN” for CIR or “RTO - Return To Origin” for RTO |
9 | createdOn | Date | date-time Eg: Feb 13, 2023 4:01:45 PM | Yes | - |
10 | completedAt | Date | date-time Eg: Feb 13, 2023 4:01:45 PM | Yes | - |
11 | trackingNumber | string | trackingNumber(AWB) | Yes | - |
12 | facilityCode | string | Facility Code | Yes | - |
13 | invoiceNumber | string | invoiceNumber | Yes | - |
14 | customFields | object | Custom fields details | Opt | - |
15 | orderItems | object | Order Items details | Yes | - |
16 | orderItemId | string | OrderItems Ids | Yes | - |
17 | bundleIdentifier | string | Bundle Identifier | Yes | - |
18 | skuCode | string | SKU code | Yes | - |
19 | customFieldValues | object | Custom fields details | Opt | - |
Response Payload
{
"status": "Success",
"message": "Detail is updated successfully"
}
Response Payload Details
LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
---|---|---|---|---|---|
1 | status | string | Success after notification is acknowledged | Yes | Success/Failed |
2 | message | string | Readable response message | Yes | - |
Error Codes
Refer Response Codes section to know about specific errors codes.
FAQs/Notes
Q1. What would be that frequency of Notification push to partner?
Ans. Real-time or nearly real-time.