BEEP! Node.js SDK

Official Node.js SDK for the BEEP! Developer API.

Installation

npm install @beep_technologies/node
# or copy this package into your project

Quick Start

const { BeepClient } = require('@beep_technologies/node');

// Use your Secret Key (bk_test_sk_... for sandbox, bk_live_sk_... for production)
const client = new BeepClient('bk_test_sk_YOUR_SECRET_KEY');

// List stores
const stores = await client.stores.list();

// Insert a product
const product = await client.catalog.insertProduct({
  storeId: 'your_store_id',
  ean: '4000000000001',
  name: 'Bio-Vollmilch 3,5%',
  brand: 'BioHof',
  price: 1.49,
  vat: 7,
});

Available Resources

| Resource | Methods | Min. Package | |----------|---------|-------------| | client.stores | list(), get(), register() | DISCOVER | | client.catalog | insertProduct(), listProducts(), getProduct(), registerToStore(), bulkImport() | DISCOVER | | client.offers | create(), update(), delete(), list() | GO | | client.clickCollect | submitOrder(), updateStatus() | GO | | client.loyalty | createProgram(), enroll(), addPoints(), redeemPoints(), getCustomerBalance(), getAnalytics(), syncExternal() | GO | | client.scanAndGo | checkIn(), startCheckout(), getPurchase(), getPurchaseHistory(), generateReceipt(), getReceiptFromToken(), getRecommendations(), configureRecommendations() | GROW | | client.integrations | syncPOS(), pushToPOS(), syncERP(), pushToERP(), configurePSP(), processPayment(), refundPayment() | GROW | | client.analytics | get(), exportSales(), exportReceipts() | GO / GROW |

Error Handling

const { BeepClient, AuthenticationError, PermissionError, RateLimitError } = require('@beep_technologies/node');

try {
  const result = await client.scanAndGo.checkIn({ storeId: 'store_001' });
} catch (err) {
  if (err instanceof AuthenticationError) {
    console.error('Invalid API key');
  } else if (err instanceof PermissionError) {
    console.error(`Upgrade required: ${err.details?.requiredUpgrade}`);
  } else if (err instanceof RateLimitError) {
    console.error(`Rate limited. Retry after ${err.retryAfter}s`);
  }
}

TypeScript Support

Full TypeScript definitions are included. Import types directly:

import { BeepClient, Store, Product, Offer } from '@beep_technologies/node';

Documentation

• Quickstart Guide
• API Reference
• Error Codes