Get Item Barcode Details

This REST API is used to fetch item (barcode) details from Uniware. The user needs to send the Itemcode 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/product/item/get
Request Type: POST
Level: Facility
Scheme: HTTPS
Header (Content-Type): application/json
Header (Authorization): bearer {access-token}, Eg.: bearer b30f3aea-7978-49bb-9ea7-33eddfc80afa

Request Payload

{
   "itemCode": "000002"
}

Request Payload Details

PARAMETER TYPE DESCRIPTION MANDATORY NOTES
itemCode string Barcode of the item (as in Uniware) Yes Eg: 000002

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 itemDTO object Item code details -
5.1 code string Item code -
5.2 status string item code status Eg: IN_TRANSITION
5.3 inventoryType enum Inventory type Eg: GOOD_INVENTORY, BAD_INVENTORY
5.4 inflowReceiptCode string GRN receipt code -
5.5 purchaseOrderCode string Purchase order code -
5.6 lastPutawayCode string last putaway code -
5.7 itemSKU string item SKU -
5.8 itemTypeName string Item type name -
5.9 itemTypeImageUrl string Item type image URL -
5.10 itemTypePageUrl string Item type page URL -
5.11 vendor string Vendor name -
5.12 vendorcode string Vendor code -
5.13 determineExpiryFrom string Expiry from expiry or MFG date Eg: MANUFACTURING_DATE
5.14 expirable boolean True if expirable -
5.15 shelfLife integer Duration for which item remains in good condition while storing -
5.16 unitPrice number Unit price -
5.17 maxRetailPrice number Max. retail price -
5.18 vendorSkuCode string Vendor SKU code -
5.19 color string Color description -
5.20 size string Size Format: LxBxH, Unit: mm, Eg: 60.00X40.00X2.00
5.21 brand string Brand of the item Eg: Bombay Dyeing
5.22 rejectionReason integer Rejection reason -
5.23 ageingStartDate integer Ageing start date -
5.24 created number Created date Eg: 1593590731000
5.25 saleOrderItemDTOs number sale order item details -
5.26 gatePassDTOs list Gatepass Details -
5.27 itemTypeCustomFieldValues list ItemType custom field details -
5.27.1 fieldName string Custom field name -
5.27.2 fieldValue object Custom field value -
5.27.3 valueType string Value type -
5.27.4 displayName string Name to be displayed -
5.27.5 required boolean True if required -
5.27.6 possibleValues list Possible values for custom field Eg: USD, EURO, INR, SGN
5.28 saleOrderCustomFieldValues list Sale order custom field values -
5.29 itemCustomFields list Item custom fields -
5.30 createdFacilityCode string Created facility code -
5.31 currentFacilityCode string Current facility code -
5.32 updated date Updation date Eg: 1593590731000
5.33 expiryDate string Date-time -
5.34 manufacturingDate string Date-time -
5.35 dispatchToleranceBreach integer Dispatch tolerance breach -
5.36 shelfCode string Shelf code -
5.37 inflowReceiptItemDTO list Inflow receipt item details -
5.38 purchaseOrderDTO list Purchase order details -
5.39 itemDetailFields list Item detail fields -

Error Codes

Refer Response Codes section to know about specific errors codes.

Unicommerce Website

Copyright © 2022 Unicommerce eSolutions Pvt. Ltd.