LiteShoper API — Full Guide

On this page

• Overview
• Installation
• API keys
• Endpoints
• Examples
• OpenAPI docs
• Security
• Troubleshooting

Overview

LiteShoper API (liteshop-api) exposes read-only REST endpoints for products, orders, and inventory. Connect ERP, warehouse systems, mobile apps, or custom dashboards.

Installation

Install with marketplace license. Admin menu: System → Developers → API Keys.

API keys

1. Go to API → Keys (/admin/api/keys).
2. Click create — enter name and select scopes:

• products:read
• orders:read
• inventory:read

Copy the key immediately — format ls_live_… — shown only once.

Authenticate with header: X-API-Key: ls_live_your_key_here

Endpoints

Examples

curl -H "X-API-Key: ls_live_xxx" \
  https://your-store.com/api/v1/products

curl -H "X-API-Key: ls_live_xxx" \
  "https://your-store.com/api/v1/orders?status=confirmed"

OpenAPI docs

• Interactive docs: https://your-store.com/api/docs
• OpenAPI JSON: https://your-store.com/api/openapi.json
• Admin reference: API → Documentation

Security

• Read-only by design — safer for integrations
• Revoke compromised keys immediately
• Use minimum scopes needed
• Never expose keys in frontend JavaScript

Troubleshooting

• 401 Unauthorized — missing/invalid key or revoked
• 403 Forbidden — key lacks required scope
• Key name required — fill name when creating