Skip to content
HallifyDevelopersSearch documentation
Open Hallify
Sections

QR table access and ordering

Request current-session table admission

POST/public/table-locators/{locator}/joins

Creates one native join from its opaque context using the current session PIN or staff approval policy. New widget demand also verifies a current signed widget context against the original frame, connection, parent binding and QR resource. Original-command replay uses retained native provenance without requiring a renewed widget bootstrap proof. A wrong PIN commits only the bounded attempt and encrypted original denial; exhausted new keys create no permanent receipt. The returned credential can read or claim only this join request. A required Idempotency-Key makes retries with the same payload return the stored status and body; reusing the key with a different payload returns 409.

Authentication

x-hallify-widget-context: <HALLIFY_STOREFRONT_WIDGET_CONTEXT>

Short-lived server-authenticated widget presentation proof. It binds the configured frame origin to the exact verified parent binding and connection authority. Widget new demand requires this proof; existing native capabilities remain separate and retain their original authority and deadlines.

Connection guide

Parameters

locatorPath · Required

Public 24-character physical-table QR reference whose resolved opaque context must match this join attempt and the current native locator and service session.

string
Full definition
{
  "type": "string",
  "minLength": 24,
  "maxLength": 24,
  "pattern": "^[A-Za-z0-9_-]{24}$",
  "example": "qr_demo_locator_00000001"
}
idempotency-keyHeader · Required

Required idempotency key, up to 128 characters

string
Full definition
{
  "type": "string",
  "minLength": 1,
  "maxLength": 128,
  "example": "example"
}
originHeader · Required

Actual browser-managed request origin used to validate approved presentation provenance and its current resource binding. Browser clients preserve this value; the separate join or membership credential supplies guest authorization.

string · uri
Full definition
{
  "type": "string",
  "format": "uri",
  "example": "https://example.test/resource"
}

Request body

Required

Opaque locator-resolution context, permitted join method and a current six-digit PIN only for SESSION_PIN. STAFF_APPROVAL accepts no PIN or client-selected slot or staff decision. Actual Origin and current native authority are rechecked before admission.

application/json

CreateTablePublicJoinDto
Full definition
{
  "$ref": "#/components/schemas/CreateTablePublicJoinDto"
}

Responses

201Original join receipt and its private join-only credential.
TablePublicJoinCreatedDto
Full definition
{
  "$ref": "#/components/schemas/TablePublicJoinCreatedDto"
}
Example response · 201 · application/json
{
  "id": "4186fdc1-e9b6-4378-8bdc-6c7727b0c09f",
  "status": "PENDING_APPROVAL",
  "revision": 1,
  "expiresAt": "2026-12-31T18:00:00.000Z",
  "requestToken": "synthetic-example-credentialxxxxxxxxxxxxxxx"
}
400The supplied identifier, query or credential shape is invalid.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 400 · application/json
{
  "statusCode": 400,
  "error": "errors:http.badRequest",
  "code": "HTTP_BAD_REQUEST",
  "message": "errors:http.badRequest",
  "translationKey": "errors:http.badRequest"
}
401The QR credential, current native authority or exact requesting Origin is denied.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 401 · application/json
{
  "statusCode": 401,
  "error": "errors:http.unauthorized",
  "code": "HTTP_UNAUTHORIZED",
  "message": "errors:http.unauthorized",
  "translationKey": "errors:http.unauthorized"
}
404The current public locator, presentation binding or owned native resource is unavailable.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 404 · application/json
{
  "statusCode": 404,
  "error": "errors:http.notFound",
  "code": "HTTP_NOT_FOUND",
  "message": "errors:http.notFound",
  "translationKey": "errors:http.notFound"
}
409Idempotency conflict or documented operation-specific domain conflict
TablePublicCommandConflictDto
Full definition
{
  "$ref": "#/components/schemas/TablePublicCommandConflictDto"
}
Example response · 409 · application/json
{
  "statusCode": 409,
  "error": "errors:http.conflict",
  "code": "TABLE_PUBLIC_REVISION_CONFLICT",
  "message": "errors:http.conflict",
  "translationKey": "errors:http.conflict"
}
429The bounded native join or PIN budget is exhausted; wait before another new command.

Response headers

Retry-After

Whole seconds the client must wait before retrying the rejected request.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "example": 60
}
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 429 · application/json
{
  "statusCode": 429,
  "error": "errors:http.tooManyRequests",
  "code": "HTTP_TOO_MANY_REQUESTS",
  "message": "errors:http.tooManyRequests",
  "translationKey": "errors:http.tooManyRequests"
}
503QR key material or authoritative native state cannot be safely used.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 503 · application/json
{
  "statusCode": 503,
  "error": "errors:http.serviceUnavailable",
  "code": "HTTP_SERVICE_UNAVAILABLE",
  "message": "errors:http.serviceUnavailable",
  "translationKey": "errors:http.serviceUnavailable"
}

Schemas

CreateTablePublicJoinDto

Guest admission request bound to an opaque physical-table locator context and current presentation Origin. A session PIN or subsequent staff approval admits the join; the admission owner selects its native slot.

joinContextRequired

Opaque short-lived context from public table locator resolution.

string
Full definition
{
  "type": "string",
  "maxLength": 22000,
  "description": "Opaque short-lived context from public table locator resolution.",
  "example": "example"
}
methodRequired

Fresh membership admission method permitted by the current venue policy.

string
Full definition
{
  "type": "string",
  "enum": [
    "SESSION_PIN",
    "STAFF_APPROVAL"
  ],
  "example": "STAFF_APPROVAL",
  "description": "Fresh membership admission method permitted by the current venue policy."
}
pinOptional

Current six-digit service-session PIN. Required for SESSION_PIN and must be absent for STAFF_APPROVAL.

string
Full definition
{
  "type": "string",
  "pattern": "^\\d{6}$",
  "minLength": 6,
  "maxLength": 6,
  "description": "Current six-digit service-session PIN. Required for SESSION_PIN and must be absent for STAFF_APPROVAL.",
  "example": "000001"
}
Full definition
{
  "type": "object",
  "properties": {
    "joinContext": {
      "type": "string",
      "maxLength": 22000,
      "description": "Opaque short-lived context from public table locator resolution.",
      "example": "example"
    },
    "method": {
      "type": "string",
      "enum": [
        "SESSION_PIN",
        "STAFF_APPROVAL"
      ],
      "example": "STAFF_APPROVAL",
      "description": "Fresh membership admission method permitted by the current venue policy."
    },
    "pin": {
      "type": "string",
      "pattern": "^\\d{6}$",
      "minLength": 6,
      "maxLength": 6,
      "description": "Current six-digit service-session PIN. Required for SESSION_PIN and must be absent for STAFF_APPROVAL.",
      "example": "000001"
    }
  },
  "description": "Guest admission request bound to an opaque physical-table locator context and current presentation Origin. A session PIN or subsequent staff approval admits the join; the admission owner selects its native slot.",
  "required": [
    "joinContext",
    "method"
  ],
  "example": {
    "joinContext": "example",
    "method": "STAFF_APPROVAL"
  }
}
TablePublicJoinCreatedDto

Original native join receipt with a private credential scoped to reading and claiming that admission request. Claiming an approved join establishes its separate session membership.

idRequired

Owned join-request identifier.

string · uuid
Full definition
{
  "type": "string",
  "format": "uuid",
  "description": "Owned join-request identifier.",
  "example": "4186fdc1-e9b6-4378-8bdc-6c7727b0c09f"
}
statusRequired

Native join decision and claim state.

string
Full definition
{
  "type": "string",
  "enum": [
    "PENDING_APPROVAL",
    "APPROVED",
    "CLAIMED",
    "REJECTED",
    "EXPIRED",
    "REVOKED"
  ],
  "description": "Native join decision and claim state.",
  "example": "PENDING_APPROVAL"
}
revisionRequired

Join-request optimistic revision.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "description": "Join-request optimistic revision.",
  "example": 1
}
expiresAtRequired

Deadline for first claim of an approved join.

string · date-time
Full definition
{
  "type": "string",
  "format": "date-time",
  "description": "Deadline for first claim of an approved join.",
  "example": "2026-12-31T18:00:00.000Z"
}
requestTokenRequired

Private credential limited to this join request; it does not read a table bill.

string
Full definition
{
  "type": "string",
  "minLength": 43,
  "maxLength": 43,
  "description": "Private credential limited to this join request; it does not read a table bill.",
  "example": "synthetic-example-credentialxxxxxxxxxxxxxxx"
}
Full definition
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Owned join-request identifier.",
      "example": "4186fdc1-e9b6-4378-8bdc-6c7727b0c09f"
    },
    "status": {
      "type": "string",
      "enum": [
        "PENDING_APPROVAL",
        "APPROVED",
        "CLAIMED",
        "REJECTED",
        "EXPIRED",
        "REVOKED"
      ],
      "description": "Native join decision and claim state.",
      "example": "PENDING_APPROVAL"
    },
    "revision": {
      "type": "integer",
      "minimum": 1,
      "description": "Join-request optimistic revision.",
      "example": 1
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "description": "Deadline for first claim of an approved join.",
      "example": "2026-12-31T18:00:00.000Z"
    },
    "requestToken": {
      "type": "string",
      "minLength": 43,
      "maxLength": 43,
      "description": "Private credential limited to this join request; it does not read a table bill.",
      "example": "synthetic-example-credentialxxxxxxxxxxxxxxx"
    }
  },
  "description": "Original native join receipt with a private credential scoped to reading and claiming that admission request. Claiming an approved join establishes its separate session membership.",
  "required": [
    "id",
    "status",
    "revision",
    "expiresAt",
    "requestToken"
  ],
  "example": {
    "id": "4186fdc1-e9b6-4378-8bdc-6c7727b0c09f",
    "status": "PENDING_APPROVAL",
    "revision": 1,
    "expiresAt": "2026-12-31T18:00:00.000Z",
    "requestToken": "synthetic-example-credentialxxxxxxxxxxxxxxx"
  }
}
TranslatedErrorDto

Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.

statusCodeRequired

HTTP status code repeated from the response.

integer
Full definition
{
  "type": "integer",
  "description": "HTTP status code repeated from the response.",
  "example": 400
}
errorRequired

Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.

string
Full definition
{
  "type": "string",
  "description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.",
  "example": "errors.request.invalid"
}
codeRequired

Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions.

string
Full definition
{
  "type": "string",
  "example": "HTTP_BAD_REQUEST",
  "description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions."
}
messageRequired

Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application.

string
Full definition
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application."
}
translationKeyRequired

Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback.

string
Full definition
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback."
}
translationValuesOptional

Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.

object
Full definition
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
  "example": {
    "exampleKey": "example"
  }
}
validationErrorsOptional

Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.

array
Full definition
{
  "description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.",
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ValidationErrorDto"
  },
  "example": [
    {
      "field": "email",
      "translationKey": "validation:isEmail",
      "code": "isEmail",
      "message": "validation:isEmail"
    }
  ]
}
detailsOptional

Optional domain-specific blocker or validation details

oneOf
Full definition
{
  "description": "Optional domain-specific blocker or validation details",
  "oneOf": [
    {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": [
        "example"
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": {
        "exampleKey": "example"
      }
    }
  ],
  "example": [
    "example"
  ]
}
Full definition
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "description": "HTTP status code repeated from the response.",
      "example": 400
    },
    "error": {
      "type": "string",
      "description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.",
      "example": "errors.request.invalid"
    },
    "code": {
      "type": "string",
      "example": "HTTP_BAD_REQUEST",
      "description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions."
    },
    "message": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application."
    },
    "translationKey": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
      "example": {
        "exampleKey": "example"
      }
    },
    "validationErrors": {
      "description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorDto"
      },
      "example": [
        {
          "field": "email",
          "translationKey": "validation:isEmail",
          "code": "isEmail",
          "message": "validation:isEmail"
        }
      ]
    },
    "details": {
      "description": "Optional domain-specific blocker or validation details",
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/JsonValue"
          },
          "example": [
            "example"
          ]
        },
        {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/components/schemas/JsonValue"
          },
          "example": {
            "exampleKey": "example"
          }
        }
      ],
      "example": [
        "example"
      ]
    }
  },
  "required": [
    "statusCode",
    "error",
    "code",
    "message",
    "translationKey"
  ],
  "description": "Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.",
  "example": {
    "statusCode": 400,
    "error": "errors:http.badRequest",
    "code": "HTTP_BAD_REQUEST",
    "message": "errors:http.badRequest",
    "translationKey": "errors:http.badRequest"
  }
}
ValidationErrorDto

Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.

fieldRequired

Public field path. Nested properties and array indices are separated by dots.

string
Full definition
{
  "type": "string",
  "example": "email",
  "description": "Public field path. Nested properties and array indices are separated by dots."
}
translationKeyRequired

Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog.

string
Full definition
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog."
}
codeRequired

Stable validator identifier for this field failure. Custom validators may define additional identifiers.

string
Full definition
{
  "type": "string",
  "example": "isEmail",
  "description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers."
}
messageRequired

Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included.

string
Full definition
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included."
}
translationValuesOptional

Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.

object
Full definition
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
  "example": {
    "exampleKey": "example"
  }
}
Full definition
{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "example": "email",
      "description": "Public field path. Nested properties and array indices are separated by dots."
    },
    "translationKey": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog."
    },
    "code": {
      "type": "string",
      "example": "isEmail",
      "description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers."
    },
    "message": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
      "example": {
        "exampleKey": "example"
      }
    }
  },
  "required": [
    "field",
    "translationKey",
    "code",
    "message"
  ],
  "description": "Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.",
  "example": {
    "field": "email",
    "translationKey": "validation:isEmail",
    "code": "isEmail",
    "message": "validation:isEmail"
  }
}
JsonValue

Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.

Full definition
{
  "oneOf": [
    {
      "type": "string",
      "nullable": true,
      "example": "example"
    },
    {
      "type": "number",
      "example": 0
    },
    {
      "type": "boolean",
      "example": true
    },
    {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": [
        "example"
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": {
        "exampleKey": "example"
      }
    }
  ],
  "description": "Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.",
  "example": "example"
}
TablePublicCommandConflictDto

Native QR command conflict caused by an in-flight or mismatched idempotency request, stale resource revision, changed join state, or unavailable native guest slot. Retry recovery retains the original command payload and authorization scope.

Full definition
{
  "description": "Native QR command conflict caused by an in-flight or mismatched idempotency request, stale resource revision, changed join state, or unavailable native guest slot. Retry recovery retains the original command payload and authorization scope.",
  "example": {
    "statusCode": 409,
    "error": "errors:http.conflict",
    "code": "TABLE_PUBLIC_REVISION_CONFLICT",
    "message": "errors:http.conflict",
    "translationKey": "errors:http.conflict"
  },
  "allOf": [
    {
      "$ref": "#/components/schemas/TranslatedErrorDto"
    },
    {
      "type": "object",
      "required": [
        "code"
      ],
      "properties": {
        "statusCode": {
          "type": "integer",
          "enum": [
            409
          ],
          "description": "HTTP 409 conflict status.",
          "example": 409
        },
        "code": {
          "type": "string",
          "enum": [
            "IDEMPOTENCY_REQUEST_NOT_READY",
            "IDEMPOTENCY_KEY_PAYLOAD_MISMATCH",
            "IDEMPOTENCY_REQUEST_IN_PROGRESS",
            "IDEMPOTENCY_SCOPE_INCOMPLETE",
            "TABLE_PUBLIC_REVISION_CONFLICT",
            "TABLE_PUBLIC_JOIN_STATE_CONFLICT",
            "TABLE_PUBLIC_SLOT_UNAVAILABLE"
          ],
          "description": "Stable idempotency or operation-specific domain conflict code.",
          "example": "IDEMPOTENCY_REQUEST_NOT_READY"
        }
      },
      "example": {
        "code": "IDEMPOTENCY_REQUEST_NOT_READY"
      }
    }
  ]
}

Hallify uses essential cookies and optional analytics.

Essential cookies keep sign-in, locale, and theme preferences working. Analytics is off until you choose to allow it.