Location Resource

This resource describes a single location (store, warehouse, web site)

"K". The field physkey is expected in the "k" (key) parameter for FD1 edit functions.

Available Fields

Name	Description	Datatype	Resource	"q"
locid	Internal reference number allocated by the system. Numbers greater than 0 are constant, negative numbers are reserved to Fieldpine may change without warning. Zero is an invalid value.	Number
name	Name of the location as shown on reports	String
geolat		Double
geolong		Double
city
address1
address2
address3
address4
address5
address6
comments
rid
stockinserver	Are stock levels maintained in the server, or individual lanes as a source of truth	Number
stockflags	Range of flags to control operation of this location. Despite being called stockflags it also controls non stock related functions	Number
companyid	Company Id#. Used only in multiple brand configurations. Deprecated do not use for new development	Number
active	Active Store	Boolean
publish
parent	Parent store that controls this store, if stores have structure, otherwise blank	Number
opendt
closedt		DateTime
postcode		String
taxregion	Region or State this store operates within. Only required for countries that have state or local taxes	Number
taxid0		String
bsb	Australian BSB code	String
bankaccountno		String
bankaccountname		String
posbestip
phone
email	Internal use email typically used for admin contact
introen
openhours
contact	A published name of the person acting as primary contact for this location
descriptiveaddress	A descriptive address for shoppers describing how to find the store
deliveryaddress
buyerphone
formalname	Legal name of store that might be used on documents such as purchase orders	String
ordercc	Email address to receive a CC copy of all Purchase Orders emailed.	String
type	Actual type of location. See Locations database definition for acceptable values.	Number
publicaccess	Public have access to this location	Number
georeportarea	Geographic area for reporting and management. Stores do not need to physically be in this area
postaladdr	Postal Address of store
externalid	External Id number. Used as reference to other systems code for this location
region	Region code
branch	Branch code
fax
blocksalecreate	If set, the location cannot create new sales
hidestocklevels	If set, causes this location to be excluded from some, but not all, reports around stock levels. Primarily honoured on reports that may be seen by associated stores.
blockstockordering	If set, this location cannot raise new purchase order. May not be enforced by all screens and applications
blockstockreceive	When set this location cannot receive stock or transfers. May not be enforced by all screens and applications
shortcode	A short abbreviated code to describe this location. Must be uniqe	String
installpassword	A simple password that must be entered in order to install new software into this store.	String
installallow	An encoded bitmask that controls what sort of software can be installed into this location	Number
receiptmessage	Store specific message to place on customer receipts. The receipt format must specifically include this symbol	String
isset		Number
issetcount		Number
issetlist
stockloc	Location number stock is taken from	Number
commission	Commission payable by store. This value is not directly used by Fieldpine but is available for site specific reports	Double
storecontrollertype	Where this stores controller is located	Number
storecontrollerloc	Location id of owning store controller	Number
altnames	Alternative List. Other names this store can be known by. Often used when matching supplier store names. Names must be unique, no single value can match multiple locations.
apikey	Api Key that can be used to send business transactions to the store.	String
altids	JSON Array of objects providing alternative Id strings.
iconurl
operatingprofile	Key to profile this store uses	String
stocklevelsarezero	If set, this location reports all stock levels as zero
rve		Double
physkey	Internal identifying key. This value can always be used to refer to a specific location
backupflags	Internal flags controlling how backups are performed	Number
permdesc		String
labelcontrol	JSON data to override label formats when printing
timezone		String
receipttemplate		String
receiptemailbody		String
receiptemailsubject		String
languagelist	Comma seperated list of languages for this store	String
sendreceiptontransfer		String
publicname	Friendly version of store name for general public use
costcentre	Financial cost centre used in accounting system
quickdial	Quick dial phone number for internal PABX
quickfax	Quick dial fax number for internal PABX
mobile	Mobile phone number of store
emailmgr	Managers email
iprangeinstore
ipnetmaskinstore
storeserver1addr	Store Server 1	String
storeserver2addr	Store Server 2	String
storedns	Store DNS	String
routerprofile	Router Profile
priceband	Price Band
agencyloginemail	login name (email) used for an agency to access fieldpine.com	String
agencyloginpass	login password used for an agency to access fieldpine.com	String
state	Regional state of this location	String
geoallow		String
installedprofile		String
sclaneauthkey	An auth key that can be used to authorise lanes onto remote RmSystem	String
scownerauthkey	An auth key that we can use to access the remote RmSystem	String
scrmsystem	The RmSystem allocated to the remote RmSystem	String
countrycode	Country code number for where this store is located	Number
geoarea	Geographic area of this store	Number
pickingemail	Email address to receive internal notices about web sales	String
purchaseordertemplate	Url of default purchase order template for this store	String
purchaseordercoverletter	Body of order emails sent from this store
purchaseorderemailsubject	Subject of order emails sent from this store	String
station	Holds an alternative number for location, used by some retailers that need to hold additional values. This value is not used directly by Fieldpine	Number
poweracc	Power Supplier Account Number
nzlmtano	MTA Membership number
nzlpowericp	Power supplier ICP reference number
nzlpowerretailer	Power supplier (retailer)
avic		String
nztaapproval		Number
nztaassesor		String
nzpost_sender_companyname		String
nzpost_sender_name		String
nzpost_sender_phone		String
nzpost_sender_email		String
nzpost_pickupaddress_street		String
nzpost_pickupaddress_suburb		String
nzpost_pickupaddress_city		String
nzpost_pickupaddress_postcode		String
nzldatacompayrollid		String
instoreradio		Boolean