NShree Jewellery Shop API

Fast, secure, and beautiful endpoints

v1.3.0
For Developers • REST API

Design-grade API for your Jewellery Shop backend

Manage products, variants, inventory, orders, customers and beautifully crafted metadata for gemstones — all via a simple REST interface.

Product-first

Create products with images, SKU, metal, gemstone, and rich descriptions.

Inventory & Orders

Stock management, single-stock and multi-variant support, plus order lifecycle hooks.

Secure

API Key / Bearer token auth, CORS-safe, rate-limited endpoints.

Getting started

Authenticate with an API Key (recommended) — set header Authorization: Bearer <API_KEY>. For protected admin routes use scoped tokens.

Quick start (JavaScript)

// Quick fetch example
fetch('http://localhost:2005/v1/products', {
  headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
})
  .then(r => r.json())
  .then(console.log)
  .catch(e => console.error(e))

Create product (multipart/form-data)

// curl example (images)
curl -X POST "http://localhost:2005/v1/products" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "name=Artisan Necklace" \
  -F "price=499.00" \
  -F "sku=N-ART-001" \
  -F "metal=14k_gold" \
  -F "gemstone=emerald" \
  -F "images[]=@/path/necklace-front.jpg" \
  -F "images[]=@/path/necklace-back.jpg"

List products (filter & pagination)

GET /v1/products?limit=24&page=1&metal=14k_gold&minPrice=100&maxPrice=1000
Response: { data: [...], total: 120, page:1, limit:24 }

Advanced examples

Webhooks, bulk import, and image CDN support.

Bulk upload

POST /v1/products/bulk — upload CSV or JSON to create many SKUs at once.

Webhooks

Order.created, product.updated — HMAC signatures included for verification.

Image CDN

Serve resized images via /images/{id}?w=800&fit=cover — integrated with signed URLs.