Mark Sale Order Returned
This REST API is used to update sale order(s) status as returned in Uniware.
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/saleOrder/markReturned |
Request Type: | POST |
Level: | Facility |
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
{
"saleOrderCode": "string",
"saleOrderItems": [
{
"code": "string",
"status": "string",
"shelfCode": "string",
"reason": "string"
}
],
"returnReason": "string",
"returnCode": "string"
}
Request Payload Details
LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
---|---|---|---|---|---|
1 | saleOrderCode | string | Sale order code | Yes | - |
2 | saleOrderItems | list | Details of items in sale order | Yes | - |
2.1 | code | string | Item code | Yes | - |
2.2 | status | string | Status | No | - |
2.3 | shelfCode | string | Shelf code of the item | No | - |
2.4 | reason | string | Reason | No | - |
3 | returnReason | string | Reason for return | Yes | - |
4 | returnCode | string | Return code | No | - |
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"
}
]
}
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 | number | Error code | - |
3.2 | fieldName | string | Field with error | - |
3.3 | description | string | Warning 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 | - |
Error Codes
Refer Response Codes section to know about specific errors codes.