Order

Get a order by ID

Retrieves a single order by its unique identifier.

get/v1/order/{id}

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/order/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Order ID

Response

The order has been successfully retrieved.

idstring

Unique identifier for the Order.

createdAtstring date-time

Timestamp when the Order was created.

updatedAtstring date-time

Timestamp when the Order was last updated.

companyIdstring

Company ID associated with the Order.

currency'USD' | 'EUR' | 'GBP' | 'CAD' | 'AUD' | 'NZD' | 'CHF' | 'CNY' | 'INR' | 'MXN' | 'BRL' | 'ZAR' | 'SGD' | 'HKD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'THB' | 'MYR' | 'PHP' | 'IDR' | 'AED' | 'SAR' | 'ILS' | 'TRY' | 'RUB' | 'HTG' | 'BND' | 'CRC' | 'BDT' | 'UAH' | 'NGN' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BGN' | 'BMD' | 'BOB' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'COP' | 'CZK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'FJD' | 'GEL' | 'GHS' | 'GTQ' | 'GYD' | 'HNL' | 'IRR' | 'JMD' | 'KES' | 'KGS' | 'KHR' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'MAD' | 'MDL' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MZN' | 'NAD' | 'NIO' | 'NPR' | 'PAB' | 'PEN' | 'PGK' | 'PKR' | 'QAR' | 'RON' | 'RSD' | 'SBD' | 'SRD' | 'SYP' | 'TJS' | 'TMT' | 'TOP' | 'TTD' | 'TZS' | 'UYU' | 'UZS' | 'VES' | 'WST' | 'XCD' | 'YER' | 'ZMW' | 'CDF' | 'CUP' | 'ERN' | 'FKP' | 'GIP' | 'GMD' | 'KPW' | 'LRD' | 'LSL' | 'MGA' | 'MWK' | 'SCR' | 'SDG' | 'SHP' | 'SLE' | 'SOS' | 'SSP' | 'STN' | 'SZL' | 'VED' | 'XCG' | 'JPY' | 'KRW' | 'VND' | 'CLP' | 'ISK' | 'HUF' | 'TWD' | 'GNF' | 'BIF' | 'DJF' | 'KMF' | 'PYG' | 'RWF' | 'UGX' | 'VUV' | 'XAF' | 'XOF' | 'XPF' | 'KWD' | 'BHD' | 'OMR' | 'JOD' | 'TND' | 'LYD' | 'IQD'

Currency of the Order. ISO 4217 currency code.

receiptIdstring

Receipt ID of the Order.

paymentStatestring

Order payment state. Closed vocabulary: unpaid, payment_pending, partially_paid, paid, partially_refunded, refunded, voided.

fulfillmentStatestring

Order fulfillment state. Closed vocabulary: draft, pending, on_hold, in_progress, fulfilled, partially_fulfilled, returned, partially_returned, cancelled.

completedAtstring date-time

Timestamp the order reached its terminal paid + fulfilled state. Receipt "datetime" binds here. Distinct from createdAt (cart created) and updatedAt (any mutation).

sourceUpdatedAtstring date-time

The external source's last-modified timestamp for this order (e.g. Woo date_modified / Shopify updated_at). Used to suppress out-of-order webhook redelivery on ingestion.

sourceCreatedAtstring date-time

The external source's creation timestamp for this order (e.g. Lightspeed createTime / Woo date_created). Historical anchor; distinct from the record's own createdAt (import time).

customerIdstring

Customer ID of the Order.

sourcestring

Source of the Order. Closed vocabulary: in-store, public-api

sessionIdstring

Session ID of the Order.

balancenumber

Balance amount of the Order in minor currency units (e.g., cents for USD).

externalIdstring

External ID associated with the Order when synced from external source. If present, it will set fromFinal to true.

customerNotestring

Customer note of the Order.

parkReduceStockstring

When the order is parked, the stock will be reduced by this amount. If 0, the stock will not be reduced.

parkExpiryDatestring

Expiry date of the parked order.

signaturestring

Signature of the Order in Base64 format.

minorUnitsnumber

The Minor Units of the Order to convert the amount from minor units to major units.

Example response

{
  "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
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.