SDK Functionality

The Pensa library is a lightweight SDK that simplifies interactions through straightforward method calls. This SDK enables you to:

• Locate stores: Easily find the stores you're looking for.

• Access stores directly: Use global store IDs to access a specific store and initiate a scan directly.

• View store history: Conveniently access a list of previously visited stores.

• Monitor scan uploads: Track the upload status of your scans.

Before using the SDK methods below, make sure to import the required functions:

import {
  showShelfScans,
  showProductScans,
  showStoreSearchView,
  showStoresScreen,
  showScanArea,
  showStockingScreen,
  showStoreChecklist,
  fetchScanStatuses,
  fetchOnDemandReports,
  fetchProductImageBase64,
  fetchShelves,
  PensaReportType,
} from 'pensa-sdk-react-native';

Searching Stores

To initiate a store search using the Pensa SDK, integrate the following code snippet:

showStoreSearchView()
  .catch((error) => {
    console.log('Error displaying search store:', error);
  });

This will present a search interface where you can input keywords (e.g., store name, location) to find the desired store. Upon selecting a store from the search results, the SDK will automatically redirect you to that store's details, allowing you to begin a scan.

The entered keyword must be at least 3 characters long.

Accessing Stores Directly with Global Store IDs

The Pensa SDK lets you directly access a store and initiate a scan using its global store ID. To do this, use the showStoreChecklist method:

showStoreChecklist('example-id')
  .catch((error) => {
    console.log('Error displaying store:', error);
  });

Sending Custom Parameters with Scans

In addition to using global store IDs, the Pensa SDK allows you to send custom parameters along with your scans. This can be useful for including company-specific information or metadata.

To send custom parameters, use the sectionKey and guid parameters in the showStoreChecklist method.

It's important to note that both sectionKey and guid must be used together. If either parameter is missing, the SDK will only consider the globalStoreId.

showStoreChecklist('example-id', 'example-guid', 'example-section')
  .catch((error) => {
    console.log('Error displaying store:', error);
  });

Recently Visited Stores

The Pensa SDK maintains a cache of recently visited stores for easy access and reuse. This allows you to quickly return to a previously scanned store without searching for it again.

Adding Stores to the Cache

A store is automatically added to the "Recently Visited Stores" cache when you:

• Use the showStoreChecklist() method to access a store.

• Select a store from the search results after using showStoreSearchView().

Accessing Recently Visited Stores

To display the "Recently Visited Stores" screen, use the following code:

showStoresScreen()
  .catch((error) => {
    console.log('Error displaying recently visited stores:', error);
  });

This will present a screen listing the recently visited stores. You can select a store from this screen to access its details and initiate a new scan.

Monitoring Scan Uploads

The Pensa SDK provides convenient methods to monitor the progress of your scan uploads. There are two separate methods depending on the type of scan:

Shelf Scans

To monitor shelf scan uploads, use the following method:

showShelfScans()
  .catch((error) => {
    console.log('Error displaying shelf uploads:', error);
  });

Product Scans

showProductScans()
  .catch((error) => {
    console.log('Error displaying product uploads:', error);
  });

Both methods present a screen that displays the status of each scan upload. You can use these screens to:

• Track upload progress: Observe the progress of ongoing uploads.

• View completed uploads: See a history of successfully uploaded scans.

• Cancel uploads: Stop the upload of any scan that is in progress.

These features give you complete control over your scan uploads and ensure you're always informed about their status.

Stocking Screen

The Pensa SDK allows you to access the stocking screen. This screen is used to review and manage stock actions related to the selected store.

showStockingScreen()
  .catch((error) => {
    console.log('Error displaying stocking screen:', error);
  });

Scan Area

To directly open a scan area, you must provide a scanId and either a storeId or a globalStoreId.:

showScanArea(scanId, storeId, globalStoreId)
  .catch((error) => {
    console.log('Error displaying scan area:', error);
  });

This method allows you to navigate directly to a scan area without going through the store selection flow.

Fetch APIs

This section documents the programmatic fetch APIs exposed by the Pensa React Native SDK. These methods allow you to retrieve SDK data directly from your app.

All examples below assume that: initPensa(...) has been called successfully, and isPensaStarted() returns true.

---

Fetch scan statuses

Method

function fetchScanStatuses(scanIds: number[]): Promise<PensaScanStatus[]>

Use this method to query the processing status and basic metadata for one or more scans.

Parameters

• scanIds: List of scan IDs to query.

Example usage

fetchScanStatuses([1234, 4567])
  .then((statuses) => {
    statuses.forEach((status) => {
      console.log(`Scan ${status.id} status: ${status.status ?? 'UNKNOWN'}`);
      console.log(`Fast status: ${status.fastStatus ?? 'N/A'}`);
      console.log(`Scan GUID: ${status.metadata?.guid ?? 'N/A'}`);
    });
  })
  .catch((error) => {
    console.log('Failed to fetch scan statuses:', error);
  });

---

Fetch on-demand reports

Method

function fetchOnDemandReports(
  scanId: number,
  projectId?: number,
  reportTypes?: PensaReportType[]
): Promise<PensaOnDemandReport>

Use this method to fetch on-demand analytical reports for a given scan.

Parameters

• scanId: ID of the scan to fetch reports for.

• projectId: Optional project ID.

• reportTypes: Optional list of requested report types. If not provided, ITEMS_SEEN is used.

Example usage

fetchOnDemandReports(43049, undefined, [
  PensaReportType.ITEMS_SEEN,
  PensaReportType.FACINGS_SEEN,
])
  .then((report) => {
    const bucket = report.itemsSeen;
    if (bucket) {
      console.log(`Items seen count: ${bucket.productList.length}`);
      bucket.productList.forEach((product) => {
        console.log(
          `Product: ${product.product ?? 'N/A'} (UPC: ${product.upc ?? 'N/A'})`
        );
      });
    } else {
      console.log('No ITEMS_SEEN bucket available for this scan.');
    }
  })
  .catch((error) => {
    console.log('Failed to fetch on-demand reports:', error);
  });

---

Fetch product image as Base64

Method

function fetchProductImageBase64(productId: number): Promise<string>

This helper method downloads the default reference image for the given product and returns it as a Base64-encoded string.

Parameters

• productId: ID of the product whose reference image should be fetched.

Example usage

fetchProductImageBase64(1001)
  .then((base64) => {
    console.log('Base64 image length:', base64.length);
  })
  .catch((error) => {
    console.log('Failed to fetch product image:', error);
  });

---

Fetch shelves by global store ID

Method

function fetchShelves(globalStoreId: string): Promise<PensaShelfItem[]>

Use this method to fetch the shelf list for a store by using its global store ID (tdLinxCode).

Parameters

• globalStoreId: Global store ID (tdLinxCode) of the target store.

Model: PensaShelfItem

type PensaShelfItem = {
  id: number;
  name: string | null;
};

Field reference

• id: Shelf ID.

• name: Shelf name.

Example usage

fetchShelves('123')
  .then((shelves) => {
    console.log(`Shelf count: ${shelves.length}`);

    shelves.forEach((shelf) => {
      console.log(`Shelf id: ${shelf.id}`);
      console.log(`Shelf name: ${shelf.name ?? 'N/A'}`);
    });
  })
  .catch((error) => {
    console.log('Failed to fetch shelves:', error);
  });