Operations
Stock Management API — Endpoints
Complete endpoint reference for the Stock Management API. 21 endpoints across 7 groups.
Authentication (1)Health (1)Products (4)Reference Data (5)Suppliers (2)Stock Operations (4)Webhooks (4)
Authenticates using the API key and secret from the Infinity license file. Returns a JWT token valid for 1 hour. The Postman collection auto-saves the token to the accessToken variable.
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| apiKey | string | ✓ | API key from your Infinity license |
| apiSecret | string | ✓ | API secret from your Infinity license |
Responses
200Returns accessToken (JWT), tokenType: Bearer, and expiresIn: 3600
{
"accessToken": "eyJhbGciOiJIUzI1NiIs...",
"tokenType": "Bearer",
"expiresIn": 3600
}
401Invalid API key or secret
No authentication required. Returns service status and database connectivity.
Responses
200Returns status, database, uptime, and version
{
"status": "Healthy",
"database": "Connected",
"uptime": "1.02:15:30",
"version": "1.0.0"
}
Returns a paginated list of products with pricing, stock levels, barcodes, and supplier data.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| productType | query | int | Filter by product type (2 = Stock Product, 3 = Modifier) | |
| saleType | query | int | Filter by sale type flag (bitwise match) | |
| categoryId | query | string | Filter by category ID (nchar 10) | |
| isActive | query | bool | Filter by active status | |
| page | query | int | Page number (default: 1) | |
| pageSize | query | int | Items per page (default: 50, max: 200) |
Responses
200Returns paginated items array with full product details
{
"items": [
{
"productId": 105001050000123,
"productName": "Large Plush Bear",
"productDescription": "24 inch stuffed bear",
"categoryId": "PLUSH ",
"classId": "LGPLUSH ",
"taxGroup": "GST ",
"productType": 2,
"saleType": 1,
"orderPrinter": 0,
"secondaryProductName": "",
"ticketValue": 500,
"vendingPrice": 0,
"sellPrice": 9.99,
"isPriceExTax": false,
"productCode": "PLU-BEAR-LG",
"barcodes": [
"9781234567890"
],
"reorderLevelMin": 5,
"reorderLevelMax": 50,
"suppliers": [
{
"supplierId": 1,
"containerPrice": 25,
"containerQuantity": 10,
"containerId": 1,
"productSupplierCode": "SUP-BEAR",
"preferredSupplier": true
}
],
"warehouses": [
{
"warehouseId": 1,
"stockQuantity": 100,
"productEnabled": true,
"lastPurchasePrice": 2.5,
"averageUnitCost": 2.5
}
],
"isActive": true
}
],
"page": 1,
"pageSize": 50,
"totalCount": 150,
"totalPages": 3
}
401Missing or invalid Bearer Token
Returns a single product by its ID. Same shape as an item in the list response.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| productId | path | long | ✓ | Product ID |
Responses
200Returns full product object
{
"productId": 105001050000123,
"productName": "Large Plush Bear",
"productDescription": "24 inch stuffed bear",
"categoryId": "PLUSH ",
"classId": "LGPLUSH ",
"taxGroup": "GST ",
"productType": 2,
"saleType": 1,
"sellPrice": 9.99,
"productCode": "PLU-BEAR-LG",
"barcodes": [
"9781234567890"
],
"isActive": true
}
401Missing or invalid Bearer Token
404Product not found
Creates a new product across multiple database tables in a single transaction.
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| productName | string | ✓ | Max 50 characters |
| productDescription | string | ✓ | Max 50 characters |
| categoryId | string | ✓ | From GET /categories (nchar 10, space-padded) |
| classId | string | From GET /classes (nchar 10, space-padded) | |
| taxGroup | string | ✓ | From GET /tax-groups (nchar 10, space-padded) |
| productType | int | ✓ | 2 = Stock Product, 3 = Modifier |
| saleType | int | ✓ | Bitmask =Redemption, 2=Sale, 4=Vending (combine by adding) |
| orderPrinter | int | 0=None (default), 1=Printer 1, 2=Printer 2 | |
| secondaryProductName | string | Max 35 chars. Alternate/translated product name | |
| ticketValue | int | Ticket redemption cost. Required when saleType includes Redemption | |
| vendingPrice | decimal | Vending machine price. Required when saleType includes Vending | |
| sellPrice | decimal | Retail sell price. Required when saleType includes Sale | |
| isPriceExTax | bool | Whether sellPrice excludes tax. Default: false | |
| productCode | string | Max 50 chars. SKU or internal product code | |
| barcodes | string[] | Array of barcode strings, each max 25 chars | |
| reorderLevelMin | int | Minimum reorder level. Default: 0 | |
| reorderLevelMax | int | Maximum reorder level. Default: 0 | |
| supplier | object | Supplier link (supplierId, containerPrice, containerQuantity, containerId, productSupplierCode, preferredSupplier) | |
| warehouse | object | Initial warehouse stock (warehouseId, stockQuantity) |
Responses
201Returns productId and productCode
{
"productId": 105001050000123,
"productCode": "PLU-BEAR-LG"
}
400Validation error
401Missing or invalid Bearer Token
409Duplicate product name
Partial update — only include fields you want to change. Barcodes can only be added (not removed). Suppliers can be added, updated, or soft-deleted using the action field.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| productId | path | long | ✓ | Product ID |
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| productName | string | Max 50 characters | |
| productDescription | string | Max 50 characters | |
| sellPrice | decimal | Updated retail sell price | |
| isPriceExTax | bool | Whether sellPrice excludes tax | |
| productCode | string | Max 50 chars | |
| reorderLevelMin | int | Minimum reorder level | |
| reorderLevelMax | int | Maximum reorder level | |
| isActive | bool | Active status | |
| barcodes | string[] | Barcodes to add (cannot remove existing) | |
| suppliers | array | Supplier changes with action field: add | update | remove |
Responses
200Returns productId and productCode
{
"productId": 105001050000123,
"productCode": "PLU-BEAR-LG-V2"
}
400Validation error
401Missing or invalid Bearer Token
404Product not found
Returns all product categories for the local location.
Responses
200Returns array of categories with categoryId, description, taxGroup, glAccount
[
{
"categoryId": "PLUSH ",
"description": "Plush Toys",
"taxGroup": "GST ",
"glAccount": "4100"
}
]
401Missing or invalid Bearer Token
Returns all product classes. Optionally filter by category.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| categoryId | query | string | Filter by parent category ID |
Responses
200Returns array of classes with classId, categoryId, description, taxGroup
[
{
"classId": "LGPLUSH ",
"categoryId": "PLUSH ",
"description": "Large Plush",
"taxGroup": "GST "
}
]
401Missing or invalid Bearer Token
Returns all warehouses for the local location.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| locationId | query | int | Defaults to local location |
Responses
200Returns array of warehouses with warehouseId, description, type, department
[
{
"locationId": 10500,
"warehouseId": 1,
"warehouseDescription": "Main Warehouse",
"warehouseType": 1,
"department": "Redemption",
"isDeleted": false
}
]
401Missing or invalid Bearer Token
Returns tax groups for the local location's tax zone.
Responses
200Returns array of tax groups with taxGroup, taxZone, effectiveDate, tax rates
[
{
"taxGroup": "GST ",
"taxZone": 1,
"effectiveDate": "2020-01-01T00:00:00",
"tax1Rate": 0.1,
"tax1RateDescription": "GST",
"tax2Rate": 0,
"tax2RateDescription": "None"
}
]
401Missing or invalid Bearer Token
Returns container types for use in supplier product links (Product_Suppliers.Container_Id).
Responses
200Returns array of containers with containerId, description, isDeleted
[
{
"containerId": 1,
"description": "Each",
"isDeleted": false
}
]
401Missing or invalid Bearer Token
Returns all active suppliers.
Responses
200Returns array of supplier objects with contact, address, and payment details
[
{
"supplierId": 1,
"supplierCode": "SUP001",
"supplierName": "Acme Toys",
"supplierAddress": "123 Main St",
"supplierTown": "Sydney",
"supplierState": "NSW",
"supplierPostcode": "2000",
"supplierPhone": "0299991234",
"supplierEmail": "orders@acmetoys.com",
"supplierContact": "John Smith",
"supplierType": 1,
"supplierDescription": "Plush toy supplier",
"supplierApproved": false,
"supplierAccountNo": "ACC-001",
"paymentTerms": 5,
"isDeleted": false
}
]
401Missing or invalid Bearer Token
Creates a new supplier.
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| supplierCode | string | ✓ | Max 50 chars. Unique supplier code |
| supplierName | string | ✓ | Max 50 chars |
| supplierAddress | string | ✓ | Max 50 chars |
| supplierTown | string | Max 50 chars | |
| supplierState | string | Max 50 chars | |
| supplierPostcode | string | Max 50 chars | |
| supplierPhone | string | Max 50 chars | |
| supplierEmail | string | Max 50 chars | |
| supplierContact | string | Max 50 chars | |
| supplierType | int | Default: 0 | |
| supplierDescription | string | Max 50 chars | |
| supplierAccountNo | string | Max 50 chars | |
| paymentTerms | int | 0=None, 1=Advance, 2–8=days from delivery (7/14/21/30/45/60/90). Default: 0 |
Responses
201Returns supplierId, supplierCode, supplierName, createdAt
{
"supplierId": 2,
"supplierCode": "SUP002",
"supplierName": "Best Prizes",
"createdAt": "2026-03-25T12:00:00Z"
}
400Validation error
401Missing or invalid Bearer Token
Returns current stock levels, paginated.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| warehouseId | query | int | Filter by warehouse | |
| productIds | query | string | Comma-separated product IDs | |
| page | query | int | Page number (default: 1) | |
| pageSize | query | int | Items per page (default: 50, max: 200) |
Responses
200Returns paginated items array with productId, warehouseId, stockQuantity, reorderLevel, costs
{
"items": [
{
"productId": 105001050000123,
"warehouseId": 1,
"productName": "Large Plush Bear",
"stockQuantity": 100,
"productEnabled": true,
"reorderLevel": 0,
"lastPurchasePrice": 2.5,
"averageUnitCost": 2.5
}
],
"page": 1,
"pageSize": 50,
"totalCount": 100,
"totalPages": 2
}
401Missing or invalid Bearer Token
Submits counted quantities for a stock take. The system calculates the variance (counted minus current) and adjusts stock levels accordingly.
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| warehouseId | int | ✓ | From GET /warehouses |
| userId | int | ✓ | Infinity user ID for the ERP integration |
| items | array | ✓ | Array of { productId, countedQuantity } — countedQuantity must be >= 0 |
| comment | string | Max 200 chars. Recorded on the stock transaction |
Responses
200Returns saleInvoiceNo, itemCount, processedAt
{
"saleInvoiceNo": 12345,
"itemCount": 2,
"processedAt": "2026-03-25T12:00:00Z"
}
400Validation error
401Missing or invalid Bearer Token
Records incoming stock from a supplier. Increases stock quantities and recalculates average unit cost.
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| warehouseId | int | ✓ | From GET /warehouses |
| supplierId | long | From GET /suppliers | |
| poNumber | string | Purchase order number, max 50 chars | |
| invoice | string | Invoice number, max 50 chars | |
| userId | int | ✓ | Infinity user ID for the ERP integration |
| items | array | ✓ | Array of { productId, quantity, value } — quantity > 0; value updates last purchase price and average unit cost |
| comment | string | Max 200 chars |
Responses
200Returns saleInvoiceNo, itemCount, processedAt
{
"saleInvoiceNo": 12346,
"itemCount": 2,
"processedAt": "2026-03-25T12:00:00Z"
}
400Validation error
401Missing or invalid Bearer Token
Adjusts stock quantity up or down for a single product. Cannot result in negative stock.
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| warehouseId | int | ✓ | From GET /warehouses |
| productId | long | ✓ | Product ID |
| adjustmentQuantity | int | ✓ | Positive to increase, negative to decrease. Cannot result in negative stock |
| userId | int | ✓ | Infinity user ID for the ERP integration |
| comment | string | ✓ | Reason for adjustment, max 200 chars |
Responses
200Returns saleInvoiceNo, productId, newStockQuantity, processedAt
{
"saleInvoiceNo": 12347,
"productId": 105001050000123,
"newStockQuantity": 95,
"processedAt": "2026-03-25T12:00:00Z"
}
400Validation error or would result in negative stock
401Missing or invalid Bearer Token
404Product not found
Returns all active webhook subscribers.
Responses
200Returns array of webhook subscriber objects
401Missing or invalid Bearer Token
Register a webhook subscriber to receive stock event notifications. Events are triggered by Infinity application activity — not by API calls made through this API.
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| url | string | ✓ | HTTPS URL that will receive webhook POST requests |
| secret | string | ✓ | Min 16 characters. Used for HMAC-SHA256 payload signing. Stored encrypted at rest |
| eventTypes | string[] | ✓ | Array of event types: stock.adjusted | stock.received | stock.counted | product.created | product.updated |
Responses
201Returns webhookId, url, eventTypes, createdAt
{
"webhookId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"url": "https://your-erp-system.com/webhooks/infinity",
"eventTypes": [
"stock.adjusted",
"stock.received",
"stock.counted"
],
"createdAt": "2026-03-25T12:00:00Z"
}
400Validation error
401Missing or invalid Bearer Token
Update a webhook subscriber's URL, secret, or event types. All fields are optional.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| webhookId | path | string (UUID) | ✓ | Webhook subscriber ID |
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| url | string | New HTTPS URL | |
| secret | string | New secret, min 16 characters | |
| eventTypes | string[] | Updated array of event types to subscribe to |
Responses
200Returns webhookId, url, eventTypes, createdAt
{
"webhookId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"url": "https://new-url.com/webhook",
"eventTypes": [
"stock.adjusted"
],
"createdAt": "2026-03-25T12:00:00Z"
}
400Validation error
401Missing or invalid Bearer Token
404Webhook not found
Remove a webhook subscriber.
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| webhookId | path | string (UUID) | ✓ | Webhook subscriber ID |
Responses
204No Content — webhook deleted
401Missing or invalid Bearer Token
404Webhook not found