DEVELOPER RESOURCES

API Reference

Integrate JewelTag's luxury inventory engine into your custom applications, POS systems, and e-commerce platforms.

Version: v1.0.0
Last Updated: May 4, 2026
Authentication Endpoints Webhooks Rate Limits

Authentication

All API requests must include your Bearer Token in the Authorization header. Get your API key →

HTTP Request
POST /api/v1/auth/token
Headers:
Content-Type: application/json
Body:
{
  "api_key": "your_api_key_here",
  "api_secret": "your_api_secret_here"
}

Success Response (200 OK)

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600
}

Using Your Token

Include the token in all subsequent requests:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Base URL:

https://api.jeweltag.us/v1

API Endpoints

GET

Retrieve Inventory

/api/v1/inventory

Query Parameters

  • limit Max items per page (default: 50, max: 200)
  • offset Pagination offset (default: 0)
  • category Filter by product category
  • status Filter by status (active, sold, repair)

Example Request

curl -X GET "https://api.jeweltag.us/v1/inventory?limit=10&status=active" \
  -H "Authorization: Bearer YOUR_TOKEN"
GET

Get Single Inventory Item

/api/v1/inventory/{id}

Example Response

{
  "id": "JWL-12345",
  "sku": "DIA-001",
  "name": "Tiffany Diamond Ring",
  "category": "rings",
  "price": 12499.99,
  "certification": "GIA",
  "cert_number": "GIA-123456789",
  "status": "active",
  "created_at": "2026-01-15T10:30:00Z"
}
POST

Create Inventory Item

/api/v1/inventory

Request Body

{
  "sku": "DIA-002",
  "name": "Emerald Pendant",
  "category": "pendants",
  "price": 8499.99,
  "cost": 4200.00,
  "supplier_id": "SUP-789",
  "certification": "IGI",
  "description": "18K gold emerald pendant with diamonds"
}
PUT

Update Inventory Item

/api/v1/inventory/{id}
DELETE

Delete Inventory Item

/api/v1/inventory/{id}
GET

Get Sales Transactions

/api/v1/transactions
GET

Get Customers

/api/v1/customers

Webhooks

Receive real-time notifications for inventory changes, sales, and customer events.

Available Events

  • inventory.created
  • inventory.updated
  • inventory.sold
  • transaction.completed
  • customer.created

Register Webhook

POST /api/v1/webhooks 
{
  "url": "https://your-domain.com/webhook",
  "events": ["inventory.sold", "transaction.completed"]
}

Rate Limits

Plan Rate Limit Burst Limit
Essential100 requests/min200 requests
Professional500 requests/min1000 requests
EnterpriseCustomCustom

Rate limit headers are included in every response: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

Error Handling

Status Code Description
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient permissions
404Not Found - Resource doesn't exist
429Too Many Requests - Rate limit exceeded
500Internal Server Error

Ready to start building?

Get your API keys from your account dashboard.

Go to API Settings

Official SDKs

JavaScript Python Java PHP Ruby

Developer Support

Have questions about integrating with JewelTag? Our developer support team is here to help.

dev@jeweltag.us Full Documentation API Status