Location

Location setup

To set up or edit a location, do the following:

1. In the InStore Center, select Locations.
2. In the Actions column, click the Edit icon to view or change details for a location, or click Add Location to create a new one.
3. On the Location Information page, provide the following details:
   • Location Name: name displayed in the InStore Center.
   • Location ID: unique identifier for the location. Location IDs must correspond to locations already registered in your Project. This value becomes a component in the InStore colleague app URL.
   • Tax ID: (optional) tax identifier for the location. Overrides the environment's Tax ID for this location only.
   • Location Type: select a type that describes the location. Add more types using the Reference list.
     Choose the location type carefully. Your organization may use it for reporting and metrics.

   • Status: shown only for active locations. New locations have a status of Pending until activated. Select Inactive for permanently closed locations. Locations with Pending or Inactive status are unavailable to users, except those with the Device Management permission, who can log in to register devices.
   • Card Payment Processor: for live locations, select a payment processor from those set at the environment level. For test locations, select Simulator, a Stripe or Adyen test simulator, or a custom test simulator.
     In production environments, do not use simulators. In test environments, do not use actual payment connections.

     The relevant environment must be activated before you can set up locations.
   • Gift Card Processor: for live locations, select a payment processor from those set at the environment level.
   • Wallet Processor: for live locations with Digital Wallet enabled, select a processor from those set at the environment level.
   • Pay On Account Processor: for live locations with Payment on Account enabled, select a processor from those set at the environment level.
   • Store Safe: shown only for active locations. Select the device designated to hold cash. This can be a physical safe or a register tagged as Eligible as Safe. Register your devices in the InStore colleague app before completing this field.
   • Parameter Set: select the parameter set for this location if it differs from the environment.
     You cannot override parameters set as immutable at the environment level. You can bulk-load locations by running a configuration file with the InStore device CLI.
   • Template Set: select the receipt template set for this location if it differs from the environment.
   • Language: select a supported language. This determines the language displayed when users log in to this location. To use receipts in another language, select the translated set in the Template Set field.
   • Location Description: description shown on the Locations page and available for receipts.
   • Address: (optional) complete address for receipts. The country is inferred from the Locale setting at the environment level.
   • Telephone Number: phone number for receipts, including country code if needed (for example, +44 for the UK). No formatting rules are applied.
4. Click Save Changes. This creates the location but does not activate it.

Activate a new location

To set up a location or edit its information, do the following:

1. In the InStore Center, select Locations.
2. In the Actions column, click the Edit icon to view or change details for a location, or click Add Location to create a new one.
3. On the Location Information page, complete the following fields:
   • Location Name: name displayed in the InStore Center.
   • Location ID: unique identifier. Must already exist in your Project. Becomes a component in the InStore colleague app URL.
   • Tax ID: (optional) tax identifier that overrides the environment Tax ID for this location only.
   • Location Type: select a type. Add more types using the Reference list.
     Choose carefully. Your organization may use this value for metrics.

   • Status: shown only for active locations. New locations have Pending status until activated. Select Inactive for locations that are permanently closed. Locations with Pending or Inactive status are unavailable to users except those with the Device Management permission.
   • Card Payment Processor: for live locations, select a processor configured at the environment level. For test locations, select Simulator (Stripe, Adyen, or custom test simulator).
     In production environments, do not use simulators. In test environments, do not use actual payment connections.

   • Gift Card Processor: for live locations, select a processor configured at the environment level.
   • Wallet Processor: for live locations with Digital Wallet enabled, select a processor configured at the environment level.
   • Pay On Account Processor: for live locations with Payment on Account enabled, select a processor configured at the environment level.
   • Store Safe: shown only for active locations. Select the device designated to hold cash (physical safe or a register tagged Eligible as Safe). Register devices in the InStore colleague app first.
   • Parameter Set: select the parameter set if it differs from the environment.
     You cannot override parameters marked immutable at the environment level.

   • Template Set: select the receipt template set if it differs from the environment.
   • Language: select a supported language. This language displays when users log in at this location.
     To use receipts in another language, select the translated template set in Template Set. See Receipt template sets.
   • Location Description: text shown on the Locations page and available for receipts.
   • Address: (optional) address shown on receipts.
     The country is inferred from the Locale setting at the environment level.

   • Telephone Number: phone number for receipts. Include country code if needed (for example, +44). No formatting rules are applied.
4. Click Save Changes. The location is created but not yet activated.

New location activation

After creating a location, activate it in the InStore colleague app.

Prerequisites

• Login credentials for the relevant environment's InStore colleague app
• A role with the DeviceManagement permission

Activate a location

1. Go to the InStore colleague app URL for the relevant environment.

   Use 01 as the workstation component in the URL the first time you log in.

   If you cannot log in, check the InStore colleague app user record. It must include test_key, connection_key, tenant_id, user_name, password, and role. Review integration server logs for mismatches.
2. On the Enter Credentials page, enter your User ID and Password.
3. Click Log In.
4. In the left menu, select Manage Devices, then register devices:
   • Register one or more printers.
   • Register one or more cash drawers. Complete the Connected Printer field by selecting a previously added printer.
   • Register one or more workstations. Complete the Default Printer and Default Cash Drawer fields.
   • (Optional) Register scanners.
   • (Optional) Register PEDs.
   • Register a safe. For more information, see Add the safe to the InStore Center.
5. Click ACTIVATE LOCATION.
   If the ACTIVATE LOCATION button is not available, check that previous settings are valid.
6. Click DONE.

7. If necessary, log in again using the new Workstation ID in the URL. Additional menu options may appear based on your role.

Add the safe to the InStore Center

1. Go to the InStore Center.
2. On the left-hand navigation menu, click Locations.
3. Click the Edit icon for the location.
4. In the Store Safe field, select the name of the safe you added in the InStore colleague app.
5. Click SAVE CHANGES.