Orders
Bulk read orders
Retrieves a list of orders. Supports filtering by fields, sorting, and pagination.
get/v1/orders
Request
- Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
- URL: https://api.finalpos.com/v1/orders
- Auth: API key in header x-api-key
Query parameters
skipnumber
Number of records to skip (default: 0)
limitnumber
Maximum number of records to return (default: 100, max: 1000)
sortBy'createdAt' | 'updatedAt'
Field name to sort results by
sortOrder'asc' | 'desc'
Sort direction (default: asc)
Filter by createdAt using range operators
Filter by updatedAt using range operators
paymentStatestring
Filter by paymentState
fulfillmentStatestring
Filter by fulfillmentState
sourcestring
Filter by source
Response
Successfully retrieved list of items
Example response
{
"data": [
{
"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",
"paymentState": "paid",
"fulfillmentState": "fulfilled",
"stateHistory": [
{
"payment": "unpaid",
"fulfillment": "draft",
"posTimestamp": "2025-12-07T19:31:48.436Z"
}
],
"completedAt": "2026-05-08T10:15:00.000Z",
"sourceUpdatedAt": "2026-07-01T18:22:10.000Z",
"sourceCreatedAt": "2026-07-01T18:20:00.000Z",
"customerId": "o1p2q3r4s5t6u7v8w9x0y1z2",
"source": "in-store",
"sessionId": "o1p2q3r4s5t6u7v8w9x0y1z2",
"balance": 100050,
"externalId": "1234567890",
"customerNote": "Customer note",
"parkReduceStock": "0",
"parkExpiryDate": "never",
"signature": "SGVsbG8gV29ybGQ=",
"summary": {
"subTotal": 48000,
"discountTotal": 100050,
"shippingTotal": 100050,
"total": 100050,
"totalTaxes": 100050,
"subtotalAfterFees": 100050,
"nonRevenueTotal": 500000,
"grossSales": 48000,
"modifiersTotal": 500,
"lineDiscountTotal": 600,
"cartDiscountTotal": 1000,
"feesTotal": 3500,
"lineFeesTotal": 2000,
"cartFeesTotal": 1500,
"taxableFeesTotal": 2000,
"nonTaxableFeesTotal": 1500,
"taxableModifiersTotal": 500,
"totalTaxableSales": 48000,
"tipTotal": 800,
"cashRounding": -2,
"payments": {
"cardTotal": 44500,
"cashTotal": 14875,
"cardProcessingFeesTotal": 1126
},
"totalBeforeTip": 200050,
"amountPaid": 200050,
"taxes": [
{
"name": "Tax 1",
"percentage": 10,
"amount": 100050,
"taxTableName": "Tax Table 1",
"compounding": true,
"priority": 1,
"taxTableId": "1234567890",
"id": "1234567890"
}
],
"tip": {
"percentage": 0.15,
"amount": 100050,
"tipTo": "1234567890"
}
},
"cartDiscount": {
"amount": 100050,
"percentage": 0.15,
"label": "Cart Discount 1"
},
"cartFees": [
{
"id": "1234567890",
"label": "Cart Fee 1",
"amount": 100050,
"percentage": 0.15,
"taxName": "Tax 1",
"taxTableId": "1234567890",
"tax": 110
}
],
"paymentMethods": [
{
"paymentType": "card",
"amount": 100050,
"transactionId": "1234567890",
"timestamp": "2025-12-07T19:31:48.436+00:00",
"emv": "1234567890",
"cashRounding": 0.05,
"change": 100050,
"processor": "Cloud",
"processorFee": 100050,
"tip": {
"percentage": 0.15,
"amount": 1050,
"tipTo": "1234567890"
}
}
],
"posData": {
"outlet": "1234567890",
"station": "1234567890",
"employee": "1234567890"
},
"metadata": [
{
"key": "key1",
"value": "value1",
"externalId": "ext123"
},
{
"key": "key2",
"value": "value2",
"externalId": "ext123"
}
],
"notes": [
{
"author": "John Doe",
"note": "This is a note",
"addedByUser": true,
"dateCreated": "2025-12-07T19:31:48.436+00:00",
"externalId": "ext123",
"customerNote": true
}
],
"lineItems": [
{
"productId": "507f1f77bcf86cd799439011",
"variantId": "507f1f77bcf86cd799439012",
"name": "Sweet Tea",
"quantity": 1,
"manageStock": true,
"price": 10000,
"description": "Refreshing sweet tea",
"sku": "SKU-001",
"totalTax": 1000,
"total": 11000,
"subTotal": 10000,
"stock": 10,
"productExternalId": "ext-prod-001",
"variantExternalId": "ext-var-001",
"lineItemExternalId": "ext-li-001",
"internalId": "int-001",
"note": "No ice please",
"image": "https://example.com/sweet-tea.jpg",
"attributes": "Large, Unsweetened",
"taxes": [
{
"name": "Sales Tax",
"percentage": 10,
"amount": 1000,
"taxTableName": "Default Tax",
"compounding": false,
"priority": 1,
"taxTableId": "507f1f77bcf86cd799439013",
"id": "507f1f77bcf86cd799439014"
}
],
"discount": {
"itemDiscount": {
"percentage": 10,
"amount": 500
},
"cartDiscount": {
"percentage": 5,
"amount": 250
}
},
"fee": {
"cartFee": {
"percentage": 0.03,
"amount": 150
},
"itemFee": {
"percentage": 0.02,
"amount": 100
}
},
"metadata": [
{
"key": "color",
"value": "green",
"externalId": "ext123"
}
]
}
],
"reservations": [
{
"productId": "a1b2c3d4e5f6a7b8c9d0e1f2",
"internalId": "res_01",
"name": "Haircut",
"price": 5000,
"total": 5000,
"resourceId": "507f1f77bcf86cd799439011",
"startAt": "2026-09-05T13:00:00.000Z",
"endAt": "2026-09-05T15:00:00.000Z",
"bufferEndAt": "2026-09-05T15:30:00.000Z",
"override": false
}
],
"customSales": [
{
"customSaleId": "507f1f77bcf86cd799439011",
"name": "Custom Sale 1",
"applyTaxes": true,
"quantity": 1,
"price": 100050,
"totalTax": 10005,
"total": 110055,
"discount": {
"cartDiscount": {
"percentage": 5,
"amount": 5000
}
}
}
],
"nonRevenueItems": [
{
"type": "gift-card",
"amount": 500,
"label": "$50 Gift Card",
"externalId": "custom-extension-sale-1"
}
],
"refund": [
{
"externalId": "23696",
"reason": "Customer request",
"summary": {
"total": -3358
}
}
]
}
],
"meta": {
"count": 1450,
"limit": 100
}
}Changes
No recorded changes to this operation across all 1 revision of this API.