GatePass Return Awaited

This REST API is used to notify the Partner when the Gatepass is in return awaited state 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: /awaitedGatepass
Request Type: POST
Scheme: HTTPS
Header (Content-Type): application/json
Header (Authorization): token value(got from Authentication

Request Payload

{
  "code": "GPJ1000214",
  "statusCode": "RETURN_AWAITED",
  "type": "STOCK_TRANSFER",
  "toPartyName": "Unique Exports",
  "gatePassOrderCode": null,
  "reference": "",
  "purpose": "",
  "created": "1593590417000",
  "updated": "1593590731000",
  "gatePassItemDTOs": [
    {
      "gatePassItemStatus": "RETURN_AWAITED",
      "inventoryType": "GOOD_INVENTORY",
      "itemTypeSKU": "act44",
      "itemBarcode": "abhc989, DEF67, hdsui89",
      "quantity": 3,
      "receivedQuantity": 0,
      "pendingQuantity": 0,
      "shelfCode": "DEFAULT",
      "batchDTO": null,
      "total": 0,
      "unitPrice": 84.75,
      "tax": 0,
      "igst": 0,
      "utgst": 0,
      "sgst": 0,
      "cgst": 0,
      "invoiceCode": null,
      "returnInvoiceCode": null
    },
    {
      "gatePassItemStatus": "RETURN_AWAITED",
      "inventoryType": "BAD_INVENTORY",
      "itemTypeSKU": "act44",
      "itemBarcode": "a34, T879",
      "quantity": 2,
      "receivedQuantity": 0,
      "pendingQuantity": 0,
      "shelfCode": "DEFAULT",
      "batchDTO": null,
      "total": 0,
      "unitPrice": 84.75,
      "tax": 0,
      "igst": 0,
      "utgst": 0,
      "sgst": 0,
      "cgst": 0,
      "invoiceCode": null,
      "returnInvoiceCode": null
    }
  ],
  "customFieldValues": null
}

Request Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 code date Unique code or identifier for gatepass Yes -
2 statusCode date Gatepass status e.g.”RETURN_AWAITED” Yes -
3 type date Type of the gatepass e.g.”STOCK_TRANSFER” Yes -
4 toPartyName date Name of the receiving party Yes -
5 gatePassOrderCode date gate pass order code (if any). Yes -
6 reference date Reference information for the gatepass Yes -
7 purpose date Purpose or reason for the gatepass Yes -
8 created date Creation timestamp Yes -
9 updated date Last update timestamp Yes -
10 gatePassItemDTOs object Transferred items details Yes -
10.1 gatePassItemStatus date Transferred item status e.g. “RETURN_AWAITED” Yes -
10.2 inventoryType date Inventory type e.g. “GOOD_INVENTORY” or “BAD_INVENTORY” Yes -
10.3 itemTypeSKU date SKU code for the item type Yes -
10.4 itemBarcode date Barcodes associated with the item Yes -
10.5 quantity date Total quantity of the item being transferred Yes -
10.6 receivedQuantity date Quantity of the item received Yes -
10.7 pendingQuantity date Quantity of pending items Yes -
10.8 shelfCode date Code for the storage location Yes -
10.9 batchDTO object Batch-related details (if any) Yes -
10.10 total date Total value for the item Yes -
10.11 unitPrice date Unit price of the item. Yes -
10.12 tax number Tax amount for the item Yes -
10.13 cgst number CGST for the item Yes -
10.14 sgst number SGST for the item Yes -
10.15 igst number IGST for the item Yes -
10.16 utgst number UTGST for the item Yes -
10.17 invoiceCode date Associated invoice code (if any) Yes -
10.18 returnInvoiceCode date Associated return invoice (if any) Yes -
11 customFieldValues object An array of custom field values Yes -
11.1 fieldName string Custom field name No -
11.2 fieldValue string Custom field value No -

NOTE:

  • In case of GatePass SKU level traceability, line items will be sent on SKU * Qty basis and itemBarcode field will be empty whereas in case of GatePass Item level traceability, line items will be sent on itemBarcode level.

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.