Get Vendor Backorder Items

This REST API is used to fetch backorder items for a vendor in Uniware.

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/getVendorBackOrderItems
Request Type:	POST
Level:	Tenant
Scheme:	HTTPS
Header (Content-Type):	application/json
Header (Authorization):	bearer {access-token}, Eg.: bearer b30f3aea-7978-49bb-9ea7-33eddfc80afa

Request Payload

{
   "vendorId": 0,
   "itemTypeName": "string",
   "categoryCode": "string",
   "noVendors": true,
   "searchOptions": {
      "searchKey": "string",
      "displayLength": 0,
      "displayStart": 0,
      "columns": 0,
      "sortingCols": 0,
      "sortColumnIndex": 0,
      "sortDirection": "string",
      "columnNames": "string",
      "getCount": true
   }
}

Request Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	vendorId	integer	Vendor ID	Opt.	-
2	itemTypeName	string	Item type name	Opt.	-
3	categoryCode	string	Category code in Uniware, else pass ‘null’	Opt.	-
4	noVendors	boolean	true if no vendors	Opt.	-
5	searchOptions	object	List of filter parameters	Opt.	-
5.1	searchKey	string	Search keywords	Opt.	-
5.2	displayLength	integer	Length displayed	Opt.	-
5.3	displayStart	integer	-	Opt.	-
5.4	columns	integer	-	Opt.	-
5.5	sortingCols	integer	-	Opt.	-
5.6	sortColumnIndex	integer	-	Opt.	-
5.7	sortDirection	string	-	Opt.	-
5.8	columnNames	string	-	Opt.	-
5.9	getCount	boolean	-	Opt.	-

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"
      }
   ],
   "elements": [
      {
         "skuCode": "string",
         "name": "string",
         "itemTypeImageUrl": "string",
         "itemTypePageUrl": "string",
         "waitingQuantity": 0,
         "color": "string",
         "brand": "string",
         "size": "string",
         "vendorItemTypes": [
            {
               "vendorId": 0,
               "vendorCode": "string",
               "vendorName": "string",
               "vendorSkuCode": "string",
               "unitPrice": 0
            }
         ]
      }
   ],
   "totalRecords": 0
}

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	elements	list	-	-
5.1	skuCode	string	SKU code of the item on the marketplace	Eg: BD_Floral_3
5.2	name	string	Name	-
5.3	itemTypeImageUrl	string	Item type image URL	-
5.4	itemTypePageUrl	string	Item type page URL	-
5.5	waitingQuantity	integer	-	-
5.6	color	string	Color description	-
5.7	brand	string	Brand of the item	Eg: Bombay Dyeing
5.8	size	string	Size	Format: LxBxH, Unit: mm, Eg: 60.00X40.00X2.00
5.9	vendorItemTypes	list	-	-
5.9.1	vendorId	integer	Vendor ID	-
5.9.2	vendorCode	string	Vendor code	-
5.9.3	vendorName	string	Vendor name	-
5.9.4	vendorSkuCode	string	Vendor SKU code	-
5.9.5	unitPrice	number	Unit price	-
6	totalRecords	integer	Total no. of records found	-

Error Codes

Refer Response Codes section to know about specific errors codes.