# merchmix-android-app

An Android application for the Merchmix Core product. The repository builds and packages a mobile app, includes Android resources and launcher shortcuts for scan, search, and Today, and contains integration points for Merchmix production APIs and a forecast service. The available evidence does not establish the full set of implemented screens or business workflows.

## Business Summary

This is Merchmix’s mobile app for accessing core retail-planning information on Android. It appears to support a Today view and forecast-related data, with quick actions for scanning and searching, but the available repository evidence is not sufficient to describe the complete retailer experience.

## Capabilities

| Capability | Category | Status | Access | Exposure |
|---|---|---|---|---|
| Forecasting | Forecasting | `partial` | `read` | user_facing |
| Mobile Merchandise Information Access | Other | `partial` | `read` | user_facing |
| Production API Integration | Other | `partial` | `read` | user_facing, internal |
| Android Application Distribution | Other | `production` | `execute` | internal |

**Forecasting** — Provides mobile access to forecast-related information used in the Merchmix Core experience, including the Today view.

**Mobile Merchandise Information Access** — Lets retail users access Merchmix information from an Android device through mobile views and quick actions.

**Production API Integration** — Retrieves Merchmix data from backend services for use in the mobile application.

**Android Application Distribution** — Produces installable Android builds for development and release distribution.

## Workflows

**View forecast and Today information** — A mobile user opens the Today or forecast-related experience to retrieve current Merchmix information.

1. Launch the Android application or use the Today launcher shortcut.
2. Authenticate against the applicable Merchmix backend if required.
3. Request forecast/Today data from the backend services.
4. Display the returned information in the mobile application.

**Build and release the Android application** — CI validates and packages the Android application, with tagged builds optionally producing signed release artifacts.

1. Run lint and unit tests.
2. Build the debug application for normal branch and pull-request pipelines.
3. For a v* tag, configure release signing credentials when a signed artifact is required.
4. Build and publish the release AAB/APK as a pipeline artifact.

## Architecture

Native Android application packaged with Gradle. The app communicates with Merchmix backend APIs, including a forecast service, and includes Android resources, launcher shortcuts, Firebase configuration, and CI/CD build automation.

**Components:** Android application module under app/, Android manifest and packaged UI resources, Gradle build and dependency configuration, API integration layer referenced by ApiService.kt, Firebase/Google services configuration, Bitbucket Pipelines CI/CD

**Patterns:** Native Android application structure, Gradle-based build, Authenticated HTTP/API integration, Resource-based Android UI and launcher shortcuts, Automated lint, unit-test, and artifact-build pipeline

## Interfaces

| Kind | Identifier | Description |
|---|---|---|
| `other` | `Android application` | Installable Android application with launcher icons and shortcuts for scan, search, and Today. |
| `http` | `Merchmix production APIs` | Backend API integration used by the app; the supplied evidence does not provide route names or a formal API specification. |
| `http` | `Forecast service API` | Forecast API used by Predict/Today functionality and authenticated with a forecast API key. |
| `cli` | `Gradle wrapper` | gradlew and gradlew.bat provide the build and test command-line interface. |

## Screens

| Route | Name | Purpose |
|---|---|---|
| `Today launcher shortcut` | Today | Quick entry point to the app’s Today experience, which is associated with forecast API calls. |
| `Scan launcher shortcut` | Scan | Quick entry point labelled for scanning; the exact scanned object and resulting workflow are not established. |
| `Search launcher shortcut` | Search | Quick entry point labelled for search; the searchable data and result behavior are not established. |

## Data

| Entity | Ownership | Description |
|---|---|---|
| Forecast and Today data | `reads` | Forecast-related information retrieved for the mobile Predict/Today experience. |
| Authenticated API session credentials | `reads` | Client and access/refresh tokens used by live API integration tests and, by implication, authenticated backend access. Secret values are not included. |
| Application configuration | `owns` | Android and Google/Firebase application configuration packaged or referenced by the app. |

## Dependencies

| Name | Kind | Relationship | Criticality |
|---|---|---|---|
| Merchmix production APIs | `internal_service` | `calls` | `critical` |
| Forecast service | `internal_service` | `calls` | `critical` |
| Firebase/Google services | `external_service` | `uses` | `supporting` |
| Android SDK and Gradle | `library` | `depends_on` | `critical` |
| Bitbucket Pipelines | `other` | `uses` | `supporting` |

## Technology

Android, Gradle, Gradle Kotlin DSL, Android SDK, Bitbucket Pipelines, Firebase/Google Services configuration

## Limitations

- The supplied evidence does not include a complete source-file listing, so the actual UI, API clients, domain models, and business rules cannot be fully assessed.
- No API route names, schemas, backend ownership boundaries, or network library are established.
- Scan and search are evidenced only by launcher shortcut resources; their business meaning and implementation are unknown.
- The evidence does not establish support for WSSI, OTB, Range Planning, Size Curve, Markdown, Allocation, Replenishment, Option Planning, Buying, or Assortment Planning workflows.
- The CI configuration documents live production integration tests, but this repository should not be treated as a safe environment for executing them without the explicit opt-in and production-safety precautions described there.
- The repository contains google-services.json and the pipeline references secret configuration, but secret values and their contents are intentionally not described.

## Agent Instructions

Treat this repository as the Android client for Merchmix Core, with confirmed forecast/Today API integration and build/distribution responsibilities, but do not assume broader merchandise-planning capabilities without source evidence.

- Route Android build, packaging, launcher, or mobile UI questions here.
- Route forecast or Today mobile-access questions here when the request concerns the Android client; distinguish this from ownership of forecast calculations, which is not established.
- Do not claim that the app implements specific planning domains such as OTB, allocation, or replenishment based only on the product name.
- Do not run live API integration tests against production unless the explicit instrumentation opt-in is intentionally provided and the caller has confirmed the production-risk controls.
- Do not request, expose, or infer values for API keys, tokens, keystores, or signing passwords.

## Source

| Field | Value |
|---|---|
| Repository | `merchmix-android-app` |
| Branch | `main` |
| Commit | `68dddbcde699` |
| Generated by | `gpt-5.6-luna` |

*Generated by the Merchmix Skills Platform from the current codebase.*