Location entity
The Location entity is used to submit location-specific information, such as a physical store address, and/or technical fields for e-commerce stores. Multiple Location entities can be linked to a merchant (i.e., an Account entity). See visual below.
The table below captures the Location entity’s required fields.
note
Some field values are case sensitive. These field will be denoted with an * for clarity.
| Field Name | Value | Description | Type |
|---|---|---|---|
| parentId | 6410461062cebb512 | ID of the “Parent” for this location. This will be the unique uP POM Account ID of the merchant on the uP Platform. This is provided automatically by the uP POM after the Account entity is created. | Mandatory |
| parentType | Account | Type of the “Parent” for this location. Should always send “Account”. * Case sensitive submission. | Mandatory |
| name | Company ABC | Doing business as (DBA) name of this location. | Mandatory |
| type | In store | Type of store location. Options are: - In store - Ecommerce * Case sensitive submission. | Mandatory |
| multicurrency | DCC | Type of multicurrency capabilities that will be supported. Options are: - DCC - MCP - None * Case sensitive submission. | Mandatory |
| transactionalCurrency | HKD | Default transactional currency for this location. Currency 3 letter code ISO 4217-Alpha 3. * Case sensitive submission. | Mandatory |
| ecomTestLogin | testLogin | Test login for the URL of this e-commerce location. | Conditional – only required if the location "type” is “Ecommerce” |
| ecomTestPassword | St0r3p@$$w0rd | Test password for the URL of this e-commerce location. | Conditional – only required if the location "type” is “Ecommerce” |
| ecomWebsite | https://www.companyabcstore.com | URL of this e-commerce location. | Conditional – only required if the location "type” is “Ecommerce” |
| posBusinessType | NomuPay | The POS terminal provider for this location. Options are: - NomuPay - 3rd Parties * Case sensitive submission. | Conditional – only required if the location "type” is “In Store” |
| posComType | Wireless | Type of communication required for the POS at this location. Options are: - Dial-up - Ethernet - Wireless - Wired * Case sensitive submission. | Conditional – only required if “posBusinessType” is “NomuPay” |
| posModel | PAX Q80 | Terminal model of the POS for this location if it has been provided by NomuPay. Option is: - PAX Q80 | Conditional – only required if “posBusinessType” is “NomuPay” |
| posProfile | Retail | Profile required for the POS terminal at this location. Options are: - Retail - F&B - Hotel * Case sensitive submission. | Conditional – only required if “posBusinessType” is “NomuPay” |
| posQuantity | 2 | Number of POS terminals needed for this location. * Numerical digits only. | Conditional – only required if the location "type” is “In Store” |
| addressCity | Sheung Wan | City of this location. | Conditional – only required if the location "type” is “In Store” |
| addressCountry | HK | Country of this location. Country 2 letter code ISO 3166-1 Alpha 2. * Case sensitive submission. | Conditional – only required if the location "type” is “In Store” |
| addressPostalCode | 999077 | Postal code of this location. | Conditional – only required if the location "type” is “In Store” |
| addressState | Hong Kong | State of this location. | Conditional – only required if the location "type” is “In Store” |
| addressStreet | 123 Front Street | Street address of this location. | Conditional – only required if the location "type” is “In Store” |