GatePass Discard

This REST API is used to notify the Partner when the Gatepass has been discarded in Uniware.

Tip

  • The access token received in response is required in Header (apikey) in all subsequent API requests.
  • 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
BaseUrl: https://{PartnerBaseUrl}
Endpoint: /discardGatepass
Request Type: POST
Scheme: HTTPS
Header (Content-Type): application/json
Header (Authorization): token value(got from Authentication

Request Payload

{
  "code": "GPJ1000214",
  "statusCode": "DISCARDED",
  "gatePassOrderCode": null,
  "reference": "",
  "updated": 1593590731000
}

Request Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 code string Gatepass number Yes -
2 statusCode string Gatepass status Yes DISCARDED
3 gatePassOrderCode string GatePass Order Code Yes -
4 reference string - Yes -
5 updated date Updation Date Yes Eg: 1593590731000

Response Payload

{
    "status": "Success",
    "message": "Detail is updated successfully"    
}

Response Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 status string Success after notification is acknowledged Yes Success/Failed
2 message string Readable response message Yes -

Error Codes

Refer Response Codes section to know about specific errors codes.

FAQs/Notes

Q1. What would be that frequency of Notification push to partner?
Ans. Real-time or nearly real-time.

Unicommerce Website

Copyright © 2024 Unicommerce eSolutions Pvt. Ltd.