Verify Sale Order
This REST API is used by seller (using Uniware) to post acceptance on marketplace for orders in ‘pending_verification’ stage.
Usecase: Some marketplaces require the sellers to accept the order for processing. Such orders when fetched from marketplace in Uniware, are tagged with ‘Pending_Verification’ status. The seller can accept such orders either through user interface or by using this API. Post this, the order status changes to ‘Processing’.
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/verify |
| 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"
}Request Payload Details
| PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|
| saleOrderCode | string | Sale order code | Yes | - |
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.