Skip to main content

Testing & Test Tenants

This guide covers how to run the calls from Quick Start and the rest of the API against a test tenant instead of production.

This guide describes the Cloud host environment — see Architecture for how OnPrem differs. Test tenants are a Cloud/multi-tenant concept; OnPrem is deployed single-tenant per retailer, so testing there means a separate OnPrem deployment/environment rather than a test tenant.

Test tenants

Hii Retail's test-tenant mechanism is platform-wide — see Test Tenants for the full concept. The key points that apply to My-Scan:

  • Your test tenant's ID is always {tenantId}test — for tenant qwerty123456789, the test tenant is qwerty123456789test.
  • API calls go to the retailsvc-test.com domain instead of retailsvc.com.
  • A bearer token issued for your production tenant will not work against your test tenant, and vice versa — get a token scoped to the test tenant.
  • Test tenants are created and managed by the IAM team, not self-service.

Running My-Scan calls against a test tenant

The request shapes are identical to Quick Start — only the host and credentials change:

Authorization: Bearer <test-tenant-token>
Tenant-Id: <tenantId>test
Content-Type: application/json

Point requests at the retailsvc-test.com-domain host for My-Scan instead of the production one. As with production, the businessUnitId you pass when creating a basket must already exist in the test tenant — if it doesn't, create it first (see Configure a New Store).

Browsing test-tenant data

My-Scan's test/staging environment is reachable through the Testrunner environment of the Hii Retail Console (https://testrunner.hiiretail.com/) — the test-environment counterpart to the production landing page referenced throughout Operations (e.g. for Customer Management Portal and SSA dashboards).

Reference

  • Test Tenants — the platform-wide mechanism this guide builds on.
  • Quick Start — the calls to run against your test tenant.