TEteya
Pay at Table

List tabs for a store

Returns tabs for the specified store, cursor-paginated.

Supports optional filters:

  • status: repeatable. When omitted, defaults to active tabs only (OPEN, PAYING, PAUSED). To include archived tabs, pass status=COMPLETED and/or status=CLOSED explicitly.
  • merchant_reference: merchant-assigned reference. Unique per store, so the filtered response will contain at most one tab.
get/poslink/v1/tabs

Request

Query parameters

store_idstring uuid required

The store identifier

statusstring[]

Tab statuses to include. Repeatable (e.g., status=OPEN&status=PAUSED). When omitted, returns only active tabs (OPEN, PAYING, PAUSED). To include archived tabs, pass status=COMPLETED and/or status=CLOSED explicitly.

merchant_referencestring

Merchant-assigned reference to filter by. When provided, returns the single tab matching (store_id, merchant_reference) or an empty list.

afterstring

Opaque cursor pointing to the last item of the current page. Use to fetch the next page. Mutually exclusive with before.

beforestring

Opaque cursor pointing to the first item of the current page. Use to fetch the previous page. Mutually exclusive with after.

limitinteger

Maximum number of results to return. Defaults to 50, capped at 300.

Response

Tabs retrieved successfully

Example response

{
  "tabs": [
    {
      "tab_id": "3f2b6a2e-9d3e-4a1f-8f1e-6b2e5a8c9d01",
      "tab_name": "Table 5",
      "merchant_reference": "ORDER-2026-001",
      "status": "OPEN",
      "total_amount": {
        "amount": 1500,
        "currency": "EUR"
      },
      "remaining": 5000,
      "showing_bill_terminal_id": "term-001"
    }
  ],
  "paging": {
    "cursors": {
      "before": "MTY1NTMxMDI0MDAwMHxkZmM0ZmM1Mi04MjkzLTQ1YjYtOWYzZS1iM2IwZjhmODgxODg",
      "after": "MTY1NTMxMDI0MDAwMHxkZmM0ZmM1Mi04MjkzLTQ1YjYtOWYzZS1iM2IwZjhmODgxODg"
    },
    "paths": {
      "previous": "/poslink/v1/tabs?store_id=eac4d470-4731-45b2-af6b-c828f03c1f9d&limit=20&before=MTY1NTMxMDI0MDAwMHxkZmM0ZmM1Mi04MjkzLTQ1YjYtOWYzZS1iM2IwZjhmODgxODg",
      "next": "/poslink/v1/tabs?store_id=eac4d470-4731-45b2-af6b-c828f03c1f9d&limit=20&after=MTY1NTMxMDI0MDAwMHxkZmM0ZmM1Mi04MjkzLTQ1YjYtOWYzZS1iM2IwZjhmODgxODg"
    }
  }
}

Changes

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