Cancel Sale Order
This REST API is used to cancel the sale order(s) in Uniware. This should be done before the order is dispatched by seller.
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/saleOrder/cancel |
Request Type: | POST |
Level: | Tenant |
Scheme: | HTTPS |
Header (Content-Type): | application/json |
Header (Authorization): | bearer {access-token}, Eg.: bearer b30f3aea-7978-49bb-9ea7-33eddfc80afa |
Request Payload
{
"saleOrderCode": "string",
"saleOrderItemCodes": [
"string"
],
"cancelPartially": true,
"cancelOnChannel": true,
"cancelledBySeller": false,
"cancellationReason": "string"
}
Request Payload Details
PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
---|---|---|---|---|
saleOrderCode | string | Sale order code | Yes | - |
saleOrderItemCodes | string | Sale order item code | No | - |
cancelPartially | boolean | true if cancellation is partial | No | - |
cancelOnChannel | boolean | true if cancellation is on channel | No | Default: true |
cancelledBySeller | boolean | true if cancellation done by seller/party | No | Either select cancelOnChannel or cancelledBySeller |
cancellationReason | string | Reason for cancellation | No | Max chars: 100 |
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 | boolean | 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 | - |
Error Codes
Refer Response Codes section to know about specific errors codes.