YQueue DocsDevelopers

Schema

Customer Question Answer

A saved answer to a retail customer question. The labels are captured from the outlet's configuration when the response is accepted and remain available after its definition is edited or deleted. Submitting the same response UUID again leaves the captured labels unchanged. Clearing an answer removes it from the order's answer list.

  • Orders

Overview

object · 4 properties · 4 required

Properties

question_uuid

string Required
Format uuid

response_uuid

string Required
Format uuid

question_text

string Required
Example Is this your first visit?

response_text

string Required
Example First visit

Used by

Raw YAML
Download source
title: Customer Question Answer
type: object
x-tags:
  - Orders
description: |-
  A saved answer to a retail customer question. The labels are captured from the outlet's configuration when the response is accepted and remain available after its definition is edited or deleted.

  Submitting the same response UUID again leaves the captured labels unchanged. Clearing an answer removes it from the order's answer list.
required:
  - question_uuid
  - response_uuid
  - question_text
  - response_text
properties:
  question_uuid:
    type: string
    format: uuid
  response_uuid:
    type: string
    format: uuid
  question_text:
    type: string
    example: Is this your first visit?
  response_text:
    type: string
    example: First visit

Search documentation

Search across this documentation site.