Search Purchase Order
This REST API is used to search puchase orders (PO)s 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/purchase/purchaseOrder/getPurchaseOrders |
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
{
"approvedBetween": {
"start": "2023-10-12T06:22:15.501Z",
"end": "2023-10-13T12:14:15.501Z"
},
"createdBetween": {
"start": "2023-10-12T06:22:15.501Z",
"end": "2023-10-13T12:12:15.501Z"
}
}
Request Payload Details
LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
---|---|---|---|---|---|
1 | approvedBetween | object | PO Approved time filter | Yes | - |
1.1 | start | date | Filter start date | Yes | Eg.:2021-06-01T03:52:13.812Z |
1.2 | end | date | Filter end date | Yes | Eg.:2022-06-01T03:52:13.812Z |
2 | createdBetween | object | PO Created time filter | Yes | - |
2.1 | start | date | Filter start date | Yes | Eg.:2021-06-01T03:52:13.812Z |
2.2 | end | date | Filter end date | Yes | Eg.:2022-06-01T03:52:13.812Z |
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"
}
],
"purchaseOrderCodes": [
"PO0838",
"PO0839",
"PO0840"
]
}
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 | - |
5 | purchaseOrderCodes | List | PO records found | - |
Error Codes
Refer Response Codes section to know about specific errors codes.