Build powerful integrations with StackNex. RESTful API with webhooks for real-time event notifications.
API access: Professional (1,000 req/hr) | Enterprise (10,000 req/hr)
All API requests require authentication using an API key. Generate keys from Settings → Developers in your dashboard.
Include API key in Authorization: Bearer header
All requests must use HTTPS
Scope-based permissions for fine-grained access control
API Key Format
nxp_live_aBcDeFgHiJkL_1234567890abcdef...Keys starting with nxp_test_ are for sandbox environment
curl -X GET "https://stacknex.io/api/v1/products" \ -H "Authorization: Bearer nxp_live_aBcDeFgHiJkL_1234567890abcdef1234567890abcdef" \ -H "Content-Type: application/json"
RESTful endpoints for managing products, orders, customers, and inventory
Manage your product catalog
/api/v1/products/api/v1/products/api/v1/products/:id/api/v1/products/:id/api/v1/products/:idProcess and manage sales orders
/api/v1/orders/api/v1/orders/api/v1/orders/:id/api/v1/orders/:idCustomer management
/api/v1/customers/api/v1/customers/api/v1/customers/:id/api/v1/customers/:idProduct category management
/api/v1/categories/api/v1/categoriesStock and inventory control
/api/v1/inventory/api/v1/inventory/:idcurl -X POST "https://stacknex.io/api/v1/orders" \
-H "Authorization: Bearer nxp_live_aBcDeFgHiJkL_..." \
-H "Content-Type: application/json" \
-d '{
"locationId": "loc_abc123",
"items": [
{
"productId": "prod_xyz789",
"quantity": 2,
"unitPrice": 4.99
}
],
"paymentMethod": "cash"
}'{
"success": true,
"data": {
"id": "ord_abc123def456",
"orderNumber": "ORD-2024-0001",
"status": "completed",
"total": 9.98,
"items": [...],
"createdAt": "2024-01-15T10:30:00Z"
}
}Receive real-time notifications when events happen. Configure webhooks from Settings → Developers.
order.createdTriggered when a new order is placed
order.updatedTriggered when order details change
order.completedTriggered when order is marked complete
order.cancelledTriggered when order is cancelled
product.createdTriggered when a new product is added
product.updatedTriggered when product details change
product.deletedTriggered when a product is removed
customer.createdTriggered when a new customer registers
customer.updatedTriggered when customer info changes
inventory.lowTriggered when stock falls below threshold
inventory.updatedTriggered when stock levels change
{
"event": "order.created",
"timestamp": "2024-01-15T10:30:00Z",
"organizationId": "org_abc123",
"data": {
"id": "ord_xyz789",
"orderNumber": "ORD-2024-0001",
"total": 24.99,
"status": "completed"
}
}All webhooks are signed with HMAC-SHA256. Verify the signature using the X-Webhook-Signature header.
const crypto = require('crypto');
function verifyWebhook(payload, signature, secret) {
const expected = crypto
.createHmac('sha256', secret)
.update(payload)
.digest('hex');
return signature === expected;
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid product ID format",
"details": {
"field": "productId",
"expected": "UUID format"
}
}
}Rate Limiting: When you hit the rate limit, the response includes X-RateLimit-Reset header with the reset timestamp.
API access requires Professional or Enterprise plan
Go to Settings → Developers → Create API Key
Use your API key to authenticate requests
Get exclusive POS insights, industry trends, and product updates delivered to your inbox. No spam, ever.
By subscribing, you consent to receive marketing communications from StackNex. We respect your privacy and you can unsubscribe at any time. See our Privacy Policy.