Item endpoints

oneGRID Cloud calls these adapter endpoints to fetch item master data from the external system. Route base: /Items. All responses use the response envelope; result enums serialize as numbers — the values are listed per endpoint.

GET /Items/{number}

Fetches the master data of one item by item number.

Request

GET /Items/100-4711

Response — 200

{
  "isResultSuccess": true,
  "result": 1,
  "validationStatus": null,
  "externalMessage": null,
  "data": {
    "number": "100-4711",
    "name": "Hex bolt M8",
    "description": "Galvanized, 40 mm",
    "languageIsoCode": "en",
    "minimumStockQuantity": 100,
    "weight": 0.012,
    "height": null,
    "width": null,
    "length": 0.04,
    "volume": null,
    "manufacturer": "Muster GmbH",
    "unitOfMeasure": 0,
    "externalIdentifier": "ERP-ITEM-4711"
  }
}

Response data: an Item object. Result values: 0 OperationFailed, 1 Succeed, 2 ItemDoesNotExist, 3 AdapterApiClientFailed, 4 AdapterApiCallFailed, 5 AdapterNotDefined.

POST /Items/File

Parses an uploaded item master-data file (JSON or CSV) into items. Used by the manual item import. File contents and column rules: File formats.

Request

{
  "fileContent": "TnVtYmVyLE5hbWUsRGVzY3JpcHRpb24…",
  "fileType": 1
}

Body property	Type	Required	Meaning
fileContent	string (Base64)	yes	The raw file bytes, Base64-encoded.
fileType	number	yes	0 = JSON, 1 = CSV.

Response data: array of Item objects parsed from the file. Result values: 0 OperationFailed, 1 Success, 2 InvalidInput, 3 FileNotSupported, 4 AdapterApiClientFailed, 5 AdapterApiCallFailed, 6 AdapterNotDefined.

GET /Items/IntegrateImage/{number}

Fetches the product image for an item, for storage in oneGRID Cloud. The envelope's data carries the image bytes as a Base64 string.

Response — 200

{
  "isResultSuccess": true,
  "result": 5,
  "validationStatus": null,
  "externalMessage": null,
  "data": "iVBORw0KGgoAAAANSUhEUgAA…"
}

Result values: 0 OperationFailed, 1 InvalidInput, 2 AdapterApiClientFailed, 3 AdapterNotDefined, 4 ImageDoesNotExist, 5 Success.

Item object

Property	Type	Required	Meaning
number	string	yes	Item number (business key).
name	string	no	Item name.
description	string	no	Item description.
languageIsoCode	string	no	Language of name and description.
minimumStockQuantity	number	no	Minimum stock level.
weight, height, width, length, volume	number	no	Physical dimensions.
manufacturer	string	no	Manufacturer name.
unitOfMeasure	number (enum)	no	Values as in the WorkOrder object; defaults to 0 (Piece).
externalIdentifier	string	no	External system's item ID.