Skip to content
/
Delete a order by ID

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
openapi.json
openapi.yaml
Overview
License
UNLICENSED
Languages
Servers
Mock server
https://docs.finalpos.com/_mock/openapi
Official API
https://api.finalpos.com

Data Transfer Objects (DTOs)

Schemas

Customer

Operations

Customers

Operations

Custom Tables: structure

Operations

Custom Table: content

Operations

Custom Tables: content

Operations

Product

Operations

Products

Operations

Outlet

Operations

Outlets

Operations

Category

Operations

Categories

Operations

Station

Operations

Stations

Operations

Variant

Operations

Variants

Operations

Order

Operations

Create a new order

Request

Creates a new order record.

Security
X-Api-Key
Bodyapplication/jsonrequired
currencystring

Currency of the Order.

Example: "USD"
receiptIdstringrequired

Receipt ID of the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
statusstringrequired

Status of the Order.

Example: "pending"
customerIdstring

Customer ID of the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
sourcestringrequired

Source of the Order.

Example: "final"
sessionIdstring

Session ID of the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
balancestringrequired

Balance amount of the Order.

Example: "1000.50"
externalIdstring

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

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
customerNotestring

Customer note of the Order.

Example: "Customer note"
parkReduceStockstring

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

Example: "0"
parkExpiryDatestring

Expiry date of the parked order.

Example: "never"
signaturestring

Signature of the Order in Base64 format.

Example: "SGVsbG8gV29ybGQ="
summaryobjectrequired

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"}}
summary.​discountTotalstringrequired

Total discount amount of the Order.

Example: "1000.50"
summary.​shippingTotalstring

Total shipping amount of the Order.

Example: "1000.50"
summary.​totalstringrequired

Total amount of the Order.

Example: "1000.50"
summary.​totalTaxesstringrequired

Total taxes amount of the Order.

Example: "1000.50"
summary.​isTaxInclusivebooleanrequired

Flag to indicate if the order is tax inclusive.

Example: false
summary.​subTotalstringrequired

Subtotal amount of the Order.

Example: "1000.50"
summary.​taxesArray of objects(OrderTaxDto)required

Taxes associated with the Order.

Example: [{"name":"Tax 1","percentage":10,"amount":"1000.50","taxTableName":"Tax Table 1","compounding":true,"priority":1,"taxTableId":"1234567890","id":"1234567890"}]
summary.​taxes[].​namestringrequired

Name of the tax.

Example: "Tax 1"
summary.​taxes[].​taxTableIdstring

ID of the tax table.

Example: "1234567890"
summary.​taxes[].​taxTableNamestring

Name of the tax table.

Example: "Standard Tax"
summary.​taxes[].​idstring

ID of the tax.

Example: "1234567890"
summary.​taxes[].​percentagenumberrequired

Percentage of the tax (e.g. 0.15 for 15%).

Example: 0.15
summary.​taxes[].​amountstringrequired

Amount of the tax.

Example: "1000.50"
summary.​taxes[].​compoundingboolean

Flag to indicate if the tax is compounding.

Example: false
summary.​taxes[].​prioritynumber

Priority of the tax.

Example: 1
summary.​taxes[].​_idstring
summary.​tipobject

Tip associated with the Order.

Example: {"percentage":0.15,"amount":"1000.50"}
cartDiscountobject

Cart discount of the Order.

Example: {"label":"Cart Discount 1","amount":"1000.50","percentage":0.15}
cartFeesArray of objects(OrderCartFeeDto)

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"}]
paymentMethodsArray of objectsrequired
posDataobject

POS data of the order.

Example: {"outlet":"1234567890","station":"1234567890","employee":"1234567890"}
metadataArray of objects(MetadataDto)

Metadata associated with the Customer.

Example: [{"key":"key1","value":"value1","externalId":"ext123"},{"key":"key2","value":"value2","externalId":"ext123"}]
notesArray of objects(OrderNoteDto)

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}]
billingobject

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"}
shippingobject

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"}
lineItemsArray of objects(OrderLineItemDto)

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"}]}]
customSalesArray of objects(OrderCustomSaleDto)

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"}}}]
refundstring
curl -i -X POST \
  https://docs.finalpos.com/_mock/openapi/v1/api/order \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "currency": "USD",
    "receiptId": "o1p2q3r4s5t6u7v8w9x0y1z2",
    "status": "pending",
    "customerId": "o1p2q3r4s5t6u7v8w9x0y1z2",
    "source": "final",
    "sessionId": "o1p2q3r4s5t6u7v8w9x0y1z2",
    "balance": "1000.50",
    "externalId": "o1p2q3r4s5t6u7v8w9x0y1z2",
    "customerNote": "Customer note",
    "parkReduceStock": "0",
    "parkExpiryDate": "never",
    "signature": "SGVsbG8gV29ybGQ=",
    "summary": {
      "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"
      }
    },
    "cartDiscount": {
      "label": "Cart Discount 1",
      "amount": "1000.50",
      "percentage": 0.15
    },
    "cartFees": [
      {
        "id": "1234567890",
        "label": "Cart Fee 1",
        "amount": "1000.50",
        "percentage": 0.15,
        "taxName": "Tax 1",
        "taxTableId": "1234567890",
        "tax": "1.10"
      }
    ],
    "paymentMethods": [
      {}
    ],
    "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
      }
    ],
    "billing": {
      "firstName": "John",
      "lastName": "Doe",
      "address1": "123 Main St",
      "address2": "Suite 100",
      "city": "New York",
      "state": "NY",
      "country": "USA",
      "postCode": "10001"
    },
    "shipping": {
      "firstName": "John",
      "lastName": "Doe",
      "address1": "123 Main St",
      "address2": "Suite 100",
      "city": "New York",
      "state": "NY",
      "country": "USA",
      "postCode": "10001"
    },
    "lineItems": [
      {
        "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"
          }
        ]
      }
    ],
    "customSales": [
      {
        "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"
          }
        }
      }
    ],
    "refund": "string"
  }'

Responses

The order has been successfully created.

Bodyapplication/json
idstring

Unique identifier for the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the Order was created.

Example: "2025-12-07T19:31:48.436+00:00"
updatedAtstring(date-time)

Timestamp when the Order was last updated.

Example: "2025-12-07T19:35:48.436+00:00"
companyIdstring

Company ID associated with the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
currencystring

Currency of the Order.

Example: "USD"
receiptIdstring

Receipt ID of the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
statusstring

Status of the Order.

Example: "pending"
customerIdstring

Customer ID of the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
sourcestring

Source of the Order.

Example: "final"
sessionIdstring

Session ID of the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
balancestring

Balance amount of the Order.

Example: "1000.50"
externalIdstring

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

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
fromFinalboolean

Flag to indicate if the Order is created from Final.

Example: false
customerNotestring

Customer note of the Order.

Example: "Customer note"
parkReduceStockstring

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

Example: "0"
parkExpiryDatestring

Expiry date of the parked order.

Example: "never"
signaturestring

Signature of the Order in Base64 format.

Example: "SGVsbG8gV29ybGQ="
summaryobject

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"}}
cartDiscountobject

Cart discount of the Order.

Example: {"label":"Cart Discount 1","amount":"1000.50","percentage":0.15}
cartFeesArray of objects(OrderCartFeeDto)

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"}]
paymentMethodsArray of objects
posDataobject

POS data of the order.

Example: {"outlet":"1234567890","station":"1234567890","employee":"1234567890"}
metadataArray of objects(MetadataDto)

Metadata associated with the Customer.

Example: [{"key":"key1","value":"value1","externalId":"ext123"},{"key":"key2","value":"value2","externalId":"ext123"}]
notesArray of objects(OrderNoteDto)

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}]
billingobject

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"}
shippingobject

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"}
lineItemsArray of objects(OrderLineItemDto)

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"}]}]
customSalesArray of objects(OrderCustomSaleDto)

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"}}}]
refundstring
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": {
    "discountTotal": "1000.50",
    "shippingTotal": "1000.50",
    "total": "1000.50",
    "totalTaxes": "1000.50",
    "isTaxInclusive": false,
    "subTotal": "1000.50",
    "taxes": [ … ],
    "tip": { … }
  },
  "cartDiscount": {
    "label": "Cart Discount 1",
    "amount": "1000.50",
    "percentage": 0.15
  },
  "cartFees": [
    { … }
  ],
  "paymentMethods": [
    {}
  ],
  "posData": {
    "outlet": "1234567890",
    "station": "1234567890",
    "employee": "1234567890"
  },
  "metadata": [
    { … },
    { … }
  ],
  "notes": [
    { … }
  ],
  "billing": {
    "firstName": "John",
    "lastName": "Doe",
    "address1": "123 Main St",
    "address2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "country": "USA",
    "postCode": "10001"
  },
  "shipping": {
    "firstName": "John",
    "lastName": "Doe",
    "address1": "123 Main St",
    "address2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "country": "USA",
    "postCode": "10001"
  },
  "lineItems": [
    { … }
  ],
  "customSales": [
    { … }
  ],
  "refund": "string"
}

Get a order by ID

Request

Retrieves a single order by its unique identifier.

Security
X-Api-Key
Path
idstringrequired

Order ID

curl -i -X GET \
  'https://docs.finalpos.com/_mock/openapi/v1/api/order/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

The order has been successfully retrieved.

Bodyapplication/json
idstring

Unique identifier for the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the Order was created.

Example: "2025-12-07T19:31:48.436+00:00"
updatedAtstring(date-time)

Timestamp when the Order was last updated.

Example: "2025-12-07T19:35:48.436+00:00"
companyIdstring

Company ID associated with the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
currencystring

Currency of the Order.

Example: "USD"
receiptIdstring

Receipt ID of the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
statusstring

Status of the Order.

Example: "pending"
customerIdstring

Customer ID of the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
sourcestring

Source of the Order.

Example: "final"
sessionIdstring

Session ID of the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
balancestring

Balance amount of the Order.

Example: "1000.50"
externalIdstring

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

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
fromFinalboolean

Flag to indicate if the Order is created from Final.

Example: false
customerNotestring

Customer note of the Order.

Example: "Customer note"
parkReduceStockstring

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

Example: "0"
parkExpiryDatestring

Expiry date of the parked order.

Example: "never"
signaturestring

Signature of the Order in Base64 format.

Example: "SGVsbG8gV29ybGQ="
summaryobject

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"}}
cartDiscountobject

Cart discount of the Order.

Example: {"label":"Cart Discount 1","amount":"1000.50","percentage":0.15}
cartFeesArray of objects(OrderCartFeeDto)

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"}]
paymentMethodsArray of objects
posDataobject

POS data of the order.

Example: {"outlet":"1234567890","station":"1234567890","employee":"1234567890"}
metadataArray of objects(MetadataDto)

Metadata associated with the Customer.

Example: [{"key":"key1","value":"value1","externalId":"ext123"},{"key":"key2","value":"value2","externalId":"ext123"}]
notesArray of objects(OrderNoteDto)

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}]
billingobject

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"}
shippingobject

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"}
lineItemsArray of objects(OrderLineItemDto)

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"}]}]
customSalesArray of objects(OrderCustomSaleDto)

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"}}}]
refundstring
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": {
    "discountTotal": "1000.50",
    "shippingTotal": "1000.50",
    "total": "1000.50",
    "totalTaxes": "1000.50",
    "isTaxInclusive": false,
    "subTotal": "1000.50",
    "taxes": [ … ],
    "tip": { … }
  },
  "cartDiscount": {
    "label": "Cart Discount 1",
    "amount": "1000.50",
    "percentage": 0.15
  },
  "cartFees": [
    { … }
  ],
  "paymentMethods": [
    {}
  ],
  "posData": {
    "outlet": "1234567890",
    "station": "1234567890",
    "employee": "1234567890"
  },
  "metadata": [
    { … },
    { … }
  ],
  "notes": [
    { … }
  ],
  "billing": {
    "firstName": "John",
    "lastName": "Doe",
    "address1": "123 Main St",
    "address2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "country": "USA",
    "postCode": "10001"
  },
  "shipping": {
    "firstName": "John",
    "lastName": "Doe",
    "address1": "123 Main St",
    "address2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "country": "USA",
    "postCode": "10001"
  },
  "lineItems": [
    { … }
  ],
  "customSales": [
    { … }
  ],
  "refund": "string"
}

Update a order by ID

Request

Updates an existing order record.

Security
X-Api-Key
Path
idstringrequired

Order ID

Bodyapplication/jsonrequired
currencystring

Currency of the Order.

Example: "USD"
receiptIdstring

Receipt ID of the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
statusstring

Status of the Order.

Example: "pending"
customerIdstring

Customer ID of the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
sourcestring

Source of the Order.

Example: "final"
sessionIdstring

Session ID of the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
balancestring

Balance amount of the Order.

Example: "1000.50"
externalIdstring

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

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
customerNotestring

Customer note of the Order.

Example: "Customer note"
parkReduceStockstring

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

Example: "0"
parkExpiryDatestring

Expiry date of the parked order.

Example: "never"
signaturestring

Signature of the Order in Base64 format.

Example: "SGVsbG8gV29ybGQ="
summaryobject

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"}}
cartDiscountobject

Cart discount of the Order.

Example: {"label":"Cart Discount 1","amount":"1000.50","percentage":0.15}
cartFeesArray of objects(OrderCartFeeDto)

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"}]
paymentMethodsArray of objects
posDataobject

POS data of the order.

Example: {"outlet":"1234567890","station":"1234567890","employee":"1234567890"}
metadataArray of objects(MetadataDto)

Metadata associated with the Customer.

Example: [{"key":"key1","value":"value1","externalId":"ext123"},{"key":"key2","value":"value2","externalId":"ext123"}]
notesArray of objects(OrderNoteDto)

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}]
billingobject

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"}
shippingobject

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"}
lineItemsArray of objects(OrderLineItemDto)

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"}]}]
customSalesArray of objects(OrderCustomSaleDto)

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"}}}]
refundstring
curl -i -X PUT \
  'https://docs.finalpos.com/_mock/openapi/v1/api/order/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "currency": "USD",
    "receiptId": "o1p2q3r4s5t6u7v8w9x0y1z2",
    "status": "pending",
    "customerId": "o1p2q3r4s5t6u7v8w9x0y1z2",
    "source": "final",
    "sessionId": "o1p2q3r4s5t6u7v8w9x0y1z2",
    "balance": "1000.50",
    "externalId": "o1p2q3r4s5t6u7v8w9x0y1z2",
    "customerNote": "Customer note",
    "parkReduceStock": "0",
    "parkExpiryDate": "never",
    "signature": "SGVsbG8gV29ybGQ=",
    "summary": {
      "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"
      }
    },
    "cartDiscount": {
      "label": "Cart Discount 1",
      "amount": "1000.50",
      "percentage": 0.15
    },
    "cartFees": [
      {
        "id": "1234567890",
        "label": "Cart Fee 1",
        "amount": "1000.50",
        "percentage": 0.15,
        "taxName": "Tax 1",
        "taxTableId": "1234567890",
        "tax": "1.10"
      }
    ],
    "paymentMethods": [
      {}
    ],
    "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
      }
    ],
    "billing": {
      "firstName": "John",
      "lastName": "Doe",
      "address1": "123 Main St",
      "address2": "Suite 100",
      "city": "New York",
      "state": "NY",
      "country": "USA",
      "postCode": "10001"
    },
    "shipping": {
      "firstName": "John",
      "lastName": "Doe",
      "address1": "123 Main St",
      "address2": "Suite 100",
      "city": "New York",
      "state": "NY",
      "country": "USA",
      "postCode": "10001"
    },
    "lineItems": [
      {
        "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"
          }
        ]
      }
    ],
    "customSales": [
      {
        "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"
          }
        }
      }
    ],
    "refund": "string"
  }'

Responses

The order has been successfully updated.

Bodyapplication/json
idstring

Unique identifier for the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the Order was created.

Example: "2025-12-07T19:31:48.436+00:00"
updatedAtstring(date-time)

Timestamp when the Order was last updated.

Example: "2025-12-07T19:35:48.436+00:00"
companyIdstring

Company ID associated with the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
currencystring

Currency of the Order.

Example: "USD"
receiptIdstring

Receipt ID of the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
statusstring

Status of the Order.

Example: "pending"
customerIdstring

Customer ID of the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
sourcestring

Source of the Order.

Example: "final"
sessionIdstring

Session ID of the Order.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
balancestring

Balance amount of the Order.

Example: "1000.50"
externalIdstring

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

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
fromFinalboolean

Flag to indicate if the Order is created from Final.

Example: false
customerNotestring

Customer note of the Order.

Example: "Customer note"
parkReduceStockstring

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

Example: "0"
parkExpiryDatestring

Expiry date of the parked order.

Example: "never"
signaturestring

Signature of the Order in Base64 format.

Example: "SGVsbG8gV29ybGQ="
summaryobject

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"}}
cartDiscountobject

Cart discount of the Order.

Example: {"label":"Cart Discount 1","amount":"1000.50","percentage":0.15}
cartFeesArray of objects(OrderCartFeeDto)

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"}]
paymentMethodsArray of objects
posDataobject

POS data of the order.

Example: {"outlet":"1234567890","station":"1234567890","employee":"1234567890"}
metadataArray of objects(MetadataDto)

Metadata associated with the Customer.

Example: [{"key":"key1","value":"value1","externalId":"ext123"},{"key":"key2","value":"value2","externalId":"ext123"}]
notesArray of objects(OrderNoteDto)

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}]
billingobject

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"}
shippingobject

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"}
lineItemsArray of objects(OrderLineItemDto)

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"}]}]
customSalesArray of objects(OrderCustomSaleDto)

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"}}}]
refundstring
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": {
    "discountTotal": "1000.50",
    "shippingTotal": "1000.50",
    "total": "1000.50",
    "totalTaxes": "1000.50",
    "isTaxInclusive": false,
    "subTotal": "1000.50",
    "taxes": [ … ],
    "tip": { … }
  },
  "cartDiscount": {
    "label": "Cart Discount 1",
    "amount": "1000.50",
    "percentage": 0.15
  },
  "cartFees": [
    { … }
  ],
  "paymentMethods": [
    {}
  ],
  "posData": {
    "outlet": "1234567890",
    "station": "1234567890",
    "employee": "1234567890"
  },
  "metadata": [
    { … },
    { … }
  ],
  "notes": [
    { … }
  ],
  "billing": {
    "firstName": "John",
    "lastName": "Doe",
    "address1": "123 Main St",
    "address2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "country": "USA",
    "postCode": "10001"
  },
  "shipping": {
    "firstName": "John",
    "lastName": "Doe",
    "address1": "123 Main St",
    "address2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "country": "USA",
    "postCode": "10001"
  },
  "lineItems": [
    { … }
  ],
  "customSales": [
    { … }
  ],
  "refund": "string"
}

Delete a order by ID

Request

Deletes a order by its unique identifier.

Security
X-Api-Key
Path
idstringrequired

Order ID

curl -i -X DELETE \
  'https://docs.finalpos.com/_mock/openapi/v1/api/order/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

The order has been successfully deleted.

Bodyapplication/json
statusCodenumberrequired

HTTP status code

Example: 200
messagestringrequired

Message describing the result of the operation

Example: "Resource with Id 123 deleted successfully"
Response
application/json
{
  "statusCode": 200,
  "message": "Resource with Id 123 deleted successfully"
}

Orders

Operations

Transactions

Operations

Roles

Operations

Attachment

Operations

Account

Operations

Refunds

Operations

Session

Operations

ZapierTriggers

Operations