Developers
 
Library Developer Home Web Appearance Customising Reports APIs Primitives OpenAPI eLink O3 DataRead Realtime SSE Levels Online Services xyz.online.fielpine.com Zone Stock Levels
Worked Examples Customer Signup Detailed Guides Login Pages Tips & Tricks Database Override POS UI Cheatsheet

Zone based Stock Levels

Zone based stock levels allows retailers that opt in to share their stock levels and see the levels of others. This is not a free for all though, and what individual retailers can see is restricted.

Zone stock levels are useful for checking stock levels to see if items are present anywhere. For example a state level stock controller might be able to see all levels within a single state.

How it works

  • This is an opt-in system, if you are a single retailer, you must specifically add references to a XXX.online.fieldpine.com domain and zone
  • Retailers upload their current levels to xxx.online.fieldine.com providing
    • Their internal store identifier, not the store name. This is a GUID/UUID like value, such as AKAKFJEJH38478fbgdhghFG
    • The products internal identifer, not the pid,plu,description. Again this a GUID/UUID like value, such as P38nFvgfg43BGD89az34
  • Retailers send periodic "heres all my levels" and realtime "I've changed level on X" data to xxx.online.fieldpine.com
  • In addition to the above, they send "zone" and "password". Zone defines the "set" all levels belong too, such that you might have zone=NSW for New South Wales Stores only and zone=AUS for all Australian stores.
  • Retailers do not need to be part of the same business or chain, but must somehow share the internal identifiers, which are long and complex.

To see levels, retailers query xxx.fieldpine.com using various reports, however:

  • The reports must submit the specific "store identifiers" they wish to see the levels of. So if you do not know the store identifier, you cannot see that stores stocklevels in isolation
  • Stores can see "all stores" as a total however

Output Reports

A typical report might appear as follows

Product All Stores Sydney Perth Darwin QLD Warehouse
Sparkly thing 50gm13262
Bigger Sparkly thing 120gm24249
Sparkly thing party pack22
Note how the "All Stores" does not always equal the totals. This implies these items are in-stock elsewhere but you do not have rights to see who.