Purchase Order Created

This REST API is used to notify the Partner when the purchase order (PO) is created and approved 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:	/approvedPurchaseOrder
Request Type:	POST
Scheme:	HTTPS
Header (Content-Type):	application/json
Header (Authorization):	token value(got from Authentication

Request Payload

{
  "code": "PO0194",
  "created": "Mar 12, 2024 4:16:42 PM",
  "createdBy": "xyz@gmail.com",
  "deliveryDate": "Mar 12, 2024 4:16:42 PM",
  "expiryDate": "Mar 15, 2024 4:16:42 PM",
  "fromParty": "neemka",
  "statusCode": "APPROVED",
  "type": "Manual",
  "vendorCode": "Sachin123",
  "vendorName": "Sachin Enterprise",
  "amendedPurchaseOrderCode": null,
  "amendmentPurchaseOrderCode": null,
  "purchaseOrderItems": [
    {
      "batchGroupCode": null,
      "discount": 0,
      "discountPercentage": 0,
      "itemSKU": "Shirt27",
      "itemTypeCustomFields": null,
      "logisticCharges": 0,
      "maxRetailPrice": 400,
      "quantity": 6,
      "tax": 0,
      "taxPercentage": 0,
      "cgst": "string",
      "sgst": "string",
      "igst": "string",
      "utgst": "string",
      "total": 600,
      "unitPrice": 100,
      "vendorSkuCode": "shirt27",
      "customFieldValues": [
        {
          "name": "string",
          "value": "string"
        }   
      ]
    }
  ],
  "customFieldValues": [
    {
      "fieldName": "string",
      "fieldValue": "string"
    }
  ]
}

Request Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	code	string	Purchase order code	Yes	-
2	created	Date	When the purchase order was created	Yes	-
3	createdBy	string	Email address of the user who created the purchase order	Yes	-
4	deliveryDate	Date	Expected delivery date for the order	Yes	-
5	expiryDate	Date	Expiry date of the order	Yes	-
6	fromParty	string	Name of the party from which the order originates	Yes	-
7	statusCode	string	Status code of the purchase order e.g.”APPROVED”	Yes	-
8	type	string	Type of purchase order e.g.”Manual”	Yes	-
9	vendorCode	string	Code of the vendor associated with the purchase order	Yes	-
10	vendorName	string	Name of the vendor	Yes	-
11	amendedPurchaseOrderCode	string	Amended purchase order code, null if not applicable	Yes	-
12	amendmentPurchaseOrderCode	string	Amendment purchase order code, null if not applicable	Yes	-
13	purchaseOrderItems	object	Details of purchase order items	Yes	-
13.1	batchGroupCode	string	Batch group code for the item, null	Yes	-
13.2	discount	number	Discount amount for the item	Yes	-
13.3	discountPercentage	number	Discount percentage for the item	Yes	-
13.4	itemSKU	string	SKU code of the item	Yes	-
13.5	itemTypeCustomFields	object	An array of custom field	Yes	-
13.6	logisticCharges	number	Logistic charges for the item	Yes	-
13.7	maxRetailPrice	number	Maximum retail price for the item	Yes	-
13.8	quantity	number	Quantity of the item ordered	Yes	-
13.9	tax	number	Tax amount for the item	Yes	-
13.10	taxPercentage	number	Tax percentage for the item	Yes	-
13.11	cgst	number	CGST for the item	Yes	-
13.12	sgst	number	SGST for the item	Yes	-
13.13	igst	number	IGST for the item	Yes	-
13.14	utgst	number	UTGST for the item	Yes	-
13.15	total	number	Total cost for the quantity of items ordered	Yes	-
13.16	unitPrice	number	Unit price of the item	Yes	-
13.17	vendorSkuCode	string	SKU code of the item from the vendor	Yes	-
13.18	customFieldValues	object	Custom field values associated	Yes	-
13.18.1	fieldName	string	Custom field name	No	-
13.18.2	fieldValue	string	Custom field value	No	-
14	customFieldValues	object	Custom field values associated	Yes	-
14.1	fieldName	string	Custom field name	No	-
14.2	fieldValue	string	Custom field value	No	-

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.