Input Arguments
Arg# | Name | Type | Description |
3 | 's' | Required. Constant 'retailmax.elink.locations' | |
9 | 's' | Predicates to select data to return. | |
8 | 'E' | Maximum rows to return. |
Output Arguments
Arg# | Name | Description |
f100 | Locid | The location_id for this location. |
f101 | Name | The name of this location. |
f102 | geoLat | Location Latitude |
f103 | geoLong | Location Longitude |
f104 | City. This may be blank even if a complete address is supplied. | |
f106 | Address line 1. Address fields can either be written individually, or a complete address may be written using F500 | |
f107 | Address line 2 | |
f108 | Address line 3 | |
f109 | Address line 4 | |
f110 | Address line 5 | |
f111 | Address line 6 | |
f112 | Comments | Comments. Free form for comments. These comments are considered internal comments, not public comments |
f122 | Active flag. Indicates a location that is open and available for use, as different to historic records. | |
f123 | Publish indicator. Set to 1 for locations that are considered published to external places such as websites. | |
f125 | OpenDt | The date this store first opened to customers |
f126 | CloseDt | The date this store closed to customers |
f150 | Phone | Store phone number as available to shoppers |
f151 | An email address that can be made available to shoppers | |
f152 | IntroEn | A small descriptive blurb describing this store. Intended for eCommerce sites to use as the description. |
f153 | OpenHours | Free form text describing the normal opening hours of this store |
f154 | Contact | A contact name that can be given to shoppers as a primary contact for the store. May be an actual name, or a generic term such as "Customer service" or "the manager" |
f155 | DescriptiveAddress | A explanatory form of the physical address of this store. Typcially used to aid the shopper finding a store where the formal address might not be completely helpful |
f160 | DeliveryAddress | Delivery address of this store. This would be as printed on courier and postal labels. |
f161 | Buyers phone number for this store. Typically used on purchase order and supplier communications. Not made publically available. | |
f162 | FormalName | Formal store name, as would be used on purchase orders and similar purposes |
f198 | IconUrl | A url providing a image that can be used as an identification icon for this store. |
f300 | PublicName | Friendly version of store name for general public use |
f500 (?) | A complete address, as might be entered by a user. The individual lines should be delimted with '|', or CR or LF. Blank lines are discarded. This field provides a helper so that forms can simply request the complete address and do not need to attempt to parse the resultant input. | |
f301 | CostCentre | Financial cost centre used in accounting system |
f302 | QuickDial | Quick dial phone number for internal PABX |
f303 | QuickFax | Quick dial fax number for internal PABX |
f304 | Mobile | Mobile phone number of store |
f305 | EmailMgr | Store Managers email |
f6000 | PowerAcc | Power Supplier Account Number |
f1064000 | NzlMtaNo | MTA Membership number |
f1064001 | NzlPowerIcp | Power supplier ICP reference number |
f1064002 | NzlPowerRetailer | Power supplier (retailer) |
f1064003 | AVIC | AVIC Id |
f1064004 | NZTAApproval | NZTA Approval # |
f1064005 | NZTAAssesor | NZTA Assesor |
f2064000 | NzlDatacomPayrollId | Datacom Payroll Id |
f3000000 | InStoreRadio | The store is fitted with some type of in store captive radio system |
Examples
Select and return any two locations. The "8=2" is used to restrict output to two rows./gnap/buck?3=retailmax.elink.locations&8=2
Select extended details for store #3 and reply in JSON format
/gnap/J/BUCK?3=retailmax.elink.locations&10=100-300&9=f100,0,3 { "RootType":"ARAY","f500":4, "DATS":[ { "IsSet":0, "Locid":3, "Name":"Lower Hutt", "Comments":"Lower Hutt Store", "Phone":"1232828", "Email":"lh@example.com", "IntroEn":"Right in the heart of Lower Hutt our store staff are eager to help you", "DeliveryAddress":"123 Some street", "DescriptiveAddress":"Positioned by the mall entrance next to the theatre", "AltNames":"LH", "PhysKey":"KEPQAAAADUE8EG9ZADXCQDQAAAYAAAAB", "PosBestIP":null, "IconUrl":"\/geni\/clipart_375.png" } ] }