GRN Completion

This REST API is used to notify the Partner when the GRN has been completed in Uniware.

Tip

The access token received in response is required in Header (Authorization) 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:	/completeInflowReceipt
Request Type:	POST
Scheme:	HTTPS
Header (Content-Type):	application/json
Header (Authorization):	token value(got from Authentication

Request Payload

{
  "GRNCreatedDateTime": "Jul 9, 2024 3:34:35 PM",
  "GRNnumber": "",
  "poNumber": "",
  "putAwayCreatedDateTime": "Jul 9, 2024 3:34:35 PM",
  "vendorInvoiceNumber": "",
  "vendorCode": "string",
  "vendorInvoiceDate": "Jul 9, 2024 3:34:35 PM",
  "grnItems": [
    {
      "vendorSkuCode": "",
      "grnItemBarcode": "abc, def, xyz",
      "Quantity": "",
      "rejectedQuantity": "",
      "rejectionComments": "string",
      "unitPrice": 0,
      "sellableQuantity": "",
      "pendingQuantity": "",
      "skuCode": "",
      "additionalCost": 0,
      "batchCode": "string",
      "discount": 0,
      "discountPercentage": 0,
      "expiry": "Jul 9, 2024 3:34:35 PM",
      "manufacturingDate": "Jul 9, 2024 3:34:35 PM",
      "maxRetailPrice": 0,
      "unitPrice": 0
    },
    {
      "vendorSkuCode": "",
      "grnItemBarcode": "abc, def, xyz",
      "Quantity": "",
      "rejectedQuantity": "",
      "rejectionComments": "string",
      "unitPrice": 0,
      "sellableQuantity": "",
      "pendingQuantity": "",
      "skuCode": "",
      "additionalCost": 0,
      "batchCode": "string",
      "discount": 0,
      "discountPercentage": 0,
      "expiry": "Jul 9, 2024 3:34:35 PM",
      "manufacturingDate": "Jul 9, 2024 3:34:35 PM",
      "maxRetailPrice": 0,
      "unitPrice": 0
    }
  ],
  "customFieldValues": [
    {
      "fieldName": "string",
      "fieldValue": "string"
    }
  ]
}

Request Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	GRNCreatedDateTime	date	Date and time of GRN creation	Yes	-
2	GRNnumber	string	Goods Receipt Note number	Yes	-
3	poNumber	string	Purchase order code	Yes	-
4	putAwayCreatedDateTime	string	Date and time of putaway creation	Yes	-
5	vendorInvoiceNumber	string	Vendor invoice number	Yes	-
6	vendorCode	string	Code of the vendor	Yes	-
7	vendorInvoiceDate	date	Date of vendor invoice creation	Yes	-
8	grnItems	object	Array of received items	Yes	-
8.1	vendorSkuCode	string	Vendor’s SKU code for the item	Yes	-
8.2	grnItemBarcode	string	Item Barcodes(comma-separated)	Yes	-
8.3	Quantity	number	Quantity of the received item	Yes	-
8.4	rejectedQuantity	number	Quantity of rejected item	Yes	-
8.5	rejectionComments	string	Comments/reasons for rejection	Yes	-
8.6	unitPrice	number	Unit price of the item	Yes	-
8.7	sellableQuantity	number	Quantity of sellable item	Yes	-
8.8	pendingQuantity	number	Quantity of pending item	Yes	-
8.9	skuCode	string	SKU code of the received item	Yes	-
8.10	additionalCost	number	Additional cost associated	Yes	-
8.11	batchCode	string	Batch code of the item	Yes	-
8.12	discount	number	Discount amount for the item	Yes	-
8.13	discountPercentage	number	Discount percentage for the item	Yes	-
8.14	expiry	Date	Expiry date of the item	Yes	-
8.15	manufacturingDate	Date	WManufacturing date of the item	Yes	-
8.16	maxRetailPrice	number	Maximum retail price of the item	Yes	-
9	customFieldValues	object	An array of custom field values	Yes	-
9.1	fieldName	string	Custom field name	No	-
9.2	fieldValue	string	Custom field value	No	-

NOTE:

In case of SKU level traceability, putAwayCreatedDateTime will be equivalent to GRN completion timestamp i.e. updated timestamp and putAwayStatus will be hardcoded to ‘CREATED’. But in case of Item level traceability, putAwayCreatedDateTime & putAwayStatus will be picked from Items table.

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.