GET api/v1/Items/ItemCode/{itemCode}

Request Information

URI Parameters

Name	Description	Type	Additional information
itemCode		string	Required

Body Parameters

Response Information

Resource Description

Item

Name	Description	Type
Id		integer
ItemCode	ItemCode	string
AlternateItemCode		string
MfgItemCode		string
GTIN		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
HasSerialNumber		boolean
Volume		decimal number
VolumeUoM		string
Cost		decimal number
BarCodeNumber		string
ItemKits		Collection of ItemKit
Vendor		Vendor
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",
  "gtin": "sample string 5",
  "harmonizedCode": "sample string 6",
  "erpId": "sample string 7",
  "description": "sample string 8",
  "itemTypeId": "Unknown",
  "image": "QEA=",
  "itemStatusId": "Inactive",
  "itemUoM": "sample string 9",
  "upcCode": "sample string 10",
  "billingCode": "sample string 11",
  "weight": 13.0,
  "weightUoM": "sample string 14",
  "prop65": true,
  "dimLength": 16.0,
  "dimWidth": 17.0,
  "dimHeight": 18.0,
  "dimUoM": "sample string 19",
  "itemPrice": 20.0,
  "lotControlled": true,
  "hasSerialNumber": true,
  "volume": 1.0,
  "volumeUoM": "sample string 23",
  "cost": 24.0,
  "barCodeNumber": "sample string 25",
  "itemKits": [
    {
      "id": 1,
      "itemId": 2,
      "itemCode": "sample string 3",
      "componentItemId": 4,
      "componentItemCode": "sample string 5",
      "componentQuantity": 6.0,
      "componentGTIN": "sample string 7",
      "executionTime": 10,
      "txID": "sample string 11"
    },
    {
      "id": 1,
      "itemId": 2,
      "itemCode": "sample string 3",
      "componentItemId": 4,
      "componentItemCode": "sample string 5",
      "componentQuantity": 6.0,
      "componentGTIN": "sample string 7",
      "executionTime": 10,
      "txID": "sample string 11"
    }
  ],
  "vendor": {
    "name": "sample string 2"
  },
  "executionTime": 28,
  "txID": "sample string 29"
}

application/xml, text/xml

Sample:

<Item xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Models">
  <ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">28</ExecutionTime>
  <TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 29</TxID>
  <AlternateItemCode>sample string 3</AlternateItemCode>
  <BarCodeNumber>sample string 25</BarCodeNumber>
  <BillingCode>sample string 11</BillingCode>
  <Cost>24</Cost>
  <Description>sample string 8</Description>
  <DimHeight>18</DimHeight>
  <DimLength>16</DimLength>
  <DimUoM>sample string 19</DimUoM>
  <DimWidth>17</DimWidth>
  <ErpId>sample string 7</ErpId>
  <GTIN>sample string 5</GTIN>
  <HarmonizedCode>sample string 6</HarmonizedCode>
  <HasSerialNumber>true</HasSerialNumber>
  <Id>1</Id>
  <Image>QEA=</Image>
  <ItemCode>sample string 2</ItemCode>
  <ItemKits>
    <ItemKit z:Id="i2">
      <ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">10</ExecutionTime>
      <TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 11</TxID>
      <ComponentGTIN>sample string 7</ComponentGTIN>
      <ComponentItemCode>sample string 5</ComponentItemCode>
      <ComponentItemId>4</ComponentItemId>
      <ComponentQuantity>6</ComponentQuantity>
      <Id>1</Id>
      <ItemCode>sample string 3</ItemCode>
      <ItemId>2</ItemId>
    </ItemKit>
    <ItemKit z:Ref="i2" />
  </ItemKits>
  <ItemPrice>20</ItemPrice>
  <ItemStatusId>Inactive</ItemStatusId>
  <ItemTypeId>Unknown</ItemTypeId>
  <ItemUoM>sample string 9</ItemUoM>
  <LotControlled>true</LotControlled>
  <MfgItemCode>sample string 4</MfgItemCode>
  <Prop65>true</Prop65>
  <UPCCode>sample string 10</UPCCode>
  <Vendor>
    <Name>sample string 2</Name>
  </Vendor>
  <Volume>1</Volume>
  <VolumeUoM>sample string 23</VolumeUoM>
  <Weight>13</Weight>
  <WeightUoM>sample string 14</WeightUoM>
</Item>