Scan Item
This REST API is used to mark an item scanned for issuing gatepass.
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/gatepass/scan/item |
| 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
{
"gatePassCode": "string",
"itemCode": "string"
}Request Payload Details
| LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|---|
| 1 | gatePassCode | string | Gatepass code | Yes | - |
| 2 | itemCode | string | Item 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"
}
],
"scannedItem": {
"itemCode": "string",
"itemName": "string",
"itemSKU": "string",
"inventoryType": "string",
"shelfCode": "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 | 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 | - |
| 5 | scannedItem | object | Scanned item details | - |
| 5.1 | itemCode | string | Item code | - |
| 5.2 | itemName | string | Item name | - |
| 5.3 | itemSKU | string | Item SKU code | - |
| 5.4 | inventoryType | enum | Inventory type | Allowable: GOOD_INVENTORY, BAD_INVENTORY, QC_REJECTED, VIRTUAL_INVENTORY |
| 5.5 | shelfCode | string | Shelf code | - |
Error Codes
Refer Response Codes section to know about specific errors codes.