Search Item(s)
This REST API is used to search item(s) in Uniware. The request payload fields can be used as filter to narrow down the search and retrieve the relevant entries only.
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/product/itemType/search |
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
{
"keyword": "string",
"productCode": "string",
"categoryCode": "string",
"getInventorySnapshot": true,
"updatedSinceInHour" : 0,
"skuType": "string",
"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 | keyword | string | Keyword | Opt. | - |
2 | productCode | string | Product SKU code | Opt. | - |
3 | categoryCode | string | Category code in Uniware, else pass ‘null’ | Opt. | - |
4 | getInventorySnapshot | boolean | true to get inventory details | Opt. | - |
5 | updatedSinceInHour | integer | - | Opt. | - |
6 | skuType | string | - | Opt. | - |
7 | searchOptions | object | List of filter parameters | Opt. | - |
7.1 | searchKey | string | Search keywords | Opt. | - |
7.2 | displayLength | integer | Length displayed | Opt. | Max. chars: 500 |
7.3 | displayStart | integer | - | Opt. | - |
7.4 | columns | integer | - | Opt. | - |
7.5 | sortingCols | integer | - | Opt. | - |
7.6 | sortColumnIndex | integer | - | Opt. | - |
7.7 | sortDirection | string | - | Opt. | - |
7.8 | columnNames | string | - | Opt. | - |
7.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"
}
],
"totalRecords": 0,
"elements": [
{
"skuCode": "string",
"name": "string",
"description": "string",
"length": 0,
"width": 0,
"height": 0,
"weight": 0,
"price": 0,
"basePrice": 0,
"color": "string",
"size": "string",
"brand": "string",
"taxTypeCode": "string",
"gstTaxTypeCode": "string",
"hsnCode": "string",
"categoryName": "string",
"categoryCode": "string",
"productPageUrl": "string",
"imageUrl": "string",
"tags": [
],
"customFieldValues": [
{
"fieldName": "string",
"fieldValue": "string",
"valueType": "string",
"displayName": "string",
"required": false,
"possibleValues": [
"string"
]
}
],
"inventorySnapshots": "string",
"expirable": true,
"enabled": true,
"shelfLife": 0,
"skuType": "string",
"itemDetailFieldDTOList": [
],
}
]
}
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 | totalRecords | number | Total no. of records found | - |
6 | elements | list | Details of matches found | - |
6.1 | skuCode | string | SKU code of the item on the marketplace | - |
6.2 | name | string | Item name | - |
6.3 | description | string | Item decription | - |
6.4 | length | number | Length of the item (in mm) | - |
6.5 | width | number | Width of the item (in mm) | - |
6.6 | height | number | Height of the item (in mm) | - |
6.7 | weight | number | Weight of the item (in gm) | - |
6.8 | price | number | Price of the item | - |
6.9 | basePrice | number | Base price | - |
6.10 | color | string | Color description | - |
6.11 | size | string | Size | - |
6.12 | brand | string | Brand of the item | - |
6.13 | taxTypeCode | string | tax code for VAT (as defined in Uniware) | - |
6.14 | gstTaxTypeCode | string | GST tax code (as defined in Uniware) | - |
6.15 | hsnCode | string | 6 digit uniform code that classifies products worldwide | - |
6.16 | categoryName | string | Category name | - |
6.17 | categoryCode | string | Category code in Uniware, else pass ‘null’ | - |
6.18 | productPageUrl | string | Item page URL | - |
6.19 | imageUrl | string | Image URL of the variant | - |
6.20 | tags | list | Item tags for assisting search | - |
6.21 | customFieldValues | list | Custom field details | - |
6.21.1 | fieldName | string | Custom field name | - |
6.21.2 | fieldValue | string | Custom field value | - |
6.21.3 | valueType | string | Value type | - |
6.21.4 | displayName | string | Name to be displayed | - |
6.21.5 | required | boolean | true if required | - |
6.21.6 | possibleValues | list | Allowable values | - |
6.22 | inventorySnapshots | string | SKU Inventory details | - |
6.23 | expirable | boolean | True if expirable | - |
6.24 | enabled | boolean | True if enabled | - |
6.25 | shelfLife | number | Duration for which item remains in good condition while storing | - |
6.26 | skuType | string | SKU type | - |
6.27 | itemDetailFieldDTOList | list | - | - |
Error Codes
Refer Response Codes section to know about specific errors codes.