Retrieves a list of all orders. Supports pagination and filtering by companyId.
Final POS API (1.2.4)
Welcome to the Final POS Public API—your playground for crafting the checkout and kiosk flows you want. Create your API keys in Manage (Settings > API Keys) and send them as x-api-key on every request. Customer endpoints use dynamic DTO generation so they adapt to your custom tables in real time, while the rest of the controllers follow a stable, static contract for predictable integrations.
Download OpenAPI description
Overview
License
Languages
Servers
Mock server
https://docs.finalpos.com/_mock/openapi
Official API
https://api.finalpos.com
- Mock serverhttps://docs.finalpos.com/_mock/openapi/v1/api/orders
- Official APIhttps://api.finalpos.com/v1/api/orders
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.finalpos.com/_mock/openapi/v1/api/orders?skip=0&limit=0' \
-H 'x-api-key: YOUR_API_KEY_HERE'Successfully retrieved a list of orders
Timestamp when the Order was created.
Example: "2025-12-07T19:31:48.436+00:00"
Timestamp when the Order was last updated.
Example: "2025-12-07T19:35:48.436+00:00"
External ID associated with the Order when synced from external source. If present, it will set fromFinal to true.
Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
When the order is parked, the stock will be reduced by this amount. If 0, the stock will not be reduced.
Example: "0"
Summary of the Order.
Example: {"discountTotal":"1000.50","shippingTotal":"1000.50","total":"1000.50","totalTaxes":"1000.50","isTaxInclusive":false,"subTotal":"1000.50","taxes":[{"name":"Tax 1","percentage":10,"amount":"1000.50","taxTableName":"Tax Table 1","compounding":true,"priority":1,"taxTableId":"1234567890","id":"1234567890"}],"tip":{"percentage":0.15,"amount":"1000.50"}}
Cart discount of the Order.
Example: {"label":"Cart Discount 1","amount":"1000.50","percentage":0.15}
Cart fees of the Order.
Example: [{"id":"1234567890","label":"Cart Fee 1","amount":"1000.50","percentage":0.15,"taxName":"Tax 1","taxTableId":"1234567890","tax":"1.10"}]
POS data of the order.
Example: {"outlet":"1234567890","station":"1234567890","employee":"1234567890"}
Metadata associated with the Customer.
Example: [{"key":"key1","value":"value1","externalId":"ext123"},{"key":"key2","value":"value2","externalId":"ext123"}]
Notes associated with the Order.
Example: [{"author":"John Doe","note":"This is a note","addedByUser":true,"dateCreated":"2025-12-07T19:31:48.436+00:00","externalId":"ext123","customerNote":true}]
Billing address associated with the Order.
Example: {"firstName":"John","lastName":"Doe","address1":"123 Main St","address2":"Suite 100","city":"New York","state":"NY","country":"USA","postCode":"10001"}
Shipping address associated with the Order.
Example: {"firstName":"John","lastName":"Doe","address1":"123 Main St","address2":"Suite 100","city":"New York","state":"NY","country":"USA","postCode":"10001"}
Line items associated with the Order.
Example: [{"productId":"507f1f77bcf86cd799439011","variantId":"507f1f77bcf86cd799439012","name":"Sweet Tea","quantity":1,"manageStock":true,"price":"100.00","description":"Refreshing sweet tea","sku":"SKU-001","totalTax":"10.00","total":"110.00","taxes":[{"name":"Sales Tax","percentage":10,"amount":"10.00","taxTableName":"Default Tax","compounding":false,"priority":1,"taxTableId":"507f1f77bcf86cd799439013","id":"507f1f77bcf86cd799439014"}]}]
Custom sales associated with the Order.
Example: [{"customSaleId":"507f1f77bcf86cd799439011","name":"Custom Sale 1","applyTaxes":true,"quantity":1,"price":"1000.50","totalTax":"100.05","total":"1100.55","discount":{"cartDiscount":{"percentage":5,"amount":"50.00"}}}]
Response
application/json
[ { "id": "o1p2q3r4s5t6u7v8w9x0y1z2", "createdAt": "2025-12-07T19:31:48.436+00:00", "updatedAt": "2025-12-07T19:35:48.436+00:00", "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2", "currency": "USD", "receiptId": "o1p2q3r4s5t6u7v8w9x0y1z2", "status": "pending", "customerId": "o1p2q3r4s5t6u7v8w9x0y1z2", "source": "final", "sessionId": "o1p2q3r4s5t6u7v8w9x0y1z2", "balance": "1000.50", "externalId": "o1p2q3r4s5t6u7v8w9x0y1z2", "fromFinal": false, "customerNote": "Customer note", "parkReduceStock": "0", "parkExpiryDate": "never", "signature": "SGVsbG8gV29ybGQ=", "summary": { … }, "cartDiscount": { … }, "cartFees": [ … ], "paymentMethods": [ … ], "posData": { … }, "metadata": [ … ], "notes": [ … ], "billing": { … }, "shipping": { … }, "lineItems": [ … ], "customSales": [ … ], "refund": "string" } ]