Environment

Environment setup

• If you have multiple environments, click Settings (gear icon) > Switch Environment to verify or change your current environment.
• In the InStore Center, select Environment. The labels next to the page title indicate the environment type, for example, Test and the status, for example, New.

General tab

1. Set the following fields:

   • Optional: For Label, rename the default label to a short name. It is used for switching environments. Only administrators see this label.

• Name: assign a unique name (for example, Wales-All).
• Description: describe the environment's purpose (for example, Test Environment for All Wales Locations).
• TaxId: enter the tax or VAT ID to print on receipts. Use sample data for test environments.
• Locale: select a default locale using ISO notation (for example en-US). This applies to all locations in the environment.
• Currency: select the currency for environment. After activation, you cannot change this value. Each environment supports one currency. Request additional environments for multiple currencies.
• Parameter Set: choose the default parameter set for locations and workstations (can be overridden for individual locations and workstations).
• Template Set: choose the default receipt template set (can be overridden for individual locations).

1. Click Save Changes to apply your settings.

Payment Processors tab

1. View the processors that have been registered for this environment, if any.
2. Optionally, click the icon to edit or delete a processor.
3. Optionally, click Add Payment Processor and complete these fields for a new processor:

• Processor: select a processor. If you choose Custom, define a connection for each payment type.
• Custom Processor Name: for Custom processors only. Enter a display name for administrators.
• Supported Payment Types: select from Credit Card, Gift Card, Wallet, Pay by Link, and Pay on Account.
• Timeout: for Custom processors only. Enter the response timeout in milliseconds. Default is 15000 (15 seconds). If specified, this value is passed in the processAsyncPostRequest calls in the creditProxyAPI of mist-client.
• Processor Key: for Adyen, Stripe, or Citcon processors only. Enter the test or production key provided by the processor vendor.
• Processor Verification Key: for each payment type, enter the vendor-provided key.
• Processor (Webhook) Url: for each payment type, enter the webhook URL where InStore should send the payment.
• Test/Production: for Adyen only. Indicate if this is a test or production configuration.
• Merchant ID: for Adyen, enter the retailer's credential.
  Never use production keys or credentials for testing.

1. Click Add to save the processor.
2. Click Activate Environment. If this option is not available for a new environment, verify that you have at least one processor listed and have set up at least one store role.
3. Click Confirm.

Project settings tab

Configure the connection to your Composable Commerce Project.

1. On the Environment tab > Project Settings, complete the following fields:

• Project Key: your Composable Commerce Project Key. This must be at least two characters long.
• Client Secret: enter the secret generated by Composable Commerce when creating the API Client.
  Save your Client Secret in a secure location. For security reasons, you will not be able to access it again from the InStore Center.
• Client ID: value from Composable Commerce project creation.
• Auth URL: value from Composable Commerce project creation.
• Host: the API URL for your project.
• Scopes: enter a comma-delimited list of scopes generated during Composable Commerce project creation. Do not use spaces or line breaks.
• Optional: for Cart Key Prefix, specify a prefix for the generated cart key (order number). Must be 1–6 alphanumeric characters.
  The Cart Key Prefix must be unique across all environments connected to the same commercetools project. Assign a distinct prefix per environment to avoid conflicts.
  • Cart Key Sequence Length: length of the transaction sequence number in the cart key (order number). Enter a value between 3 and 12, usually 6. The generated cart key conforms to Composable Commerce cart requirements.
    Modifying Cart Key Prefix or Cart Key Sequence Length may cause duplicate order numbers in future transactions.
  • InStore Order Type: key for the order type defined in your API.
  • InStore Lineitem Type: key for the line item type.
  • Customer Type: key for the customer type.
  • InStore Payment Type: key for the payment type.
  • Transaction Type: key for the transaction type.

1. Click Save Changes to update the settings.

Custom Fields tab

1. Enter the Attribute names for Barcode Array and Receipt Text. Ensure that these attributes exist on all Product Types and values are included on all Product Variants to be used in InStore implementations.
2. Review the list of required Attributes derived from your Composable Commerce project.
3. In the Custom Field column, verify or correct each corresponding field name in your InStore implementation. The options must match your Composable Commerce Project. See Mapping Custom Fields and Custom Fields reference.
4. Click Save Changes.

Integration settings tab

• Tenant ID: uniquely identifies the environment. Not editable.
• Connection Key: authorizes your store application and digital retail platform.

If the connection key is lost or compromised, generate a replacement and update your store application.

To generate a new key, do the following:

1. Go to the Environment menu.
2. In Integration Settings, click Generate New Connection Key.
3. Click Copy Key to Clipboard.
4. Click Save Changes to activate the new key. To cancel, navigate away without saving.

5. Save the key securely.

6. Configure the following settings, replacing * with your integration server URL. Webhook URL is the fully specified internet location where the InStore server will provide responses for your store application to retrieve:

1. For the Webhook API Key, enter the verification key or header token expected by your API gateway. This value is set on the Composable Commerce cart retrieval server where the x-api-key header sent from the InStore API server is validated (for example, in the /checkout/:cartId endpoint). You can only set or reset the key here; you cannot view it. For security purposes, this key is hidden from API responses.

Activate Environment

Allowed URLs tab

Add external domains allowed to interact with this InStore instance, including the URL for the InStore colleague app. This must match the URL you set in your integration server. To add the URL, do the following:

1. Enter an allowed URL.
2. Click Add Allowed URL.
3. Use the Actions icons to edit or delete URLs.

Theme tab

Customize the Responsive Material UI theme for InStore. You can brand the interface to make InStore better match the fonts and colors of your store application. To modify the theme, do the following:

1. In the Font Family field, select a font that is supported by the retailer's application.
2. Toggle the Header Visible on or off. Toggle it on to include a page title on components that are retrieved when needed by your calling app. To avoid duplicate headers, toggle this off if running InStore as a federated component in a point-of-sale context.
3. In the Colors fields, select main, secondary, and tertiary colors for online display, expressed as industry-standard RGB hex color codes. Color choices are visible in the Theme preview panes.
4. Click Save Changes. The changes are visible the next time a user logs into InStore.