IN Stock Item
URL | Verbs | Function | Available |
|---|---|---|---|
StockItem | GET | Query a list of StockItems | |
| StockItem | POST | Create a new StockItem | 2021.3 |
StockItem/<code> | GET | Query a single StockItem | |
| StockItem/<code> | POST | Update an existing StockItem |
Supported modifiers
Query String | Definition | Sample | Available |
|---|---|---|---|
| modifiedSince | Return Stock Items modified since a nominated date and time (Includes masterfile, quantity and selling price updates) | modifiedSince=2013-02-28T16:45:00 | |
| treeName and treeBranch | Return a list of Stock Items assigned to a nominated branch of a nominated tree | treeName=Colour-AUS&treeBranch=Blue | |
| primaryImage | Return the first attachment of type "Image" that is marked as Primary | action=primaryImage | |
| sellingPrice | Query the price of a stock item, taking advantage of the full Greentree advanced pricing configuration | action=sellingPrice *refer table below for details on querying a selling price | |
| includeBarcodes | Include the set of barcodes with each item | includeBarcodes=true | |
| includeSerialLots | Include the set of Serial Lots with each item | includeSerialLots=true | |
| isActive | Only include active stock items | isActive=true | |
| analysisCode | Query a list of Stock Items for a particular Analysis Code | analysisCode=INHOUSE | |
| analysisTreeName and analysisTreeBranch | Query a list of Stock Items for a particular Analysis Code Tree and Branch | analysisTreeName=Profile&analysisTreeBranch=Low | |
| oid | Query a Stock Item by its Oid | oid=2576.76 | |
| listOnly | Return just the code and description for each Stock Item | listOnly=true | |
| stockingLocation | Query a list of Stock Items for a particular Location | stockingLocation=01.03 | |
| includeItemTexts | Include the Item Text collection with each item | includeItemTexts=true | |
| includeAliases | Include the Item Alias collection with each item | includeAliases=true | |
| includeCompanionItems | Include the Companion Item collection with each item | includeCompanionItems=true | |
| includeSubstituteItems | Include the Substitute Item collection with each item | includeSubstituteItems=true | |
| includeComponentDefinitions | Include the Kitset Component collection with each item | includeComponentDefinitions=true | |
| stockItemModifiedSince | Return Stock Items where the masterfile Stockitem was modified since a nominated date and time (ignores the quantity updates) | stockItemModifiedSince=2013-02-28T16:45:00 | 2019.5 |
| qtyModifiedSince | Return Stock Items where the quantities of the stockitem were modified since a nominated date and time (ignores the masterfile updates) | qtyModifiedSince=2013-02-28T16:45:00 | 2019.5 |
| excludeUnitConversions | Do not Include the Unit Conversions with each item | excludeUnitConversions=true | 2020.1 |
| excludeSupplierDetails | Do not include the Supplier Details with each item | excludeSupplierDetails=true | 2020.1 |
| excludeStockLocations | Do not include the Stock Location with each item | excludeStockLocations=true | 2020.1 |
| excludePriceBooks | Do not include the Price Books with each item | excludePriceBooks=true | 2020.1 |
| sellingPriceModifiedSince | Return Stock Items where the Selling Price(s) were modified since a nominated date and time (ignores all other updates) | sellingPriceModifiedSince=true | 2021.3 |
Security Linked Menu
Menu Item | Located |
|---|---|
| Inventory Item Maintenance | Data Entry / Inventory |
Sample XML Response
<?xml version="1.0" encoding="UTF-8"?>
<StockItem>
<OidString>2576.227</OidString>
<Edition>225</Edition>
<Code>00AOPEN17MONITOR</Code>
<Description>AOpen 17" LCD Monitor</Description>
<InstantAlert/>
<ActivityCode>STOCK</ActivityCode>
<ModifiedTimeStamp>2014-09-02T15:39:55</ModifiedTimeStamp>
<Status>Active</Status>
<IsActive>true</IsActive>
<IsNonDiminishing>false</IsNonDiminishing>
<UnitWeight>0.0000</UnitWeight>
<UnitVolume>0.0000</UnitVolume>
<StockingDecimalPlaces>0</StockingDecimalPlaces>
<SellingUOM>EA</SellingUOM>
<StockingUOM>EA</StockingUOM>
<PurchasingUOM>EA</PurchasingUOM>
<AnalysisCode>MONITO</AnalysisCode>
<StockType>Not Serial/Lot Item</StockType>
<SerialLotFormat>Alphanumeric</SerialLotFormat>
<LengthOfSerialLotNo>20</LengthOfSerialLotNo>
<IsPromptSerialLotAtPO>false</IsPromptSerialLotAtPO>
<IsSerialLotNumberVariable>true</IsSerialLotNumberVariable>
<IsStockParent>false</IsStockParent>
<IsKeepWarranty>true</IsKeepWarranty>
<IsAllowOverSelling>true</IsAllowOverSelling>
<IsAllowNegativeOnHand>true</IsAllowNegativeOnHand>
<StockRanking>None</StockRanking>
<SalesAccountNo>*.*.*</SalesAccountNo>
<CostAccountNo>*.*.*</CostAccountNo>
<TransitAccountNo>*.*.*</TransitAccountNo>
<ProductionAccountNo>*.*.*</ProductionAccountNo>
<ProdVarianceAccountNo>*.*.*</ProdVarianceAccountNo>
<ImageURL>00AOPEN17MONITOR.png</ImageURL>
<LinkURL/>
<DoesWetTaxApply>false</DoesWetTaxApply>
<IsIndentItem>false</IsIndentItem>
<DefaultBOMNarration/>
<DutyCode>Electrical</DutyCode>
<TaxCode>GST 10%</TaxCode>
<StockTakeCycle>Monthly</StockTakeCycle>
<IsPrintReceivingLabels>false</IsPrintReceivingLabels>
<IsPrintRetailPricingLabels>false</IsPrintRetailPricingLabels>
<IsPrintSerialLotNumber>false</IsPrintSerialLotNumber>
<IsPrintReceivingBarcode>false</IsPrintReceivingBarcode>
<IsPrintOneLabelPerLine>false</IsPrintOneLabelPerLine>
<IsPrintBasedOnReceivingQty>false</IsPrintBasedOnReceivingQty>
<LabelsPerUnit>0</LabelsPerUnit>
<LabelPrintRetailOption>0</LabelPrintRetailOption>
<PrintLabelsBaseUnit/>
<Weight>0.0000</Weight>
<Volume>0.0000</Volume>
<AverageCostNet>563.4600</AverageCostNet>
<AverageCostDate>2011-06-30</AverageCostDate>
<QtyLastUpdatedTime>2014-08-29T12:03:47</QtyLastUpdatedTime>
<QuantityAvailable>119.0000</QuantityAvailable>
<QuantityCommitted>72.0000</QuantityCommitted>
<QuantityInProduction>0</QuantityInProduction>
<QuantityOnBackorder>4.0000</QuantityOnBackorder>
<QuantityOnForwardOrder>3.0000</QuantityOnForwardOrder>
<QuantityOnHand>193.0000</QuantityOnHand>
<QuantityOnPurchaseOrder>29.0000</QuantityOnPurchaseOrder>
<QuantityOnRequisition>50.0000</QuantityOnRequisition>
<QuantityOnShipment>0.0000</QuantityOnShipment>
<StockLocations collection='true' count='3'>
<StockLocation>
<Location>02</Location>
<LocationPath>02</LocationPath>
<IsActive>true</IsActive>
<IsPrimaryLocation>true</IsPrimaryLocation>
<AverageCostNet>563.4600</AverageCostNet>
<QuantityAvailable>96.0000</QuantityAvailable>
<QuantityCommitted>69.0000</QuantityCommitted>
<QuantityInProduction>0</QuantityInProduction>
<QuantityOnBackorder>1.0000</QuantityOnBackorder>
<QuantityOnForwardOrder>3.0000</QuantityOnForwardOrder>
<QuantityOnHand>165.0000</QuantityOnHand>
<QuantityOnPurchaseOrder>19.0000</QuantityOnPurchaseOrder>
<QuantityOnRequisition>0</QuantityOnRequisition>
<QuantityOnShipment>0.0000</QuantityOnShipment>
</StockLocation>
<StockLocation>
<Location>Z01</Location>
<LocationPath>03.Z01</LocationPath>
<IsActive>true</IsActive>
<IsPrimaryLocation>false</IsPrimaryLocation>
<AverageCostNet>563.4600</AverageCostNet>
<QuantityAvailable>10.0000</QuantityAvailable>
<QuantityCommitted>0</QuantityCommitted>
<QuantityInProduction>0</QuantityInProduction>
<QuantityOnBackorder>0.0000</QuantityOnBackorder>
<QuantityOnForwardOrder>0</QuantityOnForwardOrder>
<QuantityOnHand>10.0000</QuantityOnHand>
<QuantityOnPurchaseOrder>10.0000</QuantityOnPurchaseOrder>
<QuantityOnRequisition>50.0000</QuantityOnRequisition>
<QuantityOnShipment>0.0000</QuantityOnShipment>
</StockLocation>
<StockLocation>
<Location>Z02</Location>
<LocationPath>03.Z02</LocationPath>
<IsActive>true</IsActive>
<IsPrimaryLocation>false</IsPrimaryLocation>
<AverageCostNet>563.4600</AverageCostNet>
<QuantityAvailable>10.0000</QuantityAvailable>
<QuantityCommitted>0</QuantityCommitted>
<QuantityInProduction>0</QuantityInProduction>
<QuantityOnBackorder>0.0000</QuantityOnBackorder>
<QuantityOnForwardOrder>0</QuantityOnForwardOrder>
<QuantityOnHand>10.0000</QuantityOnHand>
<QuantityOnPurchaseOrder>0</QuantityOnPurchaseOrder>
<QuantityOnRequisition>0</QuantityOnRequisition>
<QuantityOnShipment>0.0000</QuantityOnShipment>
</StockLocation>
</StockLocations>
<SellingPrices collection='true' count='3'>
<SellingPrice>
<MarginPercent>8.33</MarginPercent>
<MarginValue>0</MarginValue>
<MarkupPercent>9.09</MarkupPercent>
<ReviewDate>2008-12-08</ReviewDate>
<LastUpdateDate/>
<IsActive>true</IsActive>
<Currency>AUD</Currency>
<Location/>
<TaxCode>GST 10%</TaxCode>
<UnitOfMeasure>EA</UnitOfMeasure>
<PriceLevel>RETAIL</PriceLevel>
<NetPrice>612.4700</NetPrice>
</SellingPrice>
<SellingPrice>
<MarginPercent>13.04</MarginPercent>
<MarginValue>0</MarginValue>
<MarkupPercent>15.00</MarkupPercent>
<ReviewDate>2011-05-10</ReviewDate>
<LastUpdateDate/>
<IsActive>true</IsActive>
<Currency>AUD</Currency>
<Location/>
<TaxCode>GST 10%</TaxCode>
<UnitOfMeasure>EA</UnitOfMeasure>
<PriceLevel>SPECIAL</PriceLevel>
<NetPrice>795.0000</NetPrice>
</SellingPrice>
<SellingPrice>
<MarginPercent>9.09</MarginPercent>
<MarginValue>0</MarginValue>
<MarkupPercent>10.00</MarkupPercent>
<ReviewDate>2011-05-10</ReviewDate>
<LastUpdateDate/>
<IsActive>true</IsActive>
<Currency>AUD</Currency>
<Location/>
<TaxCode>GST 10%</TaxCode>
<UnitOfMeasure>EA</UnitOfMeasure>
<PriceLevel>WHOLE</PriceLevel>
<NetPrice>665.0000</NetPrice>
</SellingPrice>
</SellingPrices>
<UnitConversions collection='true' count='1'>
<UnitConversion>
<OidString>3141.1</OidString>
<Edition>2</Edition>
<UnitOfMeasureTo>EA</UnitOfMeasureTo>
<UnitOfMeasureFrom>BOX</UnitOfMeasureFrom>
<Rate>10.000000000</Rate>
</UnitConversion>
</UnitConversions>
<SerialLots collection='true' count='4'>
<INSerialLot>
<Number>SDM10118</Number>
<Description/>
<Status>Active</Status>
<IsSuspense>false</IsSuspense>
</INSerialLot>
<INSerialLot>
<Number>SDM10119</Number>
<Description/>
<Status>Active</Status>
<IsSuspense>false</IsSuspense>
</INSerialLot>
<INSerialLot>
<Number>SDM10120</Number>
<Description/>
<Status>Active</Status>
<IsSuspense>false</IsSuspense>
</INSerialLot>
<INSerialLot>
<Number>SDM10121</Number>
<Description/>
<Status>Active</Status>
<IsSuspense>false</IsSuspense>
</INSerialLot>
</SerialLots>
<CompanionItems collection='true' count='1'>
<CompanionItem>
<OidString>3660.1</OidString>
<Edition>4</Edition>
<Code>ZELLOWS17SCRENFILTER</Code>
<DefaultQty>1.0000</DefaultQty>
<Narration>Comp1</Narration>
</CompanionItem>
</CompanionItems>
<SubstituteItems collection='true' count='8'>
<SubstituteItem>
<OidString>3658.8</OidString>
<Edition>2</Edition>
<Code>BENQ17G774LCD</Code>
<Narration/>
</SubstituteItem>
<SubstituteItem>
<OidString>3658.9</OidString>
<Edition>2</Edition>
<Code>BENQ17LCD</Code>
<Narration/>
</SubstituteItem>
<SubstituteItem>
<OidString>3658.10</OidString>
<Edition>2</Edition>
<Code>SONY15LCD</Code>
<Narration/>
</SubstituteItem>
<SubstituteItem>
<OidString>3658.11</OidString>
<Edition>2</Edition>
<Code>SONY17LCD</Code>
<Narration/>
</SubstituteItem>
<SubstituteItem>
<OidString>3658.12</OidString>
<Edition>2</Edition>
<Code>SONY19LCD</Code>
<Narration/>
</SubstituteItem>
</SubstituteItems>
<Aliases collection='true' count='3'>
<Alias>
<OidString>3155.3</OidString>
<Edition>4</Edition>
<Name>Monitor</Name>
<Narration>Notes1</Narration>
</Alias>
<Alias>
<OidString>3155.2</OidString>
<Edition>4</Edition>
<Name>Screen</Name>
<Narration>Notes2</Narration>
</Alias>
<Alias>
<OidString>3155.1</OidString>
<Edition>4</Edition>
<Name>TFT</Name>
<Narration>Notes3</Narration>
</Alias>
</Aliases>
<ComponentDefinitions collection='true' count='5'>
<ComponentDefinition>
<OidString>2839.27</OidString>
<Edition>1</Edition>
<ComponentType>INComponentStockDefn</ComponentType>
<Code>AOPEN19LCD</Code>
<Quantity>1.0000</Quantity>
<UnitCost>550.0000</UnitCost>
<IsMandatory>true</IsMandatory>
<IsAllowQuantityChange>false</IsAllowQuantityChange>
<IsAllowSubstitution>false</IsAllowSubstitution>
<UnitOfMeasure>EA</UnitOfMeasure>
</ComponentDefinition>
<ComponentDefinition>
<OidString>2839.28</OidString>
<Edition>1</Edition>
<ComponentType>INComponentStockDefn</ComponentType>
<Code>AOPENDVDCDROM48X</Code>
<Quantity>1.0000</Quantity>
<UnitCost>82.7100</UnitCost>
<IsMandatory>true</IsMandatory>
<IsAllowQuantityChange>false</IsAllowQuantityChange>
<IsAllowSubstitution>false</IsAllowSubstitution>
<UnitOfMeasure>EA</UnitOfMeasure>
</ComponentDefinition>
<ComponentDefinition>
<OidString>2839.29</OidString>
<Edition>1</Edition>
<ComponentType>INComponentStockDefn</ComponentType>
<Code>AOPENAW744LSCARD</Code>
<Quantity>1.0000</Quantity>
<UnitCost>270.0000</UnitCost>
<IsMandatory>true</IsMandatory>
<IsAllowQuantityChange>false</IsAllowQuantityChange>
<IsAllowSubstitution>false</IsAllowSubstitution>
<UnitOfMeasure>EA</UnitOfMeasure>
</ComponentDefinition>
<ComponentDefinition>
<OidString>2839.30</OidString>
<Edition>1</Edition>
<ComponentType>INComponentStockDefn</ComponentType>
<Code>ALTEC220WSPEAKERS</Code>
<Quantity>2.0000</Quantity>
<UnitCost>48.8700</UnitCost>
<IsMandatory>true</IsMandatory>
<IsAllowQuantityChange>false</IsAllowQuantityChange>
<IsAllowSubstitution>false</IsAllowSubstitution>
<UnitOfMeasure>EA</UnitOfMeasure>
</ComponentDefinition>
<ComponentDefinition>
<OidString>2839.31</OidString>
<Edition>1</Edition>
<ComponentType>INComponentStockDefn</ComponentType>
<Code>AOPENMOUSEWHEEL</Code>
<Quantity>1.0000</Quantity>
<UnitCost>15.7800</UnitCost>
<IsMandatory>true</IsMandatory>
<IsAllowQuantityChange>false</IsAllowQuantityChange>
<IsAllowSubstitution>false</IsAllowSubstitution>
<UnitOfMeasure>EA</UnitOfMeasure>
</ComponentDefinition>
</ComponentDefinitions>
<UserDefinedFields collection='true' count='5'>
<UserDefinedField>
<Name>01 - Image URL</Name>
<Type>String</Type>
<Value/>
</UserDefinedField>
<UserDefinedField>
<Name>02 - Link URL</Name>
<Type>String</Type>
<Value/>
</UserDefinedField>
<UserDefinedField>
<Name>Manager</Name>
<Type>String</Type>
<Value>Bob Hill</Value>
</UserDefinedField>
<UserDefinedField>
<Name>Start Date</Name>
<Type>String</Type>
<Value>02/01/2003</Value>
</UserDefinedField>
<UserDefinedField>
<Name>Type</Name>
<Type>String</Type>
<Value/>
</UserDefinedField>
</UserDefinedFields>
<Trees collection='true' count='5'>
<Tree>
<Name>Items by Manufacturer</Name>
<IsMandatory>false</IsMandatory>
<Value>Aopen</Value>
<Path>Aopen</Path>
</Tree>
<Tree>
<Name>Product Catalogue</Name>
<IsMandatory>false</IsMandatory>
<Value>TFT Screens</Value>
<Path>TFT Screens</Path>
</Tree>
<Tree>
<Name>StockItem-AUS</Name>
<IsMandatory>false</IsMandatory>
<Value>ALL-AUS</Value>
<Path>ALL-AUS</Path>
</Tree>
<Tree>
<Name>StockItemTree</Name>
<IsMandatory>false</IsMandatory>
<Value>All</Value>
<Path>All</Path>
</Tree>
<Tree>
<Name>Webstore Catalogue</Name>
<IsMandatory>false</IsMandatory>
<Value>TFT Screens</Value>
<Path>Catalogue\TFT Screens</Path>
</Tree>
</Trees>
<Attachments collection='true' count='2'>
<Attachment>
<Name>CRTMonitorAC90119UVGA.gif</Name>
<FileName>CRTMonitorAC90119UVGA.gif</FileName>
<FileSize>6608</FileSize>
<ModifiedTimeStamp>2007-07-08T15:37:06</ModifiedTimeStamp>
</Attachment>
<Attachment>
<Name>Quote</Name>
<FileName>Q20956.pdf</FileName>
<FileSize>6325</FileSize>
<ModifiedTimeStamp>2008-07-19T11:56:11</ModifiedTimeStamp>
</Attachment>
</Attachments>
</StockItem>
Modifiers for using the sellingPrice action
Query String | Definition | Sample | Available |
|---|---|---|---|
| customer | Customer to query a selling price for | customer=1000 | |
| priceLevel | Price Level to use for the price calculation. If not included will default to customer default price level, or the module default. To force an empty price level, you can pass a special priceLevel of "none" | priceLevel=RETAIL | "none" available 2019.3 |
| currency | Currency code. If not included will default to customer currency | currency=AUD | |
| date | Date to use for price calculation, used for date based pricing. If not included will default to todays date (server based) | date=2013-11-20 | |
| quantity | How many of the stock item, used for quantity break calculations. If not included will default to 1 | quantity=11 | |
| location | Location for price calculation | location=02 | |
| taxInclusive | Indicate whether price returned should be tax inclusive or exclusive. If not included will default to IN Control Pricing tax type | taxInclusive=false | |
| unitOfMeasure | Which unit of measure to calculate a price for. If not included will default to StockItem selling unit of measure | unitOfMeasure=EA | |
| addressNo | Delivery address number for the customer. | addressNo=1 | |
| taxRate | Tax rate to be used in the calculation. If not included will be calculated from the tax code | taxRate=10.00 | |
| taxCode | Tax code to be used. Will be used to | taxCode=GST | |
| currencyRate | Exchange rate to be used. If not included will default to 1.00 | currencyRate=0.88 | |
| transactionType | IN Transaction Type to be used. | transactionType=+ADJ | |
| isCurrencyMultiply | Indicate if the currencyRate should be multiplied or divided against the home currency | isCurrencyMultiply=true | |
| tracePriceSteps | Include a dump of the steps used to calculate the pricing to aid in debugging and determining how the price was calculated | tracePriceSteps=true | 2019.3 |
Sample XML Response
<?xml version="1.0" encoding="UTF-8"?>
<SellingPrice>
<Customer>1001</Customer>
<PriceLevel>SPECIAL</PriceLevel>
<TaxCode>GST 10%</TaxCode>
<IsTaxInclusive>false</IsTaxInclusive>
<StockItem>00AOPEN17MONITOR</StockItem>
<Quantity>1.0000</Quantity>
<TaxRate>10.00000000</TaxRate>
<DiscountPercentage>2.50</DiscountPercentage>
<Price>604.3100</Price>
<CurrencyRate>0.00000000</CurrencyRate>
<IsCurrencyMultiply>true</IsCurrencyMultiply>
<Currency>AUD</Currency>
<UnitOfMeasure>EA</UnitOfMeasure>
<PriceFound>true</PriceFound>
<PriceType>6</PriceType>
<IsAdvancedDiscountFound>true</IsAdvancedDiscountFound>
<Date>2019-06-12</Date>
<PriceSteps>
<PriceStep1>*** Item 00AOPEN17MONITOR: Start to find the standard price and discount ***</PriceStep1>
<PriceStep2>Found price from standard price line 2: unit price 795.0000, 0.00% discount;</PriceStep2>
<PriceStep3>*** Start to find the advanced price and discount ***</PriceStep3>
<PriceStep4>Found advanced price in Customer/Item specific pricing line 1: unit price 619.8060 and discount 2.50%</PriceStep4>
<PriceStep5>Compare the search results with the previous advanced pricing method...</PriceStep5>
<PriceStep6>Compare advanced search results up to Customer Code/Stock Item Code method: unit price 619.8060 comes with discount 2.50%; </PriceStep6>
<PriceStep7>*** Decision making: Advanced price found, and using best price across the standard and advanced prices ***</PriceStep7>
<PriceStep8>Use price and discount from single advanced pricing: unit price 619.8060, 2.50% discount;</PriceStep8>
<PriceStep9>Round the price to the right decimal places:: unit price 619.8060, 2.50% discount;</PriceStep9>
</PriceSteps>
</SellingPrice>