Get Item Details
This REST API is used to fetch item details from Uniware. The user needs to send the skuCode for which the details are required.
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/catalog/itemType/get |
| 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
{
"skuCode": "string"
}Request Payload Details
| PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|
| skuCode | string | SKU code of the item (as in Uniware) | Yes | Eg: BD_Floral_3 |
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"
}
],
"itemTypeDTO": {
"tat": 0,
"id": 0,
"skuCode": "string",
"categoryCode": "string",
"name": "string",
"description": "string",
"scanIdentifier": "string",
"length": 0,
"width": 0,
"height": 0,
"weight": 0,
"color": "string",
"size": "string",
"brand": "string",
"ean": "string",
"upc": "string",
"isbn": "string",
"maxRetailPrice": 0,
"basePrice": 0,
"costPrice": 0,
"taxTypeCode": "string",
"gstTaxTypeCode": "string",
"hsnCode": "string",
"imageUrl": "string",
"productPageUrl": "string",
"type": "SIMPLE",
"requiresCustomization": true,
"itemDetailFieldsText": "string",
"enabled": true,
"tags": [
"string"
],
"shelfLife": 0,
"expirable": true,
"customFieldValues": [
{
"fieldName": "string",
"fieldValue": {},
"valueType": "string",
"displayName": "string",
"required": true,
"possibleValues": [
"string"
]
}
],
"componentItemTypes": [
{
"itemTypeDTO": {
"skuCode": "string",
"name": "string",
"categoryName": "string",
"itemTypeImageUrl": "string",
"itemTypePageUrl": "string",
"openSale": 0,
"openPurchase": 0,
"inventory": 0,
"putawayPending": 0,
"inPicking": 0,
"pendingGRN": 0,
"enabled": true,
"quantityNotFound": 0,
"quantityDamaged": 0,
"badInventoryCount": 0,
"vendorItemTypes": [
{
"vendorEnabled": true,
"vendorCode": "string",
"vendorName": "string",
"vendorSkuCode": "string",
"vendorId": 0
}
]
},
"quantity": 0,
"price": 0,
"priceRatio": 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 | itemTypeDTO | object | Item type details | - |
| 5.1 | tat | number | Turn-around-time | - |
| 5.2 | id | integer | ID | - |
| 5.3 | skuCode | string | SKU code of the item on the marketplace | Eg: BD_Floral_3 |
| 5.4 | categoryCode | string | Category code in Uniware, else pass ‘null’ | - |
| 5.5 | name | string | Name | - |
| 5.6 | description | string | Description | - |
| 5.7 | scanIdentifier | string | Data to be matched during item scan | - |
| 5.8 | length | integer | Length (in mm) | - |
| 5.9 | width | integer | Width in mm | - |
| 5.10 | height | integer | Height (in mm) | - |
| 5.11 | weight | integer | Weight in gm | - |
| 5.12 | color | string | Color description | - |
| 5.13 | size | string | Size | - |
| 5.14 | brand | string | Brand of the item | Eg: Bombay Dyeing |
| 5.15 | ean | string | EAN no. | - |
| 5.16 | upc | string | UPC code | - |
| 5.17 | isbn | string | ISBN no. | - |
| 5.18 | maxRetailPrice | number | Max. retail price | - |
| 5.19 | basePrice | number | Base price | - |
| 5.20 | costPrice | number | Cost price | - |
| 5.21 | taxTypeCode | string | Tax type code | - |
| 5.22 | gstTaxTypeCode | string | GST tax code (as defined in Uniware) | - |
| 5.23 | hsnCode | string | 6 digit uniform code that classifies products worldwide | - |
| 5.24 | imageUrl | string | Image URL of the variant | - |
| 5.25 | productPageUrl | string | Item page URL | - |
| 5.26 | type | enum | Item type | Allowable: SIMPLE (Default), BUNDLE |
| 5.27 | requiresCustomization | boolean | true if customization required | - |
| 5.28 | itemDetailFieldsText | string | Details of item | - |
| 5.29 | enabled | boolean | true if enabled | - |
| 5.30 | tags | list | Item tags for assisting search | - |
| 5.31 | shelfLife | integer | Duration for which item remains in good condition while storing | - |
| 5.32 | expirable | boolean | true if expirable | - |
| 5.33 | customFieldValues | list | Custom field details | - |
| 5.33.1 | fieldName | string | Custom field name | - |
| 5.33.2 | fieldValue | object | Custom field value | - |
| 5.33.3 | valueType | string | Value type | - |
| 5.33.4 | displayName | string | Name to be displayed | - |
| 5.33.5 | required | boolean | true if required | - |
| 5.33.6 | possibleValues | list | Possible values for custom field | - |
| 5.34 | componentItemTypes | list | - | |
| 5.34.1 | itemTypeDTO | object | Item type details | - |
| 5.34.1.1 | skuCode | string | SKU code of the item on the marketplace | Eg: BD_Floral_3 |
| 5.34.1.2 | name | string | Name | - |
| 5.34.1.3 | categoryName | string | Category name | - |
| 5.34.1.4 | itemTypeImageUrl | string | Item type image URL | - |
| 5.34.1.5 | itemTypePageUrl | string | Item type page URL | - |
| 5.34.1.6 | openSale | integer | - | - |
| 5.34.1.7 | openPurchase | number | - | - |
| 5.34.1.8 | inventory | integer | Available quantity | - |
| 5.34.1.9 | putawayPending | integer | Quantity on put-away shelves | - |
| 5.34.1.10 | inPicking | number | - | - |
| 5.34.1.11 | pendingGRN | integer | - | - |
| 5.34.1.12 | enabled | boolean | true if enabled | - |
| 5.34.1.13 | quantityNotFound | integer | Qty not found | - |
| 5.34.1.14 | quantityDamaged | integer | Qty found damaged | - |
| 5.34.1.15 | badInventoryCount | number | Count of bad inventory | - |
| 5.34.1.16 | vendorItemTypes | list | - | - |
| 5.34.1.16.1 | vendorEnabled | boolean | true if vendor enabled | - |
| 5.34.1.16.2 | vendorCode | string | Vendor code | - |
| 5.34.1.16.3 | vendorName | string | Vendor name | - |
| 5.34.1.16.4 | vendorSkuCode | string | Vendor SKU code | |
| 5.34.1.16.5 | vendorId | integer | Vendor ID | - |
| 5.34.2 | quantity | integer | Quantity | - |
| 5.34.3 | price | number | Price | - |
| 5.34.4 | priceRatio | number | Price ratio | - |
Error Codes
Refer Response Codes section to know about specific errors codes.