Search Gatepass

This REST API is used to search gatepasses in Uniware based on pre-defined filters. The Gatepass code elements.code received in response payload is used in Get Gatepass API to get details of a particular 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/search
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

{
   "fromDate": "2020-06-29T00:00:00",
   "toDate": "2020-07-02T00:00:00",
   "type": "STOCK_TRANSFER",
   "toParty": "Unique Exports",
   "statusCode": "RETURN_AWAITED"
}

Request Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 fromDate date Filter start date Yes Eg: 2020-06-29T00:00:00
2 toDate date Filter end date Yes Eg: 2020-07-02T00:00:00
3 type enum Gatepass type No RETURNABLE, NON_RETURNABLE, RETURN_TO_VENDOR, STOCK_TRANSFER
4 toParty string Party name No Eg: Unique Exports
5 statusCode enum Gatepass status No CREATED, CLOSED, DISCARDED, RETURN_AWAITED

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"
      }
   ],
   "totalRecords": null,
   "elements": [
      {
         "username": "sushant@unicommerce.com",
         "code": "GPJ1000214",
         "type": "STOCK_TRANSFER",
         "statusCode": "RETURN_AWAITED",
         "created": 1593590417000,
         "toParty": "Unique Exports",
         "reference": ""
      }
   ]
}

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 totalRecords integer Total records found -
6 elements list List of gatepass details found -
6.1 username string Username -
6.2 code string Gatepass code Eg: GPJ1000214
6.3 type enum Gatepass type RETURNABLE, NON_RETURNABLE, RETURN_TO_VENDOR, STOCK_TRANSFER
6.4 statusCode enum Gatepass status CREATED, CLOSED, DISCARDED, RETURN_AWAITED
6.5 created date Gatepass creation date -
6.6 toParty string Party name Eg: Unique Exports
6.7 reference string - -

Error Codes

Refer Response Codes section to know about specific errors codes.

Unicommerce Website

Copyright © 2022 Unicommerce eSolutions Pvt. Ltd.