Skip to main content

Configure a New Store

This guide walks through bringing a new store online for My-Scan. Most of the work happens in platform services that own store identity and device registration — this page links to those rather than repeating them, and focuses on the My-Scan-specific configuration step.

This guide describes the Cloud host environment — see Architecture for how OnPrem differs. OnPrem stores are managed directly against the in-store Business Server rather than the Business Unit Management API and CCC.

1. Create the business unit​

A store is a business unit in Hii Retail terms. Create it via the Business Unit Management API — see Business Units & Business Unit Groups for the concept and API. If several stores should share configuration, assortment, or pricing, consider adding the business unit to a business unit group instead of configuring each store individually.

2. Register the store's workstations​

Any workstation (handheld, mobile checkout terminal, etc.) that will use My-Scan at this store needs to exist as a Device in OCMS before store-level configuration can target it — CCC's Config Target model builds workstation targets directly from OCMS devices. Register the store's workstations under your OCMS template before continuing.

3. Set My-Scan's store-level configuration​

With the business unit created and its workstations registered, set the values My-Scan reads for this store:

  • CCC business-unit-scoped settings — e.g. the dynamic EOT config kind mys.eot-settings.v1. See Configuration: Store Configuration for how these are resolved and how inheritance from the tenant/business-unit-group falls through if you don't set a store-specific value.
  • Business-unit-scoped parameters — GET v3/business-units/{businessUnitId}/parameters returns the parameters currently in effect for the store (see Configuration: Parameters).

If the store doesn't need anything different from the tenant default, you can skip this step entirely — inheritance means it will pick up the tenant-level (or business-unit-group-level) value automatically.

4. Verify​

Confirm the store resolves correctly before going live:

  • GET v3/business-units/{businessUnitId}/parameters — check the returned parameters match what you expect for this store.
  • Create a test basket with businessUnitId set to the new store (see Quick Start) and confirm it succeeds.

Reference​