YQueue DocsDevelopers

Schema

Customer Questions Configuration

The ordered, single-choice questionnaire for retail orders. Applications control when questions are displayed and whether customers must answer them; the API allows orders without answers. Question and response UUIDs are supplied by the client. Retain UUIDs for unchanged entries when editing or reordering the questionnaire, and assign new UUIDs to new entries. No configuration history is stored.

  • Services

Overview

object · 2 properties · 2 required

Properties

enabled

boolean Required

Controls whether applications collect answers. Disabling collection does not remove saved order answers.

Default false

questions

array Required

Questions in display order. Question UUIDs must be distinct, ignoring case.

Max items 50
Array items

Items

object
Nested properties
uuid
string Required
Format uuid
text
string Required
Example Is this your first visit?
Min length 1
Max length 255
icon
string Required

Allowed values

one_customertwo_customersthree_customersnew_customertake_awaystored_valuestampsscan_qrretailreceiptpointsterminalloyalty_lightknife_and_forkerrorconfettilocation
prompted
string Required

The stage at which the application should ask the question.

Allowed values

before_menubefore_payment
responses
array Required

Permitted responses in display order. Response UUIDs must be distinct across the entire questionnaire, ignoring case.

Min items 1
Max items 50
Array items
Items
object
Nested properties
uuid
string Required
Format uuid
text
string Required
Example First visit
Min length 1
Max length 255

Used by

Raw YAML
Download source
title: Customer Questions Configuration
type: object
x-tags:
  - Services
description: |-
  The ordered, single-choice questionnaire for retail orders. Applications control when questions are displayed and whether customers must answer them; the API allows orders without answers.

  Question and response UUIDs are supplied by the client. Retain UUIDs for unchanged entries when editing or reordering the questionnaire, and assign new UUIDs to new entries. No configuration history is stored.
required:
  - enabled
  - questions
properties:
  enabled:
    type: boolean
    default: false
    description: Controls whether applications collect answers. Disabling collection does not remove saved order answers.
  questions:
    type: array
    maxItems: 50
    description: Questions in display order. Question UUIDs must be distinct, ignoring case.
    items:
      type: object
      additionalProperties: false
      required:
        - uuid
        - text
        - icon
        - prompted
        - responses
      properties:
        uuid:
          type: string
          format: uuid
        text:
          type: string
          minLength: 1
          maxLength: 255
          example: Is this your first visit?
        icon:
          type: string
          enum:
            - one_customer
            - two_customers
            - three_customers
            - new_customer
            - take_away
            - stored_value
            - stamps
            - scan_qr
            - retail
            - receipt
            - points
            - terminal
            - loyalty_light
            - knife_and_fork
            - error
            - confetti
            - location
        prompted:
          type: string
          enum:
            - before_menu
            - before_payment
          description: The stage at which the application should ask the question.
        responses:
          type: array
          minItems: 1
          maxItems: 50
          description: Permitted responses in display order. Response UUIDs must be distinct across the entire questionnaire, ignoring case.
          items:
            type: object
            additionalProperties: false
            required:
              - uuid
              - text
            properties:
              uuid:
                type: string
                format: uuid
              text:
                type: string
                minLength: 1
                maxLength: 255
                example: First visit

Search documentation

Search across this documentation site.