Get Gatepass
This REST API is used to fetch details of gatepasses from Uniware. The Gatepass code can be searched in Uniware using Search Gatepass API.
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/get |
| 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
{
"gatePassCodes": [
"GPJ1000214"
]
}Request Payload Details
| PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|
| gatePassCodes | list | Gatepass code(s) | Yes | Eg: GPJ1000214 |
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"
}
],
"elements": [
{
"id": 0,
"code": "GPJ1000214",
"statusCode": "RETURN_AWAITED",
"type": "STOCK_TRANSFER",
"invoiceCode": null,
"invoiceDisplayCode": null,
"returnInvoiceCode": null,
"returnInvoiceDisplayCode": null,
"toPartyName": "Unique Exports",
"gatePassOrderCode": null,
"reference": "",
"purpose": "",
"username": "sushant@unicommerce.com",
"created": 1593590417000,
"updated": 1593590731000,
"gatePassItemDTOs": [
{
"gatePassItemId": null,
"gatePassItemStatus": "RETURN_AWAITED",
"itemCode": "2003061021238",
"itemStatus": null,
"inventoryType": "GOOD_INVENTORY",
"itemTypeName": "act44",
"itemTypeSKU": "act44",
"itemTypeImageUrl": null,
"itemTypePageUrl": null,
"inflowReceiptCode": null,
"itemCondition": null,
"reason": null,
"total": 0,
"unitPrice": 84.75,
"taxPercentage": 0,
"integratedGstPercentage": 0,
"unionTerritoryGstPercentage": 0,
"stateGstPercentage": 0,
"centralGstPercentage": 0,
"compensationCessPercentage": 0,
"quantity": 1,
"receivedQuantity": 0,
"pendingQuantity": 0,
"shelfCode": "DEFAULT",
"hsnCode": "",
"batchDTO": null
},
{
"gatePassItemId": null,
"gatePassItemStatus": "RETURN_AWAITED",
"itemCode": "2001031019660",
"itemStatus": null,
"inventoryType": "GOOD_INVENTORY",
"itemTypeName": "Test",
"itemTypeSKU": "Test",
"itemTypeImageUrl": null,
"itemTypePageUrl": null,
"inflowReceiptCode": null,
"itemCondition": null,
"reason": null,
"total": 0,
"unitPrice": 1000,
"taxPercentage": 0,
"integratedGstPercentage": 0,
"unionTerritoryGstPercentage": 0,
"stateGstPercentage": 0,
"centralGstPercentage": 0,
"compensationCessPercentage": 0,
"quantity": 1,
"receivedQuantity": 0,
"pendingQuantity": 0,
"shelfCode": "yahoo",
"hsnCode": "",
"batchDTO": null
}
],
"customFieldValues": 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 (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 | elements | list | List of gatepass details | - |
| 5.1 | id | integer | ID | - |
| 5.2 | code | string | Gatepass code | Eg: GPJ1000214 |
| 5.3 | statusCode | enum | Gatepass status | CREATED, CLOSED, DISCARDED, RETURN_AWAITED |
| 5.4 | type | enum | Gatepass type | RETURNABLE, NON_RETURNABLE, RETURN_TO_VENDOR, STOCK_TRANSFER |
| 5.5 | invoiceCode | string | Invoice code | - |
| 5.6 | invoiceDisplayCode | string | Invoice display code | - |
| 5.7 | returnInvoiceCode | string | Return invoice code | - |
| 5.8 | returnInvoiceDisplayCode | string | Return invoice display code | - |
| 5.9 | toPartyName | string | Party name | Eg: Unique Exports |
| 5.10 | gatePassOrderCode | string | Order code | - |
| 5.11 | reference | string | - | - |
| 5.12 | purpose | string | Purpose | Max. chars: 500 |
| 5.13 | username | string | Username | - |
| 5.14 | created | date | Gatepass creation date | Eg: 1593590417000 |
| 5.15 | updated | date | Updation Date | Eg: 1593590731000 |
| 5.16 | gatePassItemDTOs | list | Gatepass item list | - |
| 5.16.1 | gatePassItemId | integer | Item IDs | - |
| 5.16.2 | gatePassItemStatus | enum | Item status | Eg: RETURN_AWAITED |
| 5.16.3 | itemCode | string | Item code | Eg: 2003061021238 |
| 5.16.4 | itemStatus | string | Item status | - |
| 5.16.5 | inventoryType | enum | Inventory type | Allowable: GOOD_INVENTORY, BAD_INVENTORY, QC_REJECTED, VIRTUAL_INVENTORY |
| 5.16.6 | itemTypeName | string | Item type name | - |
| 5.16.7 | itemTypeSKU | string | Item type | - |
| 5.16.8 | itemTypeImageUrl | string | Item type image URL | - |
| 5.16.9 | itemTypePageUrl | string | Item type page URL | - |
| 5.16.10 | inflowReceiptCode | string | Receipt code | - |
| 5.16.11 | itemCondition | string | Item condition | - |
| 5.16.12 | reason | string | Reason | - |
| 5.16.13 | total | number | Total amount | - |
| 5.16.14 | unitPrice | number | Unit price | - |
| 5.16.15 | taxPercentage | number | Tax percentage | Default: 0 |
| 5.16.16 | integratedGstPercentage | number | IGST percentage | - |
| 5.16.17 | unionTerritoryGstPercentage | number | UT GST percentage | - |
| 5.16.18 | stateGstPercentage | number | State GST percentage | - |
| 5.16.19 | centralGstPercentage | number | Central GST percentage | - |
| 5.16.20 | compensationCessPercentage | number | Compensation cess percentage | - |
| 5.16.21 | quantity | integer | Quantity | - |
| 5.16.22 | receivedQuantity | integer | Quantity received | - |
| 5.16.23 | pendingQuantity | integer | Pending quantity | - |
| 5.16.24 | shelfCode | string | Shelf code | Default: DEFAULT |
| 5.16.25 | hsnCode | string | 6 digit uniform code that classifies products worldwide | - |
| 5.16.26 | batchDTO | list | - | - |
| 5.17 | customFieldValues | list | Custom field details | - |
Error Codes
Refer Response Codes section to know about specific errors codes.