ondc-seller

Files (5)

• SKILL.md
• README.md · references/
• check-status.ts · scripts/
• generate-keys.ts · scripts/
• register.ts · scripts/

SKILL.md (first lines)

# ONDC Seller Skill

This skill helps you deploy and manage ONDC (Open Network for Digital Commerce) seller applications. ONDC is India's digital commerce network enabling sellers to reach buyers across multiple platforms.

## What This Skill Does

- **Deploy ONDC Seller Apps**: Set up the complete seller reference application
- **Catalog Management**: Manage products, stores, inventory, and pricing
- **Order Processing**: Handle search, select, init, confirm, status, update, and cancel flows
- **Logistics Integration**: Connect with logistics providers for fulfillment
- **IGM Support**: Manage Issue & Grievance Management for customer complaints
- **Registry Operations**: Register with ONDC staging/production networks

## Architecture Overview

The ONDC Seller App uses microservice architecture:
- **seller-app**: Node.js backend API layer
- **seller-app-frontend**: React web application (served via nginx)
- **seller-app-protocol**: Python protocol layer for ONDC communication
- **seller-app-igm**: Node.js IGM service for issue management
- **seller-bugzilla-service**: Bugzilla integration for ticket management

## Prerequisites

Before using this skill, ensure you have:

1. **Docker & Docker Compose** installed
2. **Git** with submodule support
3. **Domain name** or ngrok for public endpoint
4. **Required service accounts**:
   - Firebase (authentication)
   - SMTP server (email notifications)
   - AWS S3 (asset storage)
   - Map My India (location services)
5. **ONDC Registry Access** (for production deployment)

## Quick Start

### 1. Clone and Initialize

```bash
cd /home/workspace
git clone https://github.com/ONDC-Official/seller-app-sdk.git ondc-seller-app
cd ondc-seller-app
git submodule init
git submodule update
```

### 2. Generate Cryptographic Keys

```bash
bun /home/workspace/Skills/ondc-seller/scripts/generate-keys.ts
```

This creates signing and encryption keys required for ONDC registration.

### 3. Configure Environment

```bash
bun /home/workspace/Skills/ondc-seller/scripts/setup-env.ts \
  --domain "https://yourdomain.com" \
  --firebase-key "YOUR_KEY" \
  --smtp-host "smtp.example.com" \
  --s3-bucket "your-bucket"
```

### 4. Deploy Locally (Development)

```bash
cd /home/workspace/ondc-seller-app
docker-compose -f docker-compose-for-local.yaml --env-file .env-local up -d
```

### 5. Register with ONDC

Once deployed, use the registration helper:

```bash
bun /home/workspace/Skills/ondc-seller/scripts/register.ts \
  --subscriber-url "https://yourdomain.com" \
  --signing-key "path/to/signing_public.pem" \
  --crypto-key "path/to/crypto_public.pem"
```

## Common Operations

### Check Application Status

```bash
bun /home/workspace/Skills/ondc-seller/scripts/check-status.ts
```

Shows the status of all services (seller-app, frontend, protocol, IGM).

### Manage Catalog

```bash
# View catalog summary
bun /home/workspace/Skills/ondc-seller/scripts/manage-catalog.ts --action list

# Enable/disable store
bun /home/workspace/Skills/ondc-seller/scripts/manage-catalog.ts --action toggle-store --store-id "STORE123"

# Update item availability
bun /home/workspace/Skills/ondc-seller/scripts/manage-catalog.ts --action update-item --item-id "ITEM456" --available true
```

### View Orders

```bash
# List recent orders
bun /home/workspace/Skills/ondc-seller/scripts/view-orders.ts --limit 10

# Get order details
bun /home/workspace/Skills/ondc-seller/scripts/view-orders.ts --order-id "ORDER123"

# Filter by status
bun /home/workspace/Skills/ondc-seller/scripts/view-orders.ts --status "Pending"
```

From ankitjh4/indic-ai-skills, MIT.

More from ankitjh4/indic-ai-skills