GetInventoryPerWarehouse
It is possible for a goods owner to keep goods in several different warehouses. This function returns detailed information about the available number of items in each warehouse.
The function GetInventoryByQuery returns similar information, the difference being that GetInventoryByQuery returns the total available number of items for all warehouses..
See also our article Stock balances and inventory for more information on how to interpret the stock balance numbers returned by this function.
Note that if you try to fetch too many articles at once, this function may time out. We strongly recommend paginating the responses to avoid timeouts.
Request XML
POST /xxx/Service.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/WSI/GetInventoryPerWarehouse"
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetInventoryPerWarehouse xmlns="http://ongoingsystems.se/WSI">
<GoodsOwnerCode>string</GoodsOwnerCode>
<UserName>string</UserName>
<Password>string</Password>
<InventoryPerWarehouseQuery>
<ArticleNumbersToGet>
<string>string</string>
<string>string</string>
</ArticleNumbersToGet>
<ArticleGroupCodesToGet>
<string>string</string>
<string>string</string>
</ArticleGroupCodesToGet>
<MaxArticlesToGet>int</MaxArticlesToGet>
<ArticleSystemIdFrom>int</ArticleSystemIdFrom>
<ProductCodesToGet>
<string>string</string>
<string>string</string>
</ProductCodesToGet>
<GetInventoryForWarehouseIds>
<int>int</int>
<int>int</int>
</GetInventoryForWarehouseIds>
<StockInfoChangedFrom>dateTime</StockInfoChangedFrom>
<SpecialFilters>
<OnlyArticlesInStock>boolean</OnlyArticlesInStock>
</SpecialFilters>
</InventoryPerWarehouseQuery>
</GetInventoryPerWarehouse>
</soap:Body>
</soap:Envelope>
Request specification
GetInventoryPerWarehouse | |||
---|---|---|---|
GoodsOwnerCode | string(400) | Req. | The name/code of your client |
UserName | string(50) | Req. | Your username |
Password | string(50) | Req. | Your password |
InventoryPerWarehouseQuery | GetInventoryPerWarehouseQuery | Req. |
GetInventoryPerWarehouseQuery | |||
---|---|---|---|
ArticleNumbersToGet | string[] | Containing elements of string, defining which article numbers to get | |
ArticleGroupCodesToGet | string[] | Containing elements of string, defining which article group codes to get | |
MaxArticlesToGet | int | Max number of articles to return in response | |
ArticleSystemIdFrom | int | If specified, the API will only respond with articles whose system Ids are greater than or equal to (>=) the specified id. In conjunction with MaxArticlesToGet this allows you to request articles in batches of e.g. 100, rather than having to request all articles at once. | |
ProductCodesToGet | string[] | Containing elements of string, defining which product codes to get | |
GetInventoryForWarehouseIds | int[] | Contains a list of warehouse IDs. If specified, the call will only return the inventory values for the specified warehouse IDs. | |
StockInfoChangedFrom | dateTime | Only return articles whose stock balances have changed after this time. | |
SpecialFilters | GetInventoryPerWarehouseByQuerySpecialFilters | Contains special filters. |
GetInventoryPerWarehouseByQuerySpecialFilters | |||
---|---|---|---|
OnlyArticlesInStock | boolean | If True, then the response will only contain articles which are in stock in at least one warehouse. |
Response XML
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetInventoryPerWarehouseResponse xmlns="http://ongoingsystems.se/WSI">
<GetInventoryPerWarehouseResult>
<Success>boolean</Success>
<PerWarehouseArticleLines>
<PerWarehouseArticleLine>
<Article>
<SystemId>int</SystemId>
<Name>string</Name>
<ArticleNumber>string</ArticleNumber>
<ProductCode>string</ProductCode>
<BarCode>string</BarCode>
<Description>string</Description>
<SupplierArticleNumber>string</SupplierArticleNumber>
<StatisticsNumber>string</StatisticsNumber>
<ArticleGroupName>string</ArticleGroupName>
<ArticleGroupCode>string</ArticleGroupCode>
<MainSupplierName>string</MainSupplierName>
<MainSupplierNumber>string</MainSupplierNumber>
<ArticleCategoryName>string</ArticleCategoryName>
<ArticleCategoryCode>string</ArticleCategoryCode>
<CountryOfOriginCode>string</CountryOfOriginCode>
<IsStockArticle>boolean</IsStockArticle>
<ArticleUnitCode>string</ArticleUnitCode>
<VatCode>string</VatCode>
<VatPercent>decimal</VatPercent>
<Length>decimal</Length>
<Width>decimal</Width>
<Height>decimal</Height>
<Price>decimal</Price>
<CustomerPrice>decimal</CustomerPrice>
<PurchasePrice>decimal</PurchasePrice>
<Weight>decimal</Weight>
<NetWeight>decimal</NetWeight>
<Volume>decimal</Volume>
<QuantityPerPallet>int</QuantityPerPallet>
<QuantityPerPackage>int</QuantityPerPackage>
<DangerousGoods>
<UNNumber>string</UNNumber>
<UNIsMarineHazard>boolean</UNIsMarineHazard>
<UNIsDangerousGoods>boolean</UNIsDangerousGoods>
<UNPackageType>I or II or III or Unknown</UNPackageType>
<UNTunnelCodes>
<UNTunnelCode>A or B or C or D or E or B1000C or C5000D</UNTunnelCode>
<UNTunnelCode>A or B or C or D or E or B1000C or C5000D</UNTunnelCode>
</UNTunnelCodes>
<UNClassNumber>string</UNClassNumber>
<UNProperShippingName>
<Name>string</Name>
<LanguageCode>string</LanguageCode>
</UNProperShippingName>
<UNProperShippingName>
<Name>string</Name>
<LanguageCode>string</LanguageCode>
</UNProperShippingName>
<UNLabelNumbers>string</UNLabelNumbers>
<DangerousGoodsCoefficient>decimal</DangerousGoodsCoefficient>
<EmSCode>string</EmSCode>
<FlashPoint>decimal</FlashPoint>
</DangerousGoods>
<DangerousGoods>
<UNNumber>string</UNNumber>
<UNIsMarineHazard>boolean</UNIsMarineHazard>
<UNIsDangerousGoods>boolean</UNIsDangerousGoods>
<UNPackageType>I or II or III or Unknown</UNPackageType>
<UNTunnelCodes>
<UNTunnelCode>A or B or C or D or E or B1000C or C5000D</UNTunnelCode>
<UNTunnelCode>A or B or C or D or E or B1000C or C5000D</UNTunnelCode>
</UNTunnelCodes>
<UNClassNumber>string</UNClassNumber>
<UNProperShippingName>
<Name>string</Name>
<LanguageCode>string</LanguageCode>
</UNProperShippingName>
<UNProperShippingName>
<Name>string</Name>
<LanguageCode>string</LanguageCode>
</UNProperShippingName>
<UNLabelNumbers>string</UNLabelNumbers>
<DangerousGoodsCoefficient>decimal</DangerousGoodsCoefficient>
<EmSCode>string</EmSCode>
<FlashPoint>decimal</FlashPoint>
</DangerousGoods>
<PurchaseCurrencyCode>string</PurchaseCurrencyCode>
<PurchaseCurrencyName>string</PurchaseCurrencyName>
<ExternalNumberOfItems>decimal</ExternalNumberOfItems>
<TaricNumbers>
<TaricNumber>
<CountryCode>string</CountryCode>
<TaricNumber>string</TaricNumber>
</TaricNumber>
<TaricNumber>
<CountryCode>string</CountryCode>
<TaricNumber>string</TaricNumber>
</TaricNumber>
</TaricNumbers>
<BarCodePackage>string</BarCodePackage>
<BarCodePallet>string</BarCodePallet>
<SizeCode>string</SizeCode>
<SizeName>string</SizeName>
<ProcessArticleTime>dateTime</ProcessArticleTime>
<FreeDecimal1>decimal</FreeDecimal1>
<FreeDecimal2>decimal</FreeDecimal2>
<DefaultPickingLocation>string</DefaultPickingLocation>
<CustomsExportConditions>string</CustomsExportConditions>
<ArticleKind>Stock or Production or Structure or NonStock</ArticleKind>
<StockLimit>int</StockLimit>
<ColorCode>string</ColorCode>
<ColorName>string</ColorName>
<DefaultPickingLocationMaxNumberOfItems>decimal</DefaultPickingLocationMaxNumberOfItems>
<MaxStackNumberOfLevels>decimal</MaxStackNumberOfLevels>
<ArticleZoneName>string</ArticleZoneName>
<GoodsCategory>
<Name>string</Name>
<Code>string</Code>
</GoodsCategory>
<LinkToPicture>string</LinkToPicture>
<ArticleReturnHandlingComment>string</ArticleReturnHandlingComment>
<ArticleCustomsDescription>string</ArticleCustomsDescription>
<FreeDecimal3>decimal</FreeDecimal3>
<IsSerialNumberArticle>boolean</IsSerialNumberArticle>
<MinReOrderQuantity>decimal</MinReOrderQuantity>
<ArticleStorageClassName>string</ArticleStorageClassName>
<DefaultLocationStockLimit>decimal</DefaultLocationStockLimit>
<FreeBoolean1>boolean</FreeBoolean1>
<FreeBoolean2>boolean</FreeBoolean2>
<FreeBoolean3>boolean</FreeBoolean3>
<SubQuantityPerItem>decimal</SubQuantityPerItem>
<AdditionalStatisticsNumber>string</AdditionalStatisticsNumber>
<FreeText1>string</FreeText1>
<FreeText2>string</FreeText2>
<FreeText3>string</FreeText3>
<FreeText4>string</FreeText4>
<FreeText5>string</FreeText5>
<ArticlePickingHandlingComment>string</ArticlePickingHandlingComment>
<ArticleInboundHandlingComment>string</ArticleInboundHandlingComment>
<FreeText6>string</FreeText6>
<FreeText7>string</FreeText7>
<FreeText8>string</FreeText8>
<ArticleClasses>
<ArticleClassInfo>
<Name>string</Name>
<Code>string</Code>
<Id>int</Id>
</ArticleClassInfo>
<ArticleClassInfo>
<Name>string</Name>
<Code>string</Code>
<Id>int</Id>
</ArticleClassInfo>
</ArticleClasses>
</Article>
<NumberOfLockedItems>decimal</NumberOfLockedItems>
<NumberOfItems>decimal</NumberOfItems>
<NumberOfBookedItems>decimal</NumberOfBookedItems>
<PerWarehouseStockLines>
<PerWarehouseStockLine>
<WarehouseId>int</WarehouseId>
<WarehouseCode>string</WarehouseCode>
<NumberOfLockedItems>decimal</NumberOfLockedItems>
<NumberOfItems>decimal</NumberOfItems>
<NumberOfBookedItems>decimal</NumberOfBookedItems>
<AvailableForSaleNumberOfItems>decimal</AvailableForSaleNumberOfItems>
<SellableNumberOfItems>decimal</SellableNumberOfItems>
<Reported>
<PickedToBeReportedNumberOfItems>decimal</PickedToBeReportedNumberOfItems>
<ReturnedToBeReportedNumberOfItems>decimal</ReturnedToBeReportedNumberOfItems>
<ReceivedToBeReportedNumberOfItems>decimal</ReceivedToBeReportedNumberOfItems>
</Reported>
<AllocatedNumberOfItems>decimal</AllocatedNumberOfItems>
</PerWarehouseStockLine>
<PerWarehouseStockLine>
<WarehouseId>int</WarehouseId>
<WarehouseCode>string</WarehouseCode>
<NumberOfLockedItems>decimal</NumberOfLockedItems>
<NumberOfItems>decimal</NumberOfItems>
<NumberOfBookedItems>decimal</NumberOfBookedItems>
<AvailableForSaleNumberOfItems>decimal</AvailableForSaleNumberOfItems>
<SellableNumberOfItems>decimal</SellableNumberOfItems>
<Reported>
<PickedToBeReportedNumberOfItems>decimal</PickedToBeReportedNumberOfItems>
<ReturnedToBeReportedNumberOfItems>decimal</ReturnedToBeReportedNumberOfItems>
<ReceivedToBeReportedNumberOfItems>decimal</ReceivedToBeReportedNumberOfItems>
</Reported>
<AllocatedNumberOfItems>decimal</AllocatedNumberOfItems>
</PerWarehouseStockLine>
</PerWarehouseStockLines>
</PerWarehouseArticleLine>
<PerWarehouseArticleLine>
<Article>
<SystemId>int</SystemId>
<Name>string</Name>
<ArticleNumber>string</ArticleNumber>
<ProductCode>string</ProductCode>
<BarCode>string</BarCode>
<Description>string</Description>
<SupplierArticleNumber>string</SupplierArticleNumber>
<StatisticsNumber>string</StatisticsNumber>
<ArticleGroupName>string</ArticleGroupName>
<ArticleGroupCode>string</ArticleGroupCode>
<MainSupplierName>string</MainSupplierName>
<MainSupplierNumber>string</MainSupplierNumber>
<ArticleCategoryName>string</ArticleCategoryName>
<ArticleCategoryCode>string</ArticleCategoryCode>
<CountryOfOriginCode>string</CountryOfOriginCode>
<IsStockArticle>boolean</IsStockArticle>
<ArticleUnitCode>string</ArticleUnitCode>
<VatCode>string</VatCode>
<VatPercent>decimal</VatPercent>
<Length>decimal</Length>
<Width>decimal</Width>
<Height>decimal</Height>
<Price>decimal</Price>
<CustomerPrice>decimal</CustomerPrice>
<PurchasePrice>decimal</PurchasePrice>
<Weight>decimal</Weight>
<NetWeight>decimal</NetWeight>
<Volume>decimal</Volume>
<QuantityPerPallet>int</QuantityPerPallet>
<QuantityPerPackage>int</QuantityPerPackage>
<DangerousGoods>
<UNNumber>string</UNNumber>
<UNIsMarineHazard>boolean</UNIsMarineHazard>
<UNIsDangerousGoods>boolean</UNIsDangerousGoods>
<UNPackageType>I or II or III or Unknown</UNPackageType>
<UNTunnelCodes>
<UNTunnelCode>A or B or C or D or E or B1000C or C5000D</UNTunnelCode>
<UNTunnelCode>A or B or C or D or E or B1000C or C5000D</UNTunnelCode>
</UNTunnelCodes>
<UNClassNumber>string</UNClassNumber>
<UNProperShippingName>
<Name>string</Name>
<LanguageCode>string</LanguageCode>
</UNProperShippingName>
<UNProperShippingName>
<Name>string</Name>
<LanguageCode>string</LanguageCode>
</UNProperShippingName>
<UNLabelNumbers>string</UNLabelNumbers>
<DangerousGoodsCoefficient>decimal</DangerousGoodsCoefficient>
<EmSCode>string</EmSCode>
<FlashPoint>decimal</FlashPoint>
</DangerousGoods>
<DangerousGoods>
<UNNumber>string</UNNumber>
<UNIsMarineHazard>boolean</UNIsMarineHazard>
<UNIsDangerousGoods>boolean</UNIsDangerousGoods>
<UNPackageType>I or II or III or Unknown</UNPackageType>
<UNTunnelCodes>
<UNTunnelCode>A or B or C or D or E or B1000C or C5000D</UNTunnelCode>
<UNTunnelCode>A or B or C or D or E or B1000C or C5000D</UNTunnelCode>
</UNTunnelCodes>
<UNClassNumber>string</UNClassNumber>
<UNProperShippingName>
<Name>string</Name>
<LanguageCode>string</LanguageCode>
</UNProperShippingName>
<UNProperShippingName>
<Name>string</Name>
<LanguageCode>string</LanguageCode>
</UNProperShippingName>
<UNLabelNumbers>string</UNLabelNumbers>
<DangerousGoodsCoefficient>decimal</DangerousGoodsCoefficient>
<EmSCode>string</EmSCode>
<FlashPoint>decimal</FlashPoint>
</DangerousGoods>
<PurchaseCurrencyCode>string</PurchaseCurrencyCode>
<PurchaseCurrencyName>string</PurchaseCurrencyName>
<ExternalNumberOfItems>decimal</ExternalNumberOfItems>
<TaricNumbers>
<TaricNumber>
<CountryCode>string</CountryCode>
<TaricNumber>string</TaricNumber>
</TaricNumber>
<TaricNumber>
<CountryCode>string</CountryCode>
<TaricNumber>string</TaricNumber>
</TaricNumber>
</TaricNumbers>
<BarCodePackage>string</BarCodePackage>
<BarCodePallet>string</BarCodePallet>
<SizeCode>string</SizeCode>
<SizeName>string</SizeName>
<ProcessArticleTime>dateTime</ProcessArticleTime>
<FreeDecimal1>decimal</FreeDecimal1>
<FreeDecimal2>decimal</FreeDecimal2>
<DefaultPickingLocation>string</DefaultPickingLocation>
<CustomsExportConditions>string</CustomsExportConditions>
<ArticleKind>Stock or Production or Structure or NonStock</ArticleKind>
<StockLimit>int</StockLimit>
<ColorCode>string</ColorCode>
<ColorName>string</ColorName>
<DefaultPickingLocationMaxNumberOfItems>decimal</DefaultPickingLocationMaxNumberOfItems>
<MaxStackNumberOfLevels>decimal</MaxStackNumberOfLevels>
<ArticleZoneName>string</ArticleZoneName>
<GoodsCategory>
<Name>string</Name>
<Code>string</Code>
</GoodsCategory>
<LinkToPicture>string</LinkToPicture>
<ArticleReturnHandlingComment>string</ArticleReturnHandlingComment>
<ArticleCustomsDescription>string</ArticleCustomsDescription>
<FreeDecimal3>decimal</FreeDecimal3>
<IsSerialNumberArticle>boolean</IsSerialNumberArticle>
<MinReOrderQuantity>decimal</MinReOrderQuantity>
<ArticleStorageClassName>string</ArticleStorageClassName>
<DefaultLocationStockLimit>decimal</DefaultLocationStockLimit>
<FreeBoolean1>boolean</FreeBoolean1>
<FreeBoolean2>boolean</FreeBoolean2>
<FreeBoolean3>boolean</FreeBoolean3>
<SubQuantityPerItem>decimal</SubQuantityPerItem>
<AdditionalStatisticsNumber>string</AdditionalStatisticsNumber>
<FreeText1>string</FreeText1>
<FreeText2>string</FreeText2>
<FreeText3>string</FreeText3>
<FreeText4>string</FreeText4>
<FreeText5>string</FreeText5>
<ArticlePickingHandlingComment>string</ArticlePickingHandlingComment>
<ArticleInboundHandlingComment>string</ArticleInboundHandlingComment>
<FreeText6>string</FreeText6>
<FreeText7>string</FreeText7>
<FreeText8>string</FreeText8>
<ArticleClasses>
<ArticleClassInfo>
<Name>string</Name>
<Code>string</Code>
<Id>int</Id>
</ArticleClassInfo>
<ArticleClassInfo>
<Name>string</Name>
<Code>string</Code>
<Id>int</Id>
</ArticleClassInfo>
</ArticleClasses>
</Article>
<NumberOfLockedItems>decimal</NumberOfLockedItems>
<NumberOfItems>decimal</NumberOfItems>
<NumberOfBookedItems>decimal</NumberOfBookedItems>
<PerWarehouseStockLines>
<PerWarehouseStockLine>
<WarehouseId>int</WarehouseId>
<WarehouseCode>string</WarehouseCode>
<NumberOfLockedItems>decimal</NumberOfLockedItems>
<NumberOfItems>decimal</NumberOfItems>
<NumberOfBookedItems>decimal</NumberOfBookedItems>
<AvailableForSaleNumberOfItems>decimal</AvailableForSaleNumberOfItems>
<SellableNumberOfItems>decimal</SellableNumberOfItems>
<Reported>
<PickedToBeReportedNumberOfItems>decimal</PickedToBeReportedNumberOfItems>
<ReturnedToBeReportedNumberOfItems>decimal</ReturnedToBeReportedNumberOfItems>
<ReceivedToBeReportedNumberOfItems>decimal</ReceivedToBeReportedNumberOfItems>
</Reported>
<AllocatedNumberOfItems>decimal</AllocatedNumberOfItems>
</PerWarehouseStockLine>
<PerWarehouseStockLine>
<WarehouseId>int</WarehouseId>
<WarehouseCode>string</WarehouseCode>
<NumberOfLockedItems>decimal</NumberOfLockedItems>
<NumberOfItems>decimal</NumberOfItems>
<NumberOfBookedItems>decimal</NumberOfBookedItems>
<AvailableForSaleNumberOfItems>decimal</AvailableForSaleNumberOfItems>
<SellableNumberOfItems>decimal</SellableNumberOfItems>
<Reported>
<PickedToBeReportedNumberOfItems>decimal</PickedToBeReportedNumberOfItems>
<ReturnedToBeReportedNumberOfItems>decimal</ReturnedToBeReportedNumberOfItems>
<ReceivedToBeReportedNumberOfItems>decimal</ReceivedToBeReportedNumberOfItems>
</Reported>
<AllocatedNumberOfItems>decimal</AllocatedNumberOfItems>
</PerWarehouseStockLine>
</PerWarehouseStockLines>
</PerWarehouseArticleLine>
</PerWarehouseArticleLines>
<GetInventoryPerWarehouseErrors>
<GetInventoryPerWarehouseError>
<Message>string</Message>
<ErrorType>LogonError or UnknownError</ErrorType>
</GetInventoryPerWarehouseError>
<GetInventoryPerWarehouseError>
<Message>string</Message>
<ErrorType>LogonError or UnknownError</ErrorType>
</GetInventoryPerWarehouseError>
</GetInventoryPerWarehouseErrors>
</GetInventoryPerWarehouseResult>
</GetInventoryPerWarehouseResponse>
</soap:Body>
</soap:Envelope>
Response specification
GetInventoryPerWarehouseResponse | ||
---|---|---|
GetInventoryPerWarehouseResult | GetInventoryPerWarehouseResult |
GetInventoryPerWarehouseResult | ||
---|---|---|
Success | boolean | Whether or not the call was successful |
PerWarehouseArticleLines | PerWarehouseArticleLine[] | Containing elements of PerWarehouseArticleLine |
GetInventoryPerWarehouseErrors | GetInventoryPerWarehouseError[] | If the call was not succesfull, this will contain elements of GetInventoryPerWarehouseError, giving more details about why the call was not successful |
PerWarehouseArticleLine | ||
---|---|---|
Article | ArticleClass | Defines the article |
NumberOfLockedItems | decimal | Number of items in stock which are locked (in total, for all warehouses). |
NumberOfItems | decimal | Number of items in stock (in total, for all warehouses). |
NumberOfBookedItems | decimal | Number of items booked (in total, for all warehouses). |
PerWarehouseStockLines | PerWarehouseStockLine[] | Containing elements of type PerWarehouseStockLine, which in turn contains the stock balance figures for a specific warehouse |
GetInventoryPerWarehouseError | ||
---|---|---|
Message | string | Error message |
ErrorType | enum | Error type |
ArticleClass | ||
---|---|---|
SystemId | int | System id of the article |
Name | string(200) | Article name |
ArticleNumber | string | Article number |
ProductCode | string(200) | Product code |
BarCode | string | Barcode/EAN |
Description | string(3000) | Description |
SupplierArticleNumber | string(200) | Article number from the supplier |
StatisticsNumber | string | Statistical number/harmonization code |
ArticleGroupName | string | Article group name |
ArticleGroupCode | string | Article group code |
MainSupplierName | string(200) | Supplier name |
MainSupplierNumber | string(200) | Supplier number |
ArticleCategoryName | string(200) | Article category name |
ArticleCategoryCode | string(50) | Article category code |
CountryOfOriginCode | string(2) | The two-letter ISO 3166-1 alpha-2 code of the country. |
IsStockArticle | boolean | False if the article is fictional (freight cost etc) |
ArticleUnitCode | string(50) | Unit code |
VatCode | string(50) | VAT code |
VatPercent | decimal | VAT percent |
Length | decimal | Length in m |
Width | decimal | Width in m |
Height | decimal | Height in m |
Price | decimal | Stock valuation price |
CustomerPrice | decimal | Customer price |
PurchasePrice | decimal | Purchase price |
Weight | decimal | Weight in kg |
NetWeight | decimal | Net weight in kg |
Volume | decimal | Volume in m3 |
QuantityPerPallet | int | Number of units that fit on a pallet |
QuantityPerPackage | int | Number of units that fit in a package/box |
DangerousGoods | DangerousGoods | Elements of DangerousGoods, defines ADR properties |
PurchaseCurrencyCode | string | Currency code for purchase price |
PurchaseCurrencyName | string | Currency name for purchase price |
ExternalNumberOfItems | decimal | Only used when an integration is made by Ongoing WMS itself. The number of items which the external system believes is available for this article |
TaricNumbers | TaricNumbersInfo | Taric numbers by country |
BarCodePackage | string | Barcode for package |
BarCodePallet | string | Barcode for pallet |
SizeCode | string(50) | The code of the article's size (e.g "42" when dealing with shoes, or "XS" when dealing with clothes) |
SizeName | string | The name of the article's size (e.g "Extra Small" when dealing with clothes) |
ProcessArticleTime | dateTime | The last time ProcessArticle was called for this article. Note that it is possible to have articles which were created by other means than ProcessArticle, e.g. an article may have been created manually in the system. |
FreeDecimal1 | decimal | Custom decimal field. By default not used for anything. |
FreeDecimal2 | decimal | Custom decimal field. By default not used for anything. |
DefaultPickingLocation | string(50) | The default picking location of the article. Note that it is entirely possible to store the article in other locations than the default picking location (e.g. a warehouse may have unbroken pallets of an article in their deep storage, and keep a single pallet in the default picking location). |
CustomsExportConditions | string | A string describing which conditions apply when the article is exported. |
ArticleKind | enum | An enum describing what kind of article this is:
|
StockLimit | int | Minimum number of units allowed in stock |
ColorCode | string(50) | The code of the article's color |
ColorName | string | The name of the article's color |
DefaultPickingLocationMaxNumberOfItems | decimal | The maximum number of items that can be stored in the default picking location. |
MaxStackNumberOfLevels | decimal | If the article is stackable, this represents the maximum number of levels in such a stack. |
ArticleZoneName | string(300) | The warehouse zone which this article is intended to be stored in. |
GoodsCategory | GoodsCategoryInfo | An element of type GoodsCategoryInfo. |
LinkToPicture | string(300) | A link to a picture of the article. |
ArticleReturnHandlingComment | string(500) | A comment on how an article should be handled when returned. |
ArticleCustomsDescription | string(200) | Customs description. Also known as "Contents". |
FreeDecimal3 | decimal | Custom decimal field. By default not used for anything. |
IsSerialNumberArticle | boolean | Whether or not the article is a serial number article. |
MinReOrderQuantity | decimal | Minimum number of units that should be reordered |
ArticleStorageClassName | string | The storage class of the article, e.g A,B or C. |
DefaultLocationStockLimit | decimal | Minimum number of units allowed in the default picking location. |
FreeBoolean1 | boolean | Custom boolean field. By default not used for anything. |
FreeBoolean2 | boolean | Custom boolean field. By default not used for anything. |
FreeBoolean3 | boolean | Custom boolean field. By default not used for anything. |
SubQuantityPerItem | decimal | Subquantity per item |
AdditionalStatisticsNumber | string | Additional statistics number |
FreeText1 | string | Custom text field 1. By default not used for anything. |
FreeText2 | string | Custom text field 2. By default not used for anything. |
FreeText3 | string | Custom text field 3. By default not used for anything. |
FreeText4 | string | Custom text field 4. By default not used for anything. |
FreeText5 | string | Custom text field 5. By default not used for anything. |
ArticlePickingHandlingComment | string(500) | A comment on how an article should be handled when picked. |
ArticleInboundHandlingComment | string(500) | A comment on how an article should be handled during goods reception. |
FreeText6 | string | Custom text field 6. By default not used for anything. |
FreeText7 | string | Custom text field 7. By default not used for anything. |
FreeText8 | string | Custom text field 8. By default not used for anything. |
ArticleClasses | ArticleClassInfo[] | List of Article Classes applied to the article |
PerWarehouseStockLine | ||
---|---|---|
WarehouseId | int | Ongoing WMS internal id for the warehouse |
WarehouseCode | string(50) | The code for the warehouse |
NumberOfLockedItems | decimal | Number of items in stock which are locked (for this specific warehouse). |
NumberOfItems | decimal | Number of items in stock (for this specific warehouse). |
NumberOfBookedItems | decimal | Number of items which are booked but not yet picked (for this specific warehouse). |
AvailableForSaleNumberOfItems | decimal | Number of items which are not locked for sale (in this specific warehouse). |
SellableNumberOfItems | decimal | Number of items which can still be sold (from this specific warehouse). In other words, this value is AvailableForSaleNumberOfItems minus the number of booked articles. |
Reported | ReportedPerArticleAndWarehouse | An element of type ReportedPerArticleAndWarehouse. |
AllocatedNumberOfItems | decimal | Number of items which are allocated (in this specific warehouse). |
DangerousGoods | ||
---|---|---|
UNNumber | string(10) | UNNumber of ADR specification |
UNIsMarineHazard | boolean | True if ADR is classed as a marine hazard |
UNIsDangerousGoods | boolean | True if ADR is classed as dangerous goods |
UNPackageType | enum | Package type - I - II - III - Unknown |
UNTunnelCodes | UNTunnelCode[] | Tunnel codes of ADR |
UNClassNumber | string(50) | Class number of ADR |
UNProperShippingName | ProperShippingName | Elements of UNProperShippingName |
UNLabelNumbers | string(50) | Label numbers of ADR |
DangerousGoodsCoefficient | decimal | ADR Coefficient |
EmSCode | string | EmS |
FlashPoint | decimal | Flash Point |
TaricNumbersInfo | ||
---|---|---|
TaricNumber | TaricNumberInfoClass | List of TARIC number objects |
GoodsCategoryInfo | ||
---|---|---|
Name | string | Goods category name |
Code | string | Goods category code |
ArticleClassInfo | ||
---|---|---|
Name | string | |
Code | string | |
Id | int |
ReportedPerArticleAndWarehouse | ||
---|---|---|
PickedToBeReportedNumberOfItems | decimal | Number of items which have been picked but not reported. See Reported number of items. |
ReturnedToBeReportedNumberOfItems | decimal | Number of items which have been returned but not reported. See Reported number of items. |
ReceivedToBeReportedNumberOfItems | decimal | Number of items which have been received but not reported. See Reported number of items. |
ProperShippingName | ||
---|---|---|
Name | string | Proper shipping name |
LanguageCode | string | Language code |
TaricNumberInfoClass | ||
---|---|---|
CountryCode | string | Country code |
TaricNumber | string | TARIC number |