Accept or Reject Sale Order
This REST API is used by POS systems to post accepted and rejected orders 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.
Flow
Tip
Complete integration flow is available on Basic Overview page.
Basic Information
| NAME | DETAILS |
|---|---|
| Endpoint: | /services/rest/v1/facility/confirm |
| 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": "SO1009987",
"username": "abc@unicommerce.com",
"confirmedSaleOrderItemCodes": [],
"rejectedSaleOrderItems": [
{
"saleOrderItemCode": "tcns-bundle-0-0",
"rejectionReason": "DAMAGED"
},
{
"saleOrderItemCode": "tcns-bundle-0-1",
"rejectionReason": "DAMAGED"
}
]
}Request Payload Details
| LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|---|
| 1 | saleOrderCode | string | Sale order code | Yes | - |
| 2 | username | string | Username | No | Eg: abc@unicommerce.com |
| 3 | confirmedSaleOrderItemCodes | object | Item codes for confirmed sale order items | Yes | - |
| 4 | rejectedSaleOrderItems | object | Item codes for rejected sale order items | Yes | - |
| 4.1 | saleOrderItemCode | string | Sale order item code | Yes | - |
| 4.2 | rejectionReason | string | Reason for rejection | Yes | Eg: DAMAGED |
| 4.3 | saleOrderItemCode | string | Sale order item code | Yes | - |
| 4.4 | rejectionReason | string | Reason for rejection | Yes | Eg: DAMAGED |
Response Payload
{
"successful": true,
"message": null,
"errors": [],
"warnings": null
}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 | - |
| 4 | warnings | list | List of warnings | - |
Error Codes
Refer Response Codes section to know about specific errors codes.