Search Return
This REST API is used to search the returns within specific date range from Uniware using either CIR
or RTO
.
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/search |
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
{
"returnType":"CIR",
"statusCode":"CREATED",
"forwardItemFacility":"GGN",
"createdTo":"2022-06-04T14:20:40",
"createdFrom":"2022-05-05T14:20:40",
"updatedTo":null,
"updatedFrom":null,
}
Request Payload Details
LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
---|---|---|---|---|---|
1 | returnType | string | Return type | Yes | Use either CIR or RTO |
2 | statusCode | enum | Return status code | Opt | CIR- CREATED, CANCELED, COMPLETE, NOT_RECEIVED RTO- RECEIVED and NOT_RECEIVED |
3 | forwardItemFacility | string | Facility code | Opt | - |
4 | createdTo | date | Return created to | Opt | Format:dd-mmm-yyyy HH:mm:ss Eg: 16-Dec-2022 00:00:00 |
5 | createdFrom | date | Return created from | Opt | Format:dd-mmm-yyyy HH:mm:ss Eg: 16-Oct-2022 00:00:00 |
6 | updatedTo | date | Return updated to | Opt | Format:dd-mmm-yyyy HH:mm:ss Eg: 16-Sep-2021 00:00:00 |
7 | updatedFrom | date | Returns updated from | Opt | Format:dd-mmm-yyyy HH:mm:ss Eg: 16-Sep-2021 00:00:00 |
NOTE:
Use Return Type either CIR or RTO with valid CIR / RTO Status code, but not in both. Same for date, use either created or updated date range.
Maximum time difference allowed between (updatedFrom to updatedTo) or (createdFrom to createdTo) is 30 days with respect of Uniware system timestamp for creation/updation of return data.
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"
}
],
"returnType": "CIR",
"returnOrders": [
{
"code": "RP0034",
"updated": "2022-05-13 14:19:49",
"created": "2022-05-13 00:00:00"
}
]
}
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 | returnType | object | Return type | e.g. CIR, RTO |
6 | returnOrders | list | List of return orders | - |
6.1 | code | string | Return Code | - |
6.2 | updated | date | Return updated date | - |
6.3 | created | date | Return created date | - |
Error Codes
Refer Response Codes section to know about specific errors codes.