Postman Collection
Test and integrate the Tracepos Public REST API quickly using our official, pre-configured Postman Collection.
The collection covers all 19 public endpoints with pre-built request headers, parameter schemas, and realistic request body examples for retail, inventory, and accounting workflows.
Download Collection
- File:
tracepos-public-api.json - Format: Postman Collection v2.1.0
- Direct Raw Link:
/tracepos-public-api.json
How to Import into Postman
Option A: Import Local JSON File
- Click the Download button above to save
tracepos-public-api.jsonto your computer. - Open the Postman desktop application or web app.
- Click the Import button in the top-left corner of your workspace.
- Drag and drop the downloaded
tracepos-public-api.jsonfile into the dialog, or click files to select it. - Click Import. The collection
Tracepos Public API (v1)will appear in your left sidebar.
Option B: Import via URL
- In Postman, click Import in the top-left sidebar.
- Select the Link or URL tab.
- Paste the direct URL:
https://app.tracepos.net/docs/tracepos-public-api.json - Click Continue → Import.
Configuring Collection Variables
The collection uses Postman variables to dynamically authenticate every request without having to re-enter headers manually.
- Click on the root Tracepos Public API (v1) collection in your left sidebar.
- Select the Variables tab.
- Update the
Current Valuecolumn for your warehouse credentials:
| Variable | Description | Default Value | Example Value |
|---|---|---|---|
baseUrl | Public API endpoint root | https://app.tracepos.net/api/v1/public | https://app.tracepos.net/api/v1/public |
publicKey | Your warehouse Public Key | YOUR_PUBLIC_KEY | Trp-pk-9f8a12bc4d5e... |
secretKey | Your warehouse Secret Key | YOUR_SECRET_KEY | Trp-sk-7e2a91b4c3d2... |
[!TIP] Authentication Inheritance Every request inside the collection automatically includes the required headers:
X-Tracepos-Public-Key:{{publicKey}}X-Tracepos-Secret-Key:{{secretKey}}Accept:application/jsonImportant Security & Scope Notice:
- Ensure your test API key has been provisioned with the appropriate scopes:
read(for GET requests),write(for customer/supplier/sale/purchase/payment/expense creation), andinventory(for stock and price adjustments). Lacking a required scope returns HTTP403.- Any invalid, expired, or inactive key pair will return uniform HTTP
401 {"status": "error", "message": "Invalid API credentials."}.- Per-key rate limiting defaults to 60 requests per minute (HTTP
429).
- Click Save (
Ctrl + SorCmd + S).
Collection Contents & Organization
The collection is organized into 8 logical modules matching the API specification:
Tracepos Public API (v1)
├── 1. Catalog & Outlets
│ ├── List Products (supports limit & page)
│ ├── List Products by Category (category_id filter)
│ ├── Get Single Product
│ ├── List Categories (with child departments)
│ ├── Get Single Category
│ ├── List Brands
│ ├── Get Single Brand
│ ├── List Warehouses (company outlets)
│ └── Get Single Warehouse
├── 2. Inventory & Pricing
│ ├── List Stock Adjustments
│ ├── Get Single Stock Adjustment
│ ├── Record Stock Adjustment (add / subtract)
│ ├── List Price Adjustments
│ ├── Get Single Price Adjustment
│ └── Update Product Price (new_sales_price)
├── 3. Parties & CRM
│ ├── List Customers (with balance & credit limit)
│ ├── Get Single Customer
│ ├── Create Customer
│ ├── List Suppliers (with credit period)
│ ├── Get Single Supplier
│ └── Create Supplier
├── 4. Sales & Transactions
│ ├── List Sales Orders (date range & limit)
│ ├── Get Single Sale Order
│ └── Create Sale (POS Checkout with item array & payments)
├── 5. Purchases & Procurement
│ ├── List Purchases
│ ├── Get Single Purchase Order
│ └── Create Purchase (Stock Inward Intake)
├── 6. Payments & Settlements
│ ├── List Payment Modes (cash, bank, POS card)
│ ├── List Payments
│ ├── Discover Unpaid Invoices (user-invoices filter)
│ ├── List Customer & Supplier Directory
│ └── Record Payment & Settle Invoices (multi-invoice matching)
├── 7. Expense Management
│ ├── List Expense Categories
│ ├── List Expenses
│ ├── Record Expense
│ └── Pay Off Due Expense
└── 8. Returns & Reversals
├── List Sales Returns
├── Record Sales Return (customer return)
├── List Purchase Returns
└── Record Purchase Return (vendor return)
Quick Testing Workflow
Follow this sequence to test end-to-end integration:
1. Test Authentication
Run 1. Catalog & Outlets → List Warehouses.
- Expected Status:
200 OK - Verifies that both
publicKeyandsecretKeyare valid and authorized.
2. Discover Catalog & Payment Methods
- Run 1. Catalog & Outlets → List Products — copy a product's
xidto yourproduct_xidvariable. - Run 6. Payments & Settlements → List Payment Modes — copy a payment mode's
xidtopayment_mode_xid. - Run 3. Parties & CRM → List Customers — copy a customer's
xidtocustomer_xid.
3. Execute a Test Checkout
Run 4. Sales & Transactions → Create Sale (POS Checkout).
- Expected Status:
200 OK - Response: Returns
order_xid, invoice number, total amount, and confirmation of automated double-entry ledger posting and stock decrement.
