GET api/v1/Items/ItemCode/{itemCode}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
itemCode | string |
Required |
Body Parameters
Response Information
Resource Description
ItemName | Description | Type | Additional information |
---|---|---|---|
Id | integer | ||
ItemCode |
ItemCode |
string | |
AlternateItemCode | string | ||
MfgItemCode | string | ||
HarmonizedCode | string | ||
ErpId | string | ||
Description | string | ||
ItemTypeId | TItemType | ||
Image | Collection of byte | ||
ItemStatusId | TItemStatus | ||
ItemUoM | string | ||
UPCCode | string | ||
BillingCode | string | ||
Weight | decimal number | ||
WeightUoM | string | ||
Prop65 | boolean | ||
DimLength | decimal number | ||
DimWidth | decimal number | ||
DimHeight | decimal number | ||
DimUoM | string | ||
ItemPrice | decimal number | ||
LotControlled | boolean | ||
Volume | decimal number | ||
VolumeUoM | string | ||
Cost | decimal number | ||
BarCodeNumber | string | ||
ItemKits | Collection of ItemKit | ||
Vendor | Vendor | ||
ModifiedDateTime |
Modified datetime for the object. This will be added by the system. |
date | |
ExecutionTime |
How long the method took in milliseconds. System supplied value. |
integer | |
TxID |
Transaction ID of the call. Will be added for the response. Not needed in the request. |
string |
Response Formats
application/json, text/json
Sample:
{ "id": 1, "itemCode": "sample string 2", "alternateItemCode": "sample string 3", "mfgItemCode": "sample string 4", "harmonizedCode": "sample string 5", "erpId": "sample string 6", "description": "sample string 7", "itemTypeId": "Unknown", "image": "QEA=", "itemStatusId": "Inactive", "itemUoM": "sample string 8", "upcCode": "sample string 9", "billingCode": "sample string 10", "weight": 12.0, "weightUoM": "sample string 13", "prop65": true, "dimLength": 15.0, "dimWidth": 16.0, "dimHeight": 17.0, "dimUoM": "sample string 18", "itemPrice": 19.0, "lotControlled": true, "volume": 1.0, "volumeUoM": "sample string 21", "cost": 22.0, "barCodeNumber": "sample string 23", "itemKits": [ { "id": 1, "itemId": 2, "itemCode": "sample string 3", "componentItemId": 4, "componentItemCode": "sample string 5", "componentQuantity": 6.0, "modifiedDateTime": "2025-08-14T01:25:08.2106584+00:00", "executionTime": 9, "txID": "sample string 10" }, { "id": 1, "itemId": 2, "itemCode": "sample string 3", "componentItemId": 4, "componentItemCode": "sample string 5", "componentQuantity": 6.0, "modifiedDateTime": "2025-08-14T01:25:08.2106584+00:00", "executionTime": 9, "txID": "sample string 10" } ], "vendor": { "name": "sample string 2" }, "modifiedDateTime": "2025-08-14T01:25:08.2106584+00:00", "executionTime": 26, "txID": "sample string 27" }
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.