GET api/item
Gets a List of all Items
Request Information
URI Parameters
None.
Body Parameters
None
Response Information
Resource Description
Item[]
Collection of ItemName | Type | Description | Additional information |
---|---|---|---|
VisibleId | integer |
Visible ID number that identifies the resource in the Visible system |
|
ItemCode | string |
Primary Item Code that the system uses for the item |
Required Max length: 50 |
MfgItemCode | string |
Manufacturer Item Code |
Max length: 50 |
AlternateItemCode | string |
Alternate Item code for any external system |
Max length: 50 |
InternalItemCode | string |
A Maersk Assigned Item Code. Used if necessary. |
Max length: 50 |
Name | string |
Name of the Item |
Max length: 80 |
Description | string |
Optional Description |
Max length: 100 |
WMSDescription | string |
Internal use. Information only |
Max length: 100 |
ItemType | string |
Item Type: Item, Kit, Box |
Max length: 20 |
ItemStatus | string |
Item status: Active, Inactive. Default is "Active" |
Max length: 20 |
ItemClassification | string |
Item Classification |
Max length: 20 |
Vendor | string |
Vendor |
Max length: 20 |
Weight | decimal number |
Weight of the item |
|
WeightUoM | string |
Unit of measure for the weight. LB - Pounds KG - Kilograms |
Max length: 10 |
Height | decimal number |
Height as decimal number |
|
Width | decimal number |
Width as decimal number |
|
Length | decimal number |
Length as decimal number |
|
ItemPricings | Collection of ItemPricing |
Pricing |
|
Prop65 | boolean |
Declaration for Prop65 in California. |
|
UnitOfMeasure | string |
Unit of Measure for the item. ea - Each, mc - Master Case. Default is "ea" |
Max length: 10 |
Cost | decimal number |
Cost as decimal number |
|
DiscontinueDate | date |
Discontinue Date |
|
UnitsInCase | decimal number |
Units per case |
|
Hazardous | string |
Optional hazardous code |
Max length: 10 |
HazardTemp | string |
Hazard Temperature where the item becomes dangerous |
Max length: 50 |
TempUoM | string |
Unit of Measure for Temperature. F - Fahrenheit C - Celsius |
Max length: 1 |
Food | boolean |
Is Food |
|
Refrigerated | boolean |
Refrigeration Required |
|
MeltTemp | string |
Melting temperature |
Max length: 10 |
WillMelt | boolean |
Will Melt |
|
WillFreeze | boolean |
Will Freeze |
|
FreezeTemp | string |
FreezeTemp |
Max length: 10 |
ItemDimensionUnit | string |
Item Dimension unit of measure. in - inches, cm - centimeters. Default is "in" |
Max length: 10 |
Volume | decimal number |
Volume |
|
VolumeUom | string |
Volume Unit of measure. in - inches, cm - centimeters. Default is "in" |
Max length: 20 |
CountryOfOrigin | string |
Country of Origin iso 2 digit |
Max length: 2 |
SpecialShippingCode | string |
Special Shipping Code |
Max length: 50 |
IsBarCoded | boolean |
Item has a barcode |
Required |
HasSerialNumbers | boolean |
Indicator if the item has serial numbers |
|
BarCodeNumber | string |
Characters representing the barcode on the item |
Max length: 50 |
CurrencyCode | string |
Currency |
Max length: 10 |
UnHazardCode | string |
UN hazard code |
Max length: 20 |
IsLotControlled | boolean |
Is Lot Controlled |
|
ExpirationDays | integer |
Days until item expires |
|
ExternalERPLocation | string |
External ERP Location |
Max length: 10 |
HarmonizedCodes | Collection of ItemHarmonizedCode |
List of Harmonized codes by country |
|
KitItems | Collection of ItemKit |
Items in the kit if the item type is shown as a kit |
|
AlternateCountryDescription | string |
Alternate country description |
Max length: 100 |
Color | string |
Color of item |
Max length: 100 |
Size | string |
Item size |
Max length: 100 |
ProductQuantity | string |
Product quantity information such as "100pcs/box" |
Max length: 100 |
Model | string |
Model information |
Max length: 100 |
CategoryName1 | string |
Category Name 1 |
Max length: 100 |
CategoryName2 | string |
Category Name 2 |
Max length: 100 |
CategoryName3 | string |
Category Name 3 |
Max length: 100 |
CategoryName4 | string |
Category Name 4 |
Max length: 100 |
CategoryName5 | string |
Category Name 5 |
Max length: 100 |
IsSensitiveType | boolean |
Flag to indicate if the item is considered a sensitive type |
|
OuterPackageShape | string |
Outer package shape information |
Max length: 100 |
OuterPackageType | string |
Outer package type information |
Max length: 100 |
ItemProperties | Collection of ItemProperty |
|
|
ItemSensitiveTypes | Collection of ItemSensitiveType |
|
|
ItemExtensions | Collection of ItemExtension |
|
|
PerformanceInMS | integer |
|
|
ClientName | string |
|
Response Formats
application/json, text/json
[ { "VisibleId": 1, "ItemCode": "sample string 2", "MfgItemCode": "sample string 3", "AlternateItemCode": "sample string 4", "InternalItemCode": "sample string 5", "Name": "sample string 6", "Description": "sample string 7", "WMSDescription": "sample string 8", "ItemType": "sample string 9", "ItemStatus": "sample string 10", "ItemClassification": "sample string 11", "Vendor": "sample string 12", "Weight": 13.0, "WeightUoM": "sample string 14", "Height": 15.0, "Width": 16.0, "Length": 17.0, "ItemPricings": [ { "Id": 1, "ItemId": 2, "CountryCode": "sample string 3", "CurrencyCode": "sample string 4", "Price": 5.0, "PerformanceInMS": 6, "ClientName": "sample string 7" }, { "Id": 1, "ItemId": 2, "CountryCode": "sample string 3", "CurrencyCode": "sample string 4", "Price": 5.0, "PerformanceInMS": 6, "ClientName": "sample string 7" } ], "Prop65": true, "UnitOfMeasure": "sample string 19", "Cost": 20.0, "DiscontinueDate": "2025-08-29T18:58:13.1063629+00:00", "UnitsInCase": 22.0, "Hazardous": "sample string 23", "HazardTemp": "sample string 24", "TempUoM": "sample string 25", "Food": true, "Refrigerated": true, "MeltTemp": "sample string 28", "WillMelt": true, "WillFreeze": true, "FreezeTemp": "sample string 31", "ItemDimensionUnit": "sample string 32", "Volume": 33.0, "VolumeUom": "sample string 34", "CountryOfOrigin": "sample string 35", "SpecialShippingCode": "sample string 36", "IsBarCoded": true, "HasSerialNumbers": true, "BarCodeNumber": "sample string 39", "CurrencyCode": "sample string 40", "UnHazardCode": "sample string 41", "IsLotControlled": true, "ExpirationDays": 43, "ExternalERPLocation": "sample string 44", "HarmonizedCodes": [ { "ItemCode": "sample string 3", "CountryCode": "sample string 4", "HarmonizedCode": "sample string 5", "CustomsValue": 6.0, "CustomsDescription": "sample string 7" }, { "ItemCode": "sample string 3", "CountryCode": "sample string 4", "HarmonizedCode": "sample string 5", "CustomsValue": 6.0, "CustomsDescription": "sample string 7" } ], "KitItems": [ { "Id": 1, "ItemId": 2, "ItemCode": "sample string 3", "ComponentItemId": 4, "ComponentItemCode": "sample string 5", "Quantity": 6 }, { "Id": 1, "ItemId": 2, "ItemCode": "sample string 3", "ComponentItemId": 4, "ComponentItemCode": "sample string 5", "Quantity": 6 } ], "AlternateCountryDescription": "sample string 45", "Color": "sample string 46", "Size": "sample string 47", "ProductQuantity": "sample string 48", "Model": "sample string 49", "CategoryName1": "sample string 50", "CategoryName2": "sample string 51", "CategoryName3": "sample string 52", "CategoryName4": "sample string 53", "CategoryName5": "sample string 54", "IsSensitiveType": true, "OuterPackageShape": "sample string 56", "OuterPackageType": "sample string 57", "ItemProperties": [ { "Name": "sample string 3", "Value": "sample string 4", "Unit": "sample string 5" }, { "Name": "sample string 3", "Value": "sample string 4", "Unit": "sample string 5" } ], "ItemSensitiveTypes": [ { "Value": "sample string 3" }, { "Value": "sample string 3" } ], "ItemExtensions": [ { "ItemCode": "sample string 3", "Weight": 4.1, "WeightUoM": "sample string 5", "BarCode": "sample string 6", "BarCodeType": "sample string 7", "LotCapture": true, "SerialCapture": true }, { "ItemCode": "sample string 3", "Weight": 4.1, "WeightUoM": "sample string 5", "BarCode": "sample string 6", "BarCodeType": "sample string 7", "LotCapture": true, "SerialCapture": true } ], "PerformanceInMS": 58, "ClientName": "sample string 59" }, { "VisibleId": 1, "ItemCode": "sample string 2", "MfgItemCode": "sample string 3", "AlternateItemCode": "sample string 4", "InternalItemCode": "sample string 5", "Name": "sample string 6", "Description": "sample string 7", "WMSDescription": "sample string 8", "ItemType": "sample string 9", "ItemStatus": "sample string 10", "ItemClassification": "sample string 11", "Vendor": "sample string 12", "Weight": 13.0, "WeightUoM": "sample string 14", "Height": 15.0, "Width": 16.0, "Length": 17.0, "ItemPricings": [ { "Id": 1, "ItemId": 2, "CountryCode": "sample string 3", "CurrencyCode": "sample string 4", "Price": 5.0, "PerformanceInMS": 6, "ClientName": "sample string 7" }, { "Id": 1, "ItemId": 2, "CountryCode": "sample string 3", "CurrencyCode": "sample string 4", "Price": 5.0, "PerformanceInMS": 6, "ClientName": "sample string 7" } ], "Prop65": true, "UnitOfMeasure": "sample string 19", "Cost": 20.0, "DiscontinueDate": "2025-08-29T18:58:13.1063629+00:00", "UnitsInCase": 22.0, "Hazardous": "sample string 23", "HazardTemp": "sample string 24", "TempUoM": "sample string 25", "Food": true, "Refrigerated": true, "MeltTemp": "sample string 28", "WillMelt": true, "WillFreeze": true, "FreezeTemp": "sample string 31", "ItemDimensionUnit": "sample string 32", "Volume": 33.0, "VolumeUom": "sample string 34", "CountryOfOrigin": "sample string 35", "SpecialShippingCode": "sample string 36", "IsBarCoded": true, "HasSerialNumbers": true, "BarCodeNumber": "sample string 39", "CurrencyCode": "sample string 40", "UnHazardCode": "sample string 41", "IsLotControlled": true, "ExpirationDays": 43, "ExternalERPLocation": "sample string 44", "HarmonizedCodes": [ { "ItemCode": "sample string 3", "CountryCode": "sample string 4", "HarmonizedCode": "sample string 5", "CustomsValue": 6.0, "CustomsDescription": "sample string 7" }, { "ItemCode": "sample string 3", "CountryCode": "sample string 4", "HarmonizedCode": "sample string 5", "CustomsValue": 6.0, "CustomsDescription": "sample string 7" } ], "KitItems": [ { "Id": 1, "ItemId": 2, "ItemCode": "sample string 3", "ComponentItemId": 4, "ComponentItemCode": "sample string 5", "Quantity": 6 }, { "Id": 1, "ItemId": 2, "ItemCode": "sample string 3", "ComponentItemId": 4, "ComponentItemCode": "sample string 5", "Quantity": 6 } ], "AlternateCountryDescription": "sample string 45", "Color": "sample string 46", "Size": "sample string 47", "ProductQuantity": "sample string 48", "Model": "sample string 49", "CategoryName1": "sample string 50", "CategoryName2": "sample string 51", "CategoryName3": "sample string 52", "CategoryName4": "sample string 53", "CategoryName5": "sample string 54", "IsSensitiveType": true, "OuterPackageShape": "sample string 56", "OuterPackageType": "sample string 57", "ItemProperties": [ { "Name": "sample string 3", "Value": "sample string 4", "Unit": "sample string 5" }, { "Name": "sample string 3", "Value": "sample string 4", "Unit": "sample string 5" } ], "ItemSensitiveTypes": [ { "Value": "sample string 3" }, { "Value": "sample string 3" } ], "ItemExtensions": [ { "ItemCode": "sample string 3", "Weight": 4.1, "WeightUoM": "sample string 5", "BarCode": "sample string 6", "BarCodeType": "sample string 7", "LotCapture": true, "SerialCapture": true }, { "ItemCode": "sample string 3", "Weight": 4.1, "WeightUoM": "sample string 5", "BarCode": "sample string 6", "BarCodeType": "sample string 7", "LotCapture": true, "SerialCapture": true } ], "PerformanceInMS": 58, "ClientName": "sample string 59" } ]
application/xml, text/xml
<ArrayOfItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Item> <PerformanceInMS>58</PerformanceInMS> <ClientName>sample string 59</ClientName> <VisibleId>1</VisibleId> <ItemCode>sample string 2</ItemCode> <MfgItemCode>sample string 3</MfgItemCode> <AlternateItemCode>sample string 4</AlternateItemCode> <InternalItemCode>sample string 5</InternalItemCode> <Name>sample string 6</Name> <Description>sample string 7</Description> <WMSDescription>sample string 8</WMSDescription> <ItemType>sample string 9</ItemType> <ItemStatus>sample string 10</ItemStatus> <ItemClassification>sample string 11</ItemClassification> <Vendor>sample string 12</Vendor> <Weight>13</Weight> <WeightUoM>sample string 14</WeightUoM> <Height>15</Height> <Width>16</Width> <Length>17</Length> <ItemPricings> <ItemPricing> <PerformanceInMS>6</PerformanceInMS> <ClientName>sample string 7</ClientName> <Id>1</Id> <ItemId>2</ItemId> <CountryCode>sample string 3</CountryCode> <CurrencyCode>sample string 4</CurrencyCode> <Price>5</Price> </ItemPricing> <ItemPricing> <PerformanceInMS>6</PerformanceInMS> <ClientName>sample string 7</ClientName> <Id>1</Id> <ItemId>2</ItemId> <CountryCode>sample string 3</CountryCode> <CurrencyCode>sample string 4</CurrencyCode> <Price>5</Price> </ItemPricing> </ItemPricings> <Prop65>true</Prop65> <UnitOfMeasure>sample string 19</UnitOfMeasure> <Cost>20</Cost> <DiscontinueDate>2025-08-29T18:58:13.1063629+00:00</DiscontinueDate> <UnitsInCase>22</UnitsInCase> <Hazardous>sample string 23</Hazardous> <HazardTemp>sample string 24</HazardTemp> <TempUoM>sample string 25</TempUoM> <Food>true</Food> <Refrigerated>true</Refrigerated> <MeltTemp>sample string 28</MeltTemp> <WillMelt>true</WillMelt> <WillFreeze>true</WillFreeze> <FreezeTemp>sample string 31</FreezeTemp> <ItemDimensionUnit>sample string 32</ItemDimensionUnit> <Volume>33</Volume> <VolumeUom>sample string 34</VolumeUom> <CountryOfOrigin>sample string 35</CountryOfOrigin> <SpecialShippingCode>sample string 36</SpecialShippingCode> <IsBarCoded>true</IsBarCoded> <HasSerialNumbers>true</HasSerialNumbers> <BarCodeNumber>sample string 39</BarCodeNumber> <CurrencyCode>sample string 40</CurrencyCode> <UnHazardCode>sample string 41</UnHazardCode> <IsLotControlled>true</IsLotControlled> <ExpirationDays>43</ExpirationDays> <ExternalERPLocation>sample string 44</ExternalERPLocation> <HarmonizedCodes> <ItemHarmonizedCode> <ItemCode>sample string 3</ItemCode> <CountryCode>sample string 4</CountryCode> <HarmonizedCode>sample string 5</HarmonizedCode> <CustomsValue>6</CustomsValue> <CustomsDescription>sample string 7</CustomsDescription> </ItemHarmonizedCode> <ItemHarmonizedCode> <ItemCode>sample string 3</ItemCode> <CountryCode>sample string 4</CountryCode> <HarmonizedCode>sample string 5</HarmonizedCode> <CustomsValue>6</CustomsValue> <CustomsDescription>sample string 7</CustomsDescription> </ItemHarmonizedCode> </HarmonizedCodes> <KitItems> <ItemKit> <ItemCode>sample string 3</ItemCode> <ComponentItemCode>sample string 5</ComponentItemCode> <Quantity>6</Quantity> </ItemKit> <ItemKit> <ItemCode>sample string 3</ItemCode> <ComponentItemCode>sample string 5</ComponentItemCode> <Quantity>6</Quantity> </ItemKit> </KitItems> <AlternateCountryDescription>sample string 45</AlternateCountryDescription> <Color>sample string 46</Color> <Size>sample string 47</Size> <ProductQuantity>sample string 48</ProductQuantity> <Model>sample string 49</Model> <CategoryName1>sample string 50</CategoryName1> <CategoryName2>sample string 51</CategoryName2> <CategoryName3>sample string 52</CategoryName3> <CategoryName4>sample string 53</CategoryName4> <CategoryName5>sample string 54</CategoryName5> <IsSensitiveType>true</IsSensitiveType> <OuterPackageShape>sample string 56</OuterPackageShape> <OuterPackageType>sample string 57</OuterPackageType> <ItemProperties> <ItemProperty> <Name>sample string 3</Name> <Value>sample string 4</Value> <Unit>sample string 5</Unit> </ItemProperty> <ItemProperty> <Name>sample string 3</Name> <Value>sample string 4</Value> <Unit>sample string 5</Unit> </ItemProperty> </ItemProperties> <ItemSensitiveTypes> <ItemSensitiveType> <Value>sample string 3</Value> </ItemSensitiveType> <ItemSensitiveType> <Value>sample string 3</Value> </ItemSensitiveType> </ItemSensitiveTypes> <ItemExtensions> <ItemExtension> <ItemCode>sample string 3</ItemCode> <Weight>4.1</Weight> <WeightUoM>sample string 5</WeightUoM> <BarCode>sample string 6</BarCode> <BarCodeType>sample string 7</BarCodeType> <LotCapture>true</LotCapture> <SerialCapture>true</SerialCapture> </ItemExtension> <ItemExtension> <ItemCode>sample string 3</ItemCode> <Weight>4.1</Weight> <WeightUoM>sample string 5</WeightUoM> <BarCode>sample string 6</BarCode> <BarCodeType>sample string 7</BarCodeType> <LotCapture>true</LotCapture> <SerialCapture>true</SerialCapture> </ItemExtension> </ItemExtensions> </Item> <Item> <PerformanceInMS>58</PerformanceInMS> <ClientName>sample string 59</ClientName> <VisibleId>1</VisibleId> <ItemCode>sample string 2</ItemCode> <MfgItemCode>sample string 3</MfgItemCode> <AlternateItemCode>sample string 4</AlternateItemCode> <InternalItemCode>sample string 5</InternalItemCode> <Name>sample string 6</Name> <Description>sample string 7</Description> <WMSDescription>sample string 8</WMSDescription> <ItemType>sample string 9</ItemType> <ItemStatus>sample string 10</ItemStatus> <ItemClassification>sample string 11</ItemClassification> <Vendor>sample string 12</Vendor> <Weight>13</Weight> <WeightUoM>sample string 14</WeightUoM> <Height>15</Height> <Width>16</Width> <Length>17</Length> <ItemPricings> <ItemPricing> <PerformanceInMS>6</PerformanceInMS> <ClientName>sample string 7</ClientName> <Id>1</Id> <ItemId>2</ItemId> <CountryCode>sample string 3</CountryCode> <CurrencyCode>sample string 4</CurrencyCode> <Price>5</Price> </ItemPricing> <ItemPricing> <PerformanceInMS>6</PerformanceInMS> <ClientName>sample string 7</ClientName> <Id>1</Id> <ItemId>2</ItemId> <CountryCode>sample string 3</CountryCode> <CurrencyCode>sample string 4</CurrencyCode> <Price>5</Price> </ItemPricing> </ItemPricings> <Prop65>true</Prop65> <UnitOfMeasure>sample string 19</UnitOfMeasure> <Cost>20</Cost> <DiscontinueDate>2025-08-29T18:58:13.1063629+00:00</DiscontinueDate> <UnitsInCase>22</UnitsInCase> <Hazardous>sample string 23</Hazardous> <HazardTemp>sample string 24</HazardTemp> <TempUoM>sample string 25</TempUoM> <Food>true</Food> <Refrigerated>true</Refrigerated> <MeltTemp>sample string 28</MeltTemp> <WillMelt>true</WillMelt> <WillFreeze>true</WillFreeze> <FreezeTemp>sample string 31</FreezeTemp> <ItemDimensionUnit>sample string 32</ItemDimensionUnit> <Volume>33</Volume> <VolumeUom>sample string 34</VolumeUom> <CountryOfOrigin>sample string 35</CountryOfOrigin> <SpecialShippingCode>sample string 36</SpecialShippingCode> <IsBarCoded>true</IsBarCoded> <HasSerialNumbers>true</HasSerialNumbers> <BarCodeNumber>sample string 39</BarCodeNumber> <CurrencyCode>sample string 40</CurrencyCode> <UnHazardCode>sample string 41</UnHazardCode> <IsLotControlled>true</IsLotControlled> <ExpirationDays>43</ExpirationDays> <ExternalERPLocation>sample string 44</ExternalERPLocation> <HarmonizedCodes> <ItemHarmonizedCode> <ItemCode>sample string 3</ItemCode> <CountryCode>sample string 4</CountryCode> <HarmonizedCode>sample string 5</HarmonizedCode> <CustomsValue>6</CustomsValue> <CustomsDescription>sample string 7</CustomsDescription> </ItemHarmonizedCode> <ItemHarmonizedCode> <ItemCode>sample string 3</ItemCode> <CountryCode>sample string 4</CountryCode> <HarmonizedCode>sample string 5</HarmonizedCode> <CustomsValue>6</CustomsValue> <CustomsDescription>sample string 7</CustomsDescription> </ItemHarmonizedCode> </HarmonizedCodes> <KitItems> <ItemKit> <ItemCode>sample string 3</ItemCode> <ComponentItemCode>sample string 5</ComponentItemCode> <Quantity>6</Quantity> </ItemKit> <ItemKit> <ItemCode>sample string 3</ItemCode> <ComponentItemCode>sample string 5</ComponentItemCode> <Quantity>6</Quantity> </ItemKit> </KitItems> <AlternateCountryDescription>sample string 45</AlternateCountryDescription> <Color>sample string 46</Color> <Size>sample string 47</Size> <ProductQuantity>sample string 48</ProductQuantity> <Model>sample string 49</Model> <CategoryName1>sample string 50</CategoryName1> <CategoryName2>sample string 51</CategoryName2> <CategoryName3>sample string 52</CategoryName3> <CategoryName4>sample string 53</CategoryName4> <CategoryName5>sample string 54</CategoryName5> <IsSensitiveType>true</IsSensitiveType> <OuterPackageShape>sample string 56</OuterPackageShape> <OuterPackageType>sample string 57</OuterPackageType> <ItemProperties> <ItemProperty> <Name>sample string 3</Name> <Value>sample string 4</Value> <Unit>sample string 5</Unit> </ItemProperty> <ItemProperty> <Name>sample string 3</Name> <Value>sample string 4</Value> <Unit>sample string 5</Unit> </ItemProperty> </ItemProperties> <ItemSensitiveTypes> <ItemSensitiveType> <Value>sample string 3</Value> </ItemSensitiveType> <ItemSensitiveType> <Value>sample string 3</Value> </ItemSensitiveType> </ItemSensitiveTypes> <ItemExtensions> <ItemExtension> <ItemCode>sample string 3</ItemCode> <Weight>4.1</Weight> <WeightUoM>sample string 5</WeightUoM> <BarCode>sample string 6</BarCode> <BarCodeType>sample string 7</BarCodeType> <LotCapture>true</LotCapture> <SerialCapture>true</SerialCapture> </ItemExtension> <ItemExtension> <ItemCode>sample string 3</ItemCode> <Weight>4.1</Weight> <WeightUoM>sample string 5</WeightUoM> <BarCode>sample string 6</BarCode> <BarCodeType>sample string 7</BarCodeType> <LotCapture>true</LotCapture> <SerialCapture>true</SerialCapture> </ItemExtension> </ItemExtensions> </Item> </ArrayOfItem>