Internal object IDs
Table of contents
The automation API mainly operates in terms of Ongoing WMS' various internal IDs. To use the automation API, it is necessary to understand these IDs. All of the various internal IDs are integers.
The different types of internal object IDs
The goods owners are the customers of the warehouse, i.e. the companies which the 3PL warehouse provides services for. Each goods owner is represented by a unique GoodsOwner.
An ArticleDefId is Ongoing WMS' internal id for an article, i.e. the basic article data such as article number, barcode, dimensions. When you use ProcessArticle to create an article, it will automatically be assigned an ArticleDefId.
An article item is an instance of an article. When the warehouse receives a quantity of an article, a new ArticleItemId will be created for that particular goods reception. On the article item, the warehouse may also record some other data, such as a serial number.
Let's say you have an article item with id 1978, representing 40 pieces of something. In Ongoing WMS, it is possible to split an item. For instance, you may split off 10 pieces of 1978. This will result in item 1978 now representing 30 pieces, and a totally new article item (with id, say, 3789) which represents 10 pieces.
In this case we say that the original article item id of 3789 is 1978.
Whenever an article item is placed in a location, a new ArticleItemInLocationId is generated for that combination of article item and location.
The warehouse may create a movement order for an article item, signaling that they intend to move the article item from its current location to some other location. The MovementArticleItemId is the id of the movement order.
Several MovementArticleItemIds can be grouped onto one WorkOrderId.
An InventoryId contains one or more inventory transactions.
The system allows for the creation of invoices for each goods owner. Each invoice has a unique InvoiceId.
Before a charge can be added to an invoice, the warehouse must first create an invoice article for that type of charge. Each invoice article has a unique InvoiceArticleId.