YQueue DocsDevelopers

Schema

Retail Configuration

Represents the retail configuration for an associated outlet.

  • Services

Overview

object · 4 properties · 0 required

Properties

enabled

boolean

Indicates if retail orders are supported by the outlet.

customer_details_configuration

reference

Controls which customer detail fields are required, optional, or disabled for retail orders.

References Customer Details Configuration.

allow_cross_outlet_collection

boolean

Indicates if cross-outlet collection is enabled. Currently, this feature is only used by Nippon Paint.

customer_questions

reference

The retail questionnaire. Collection defaults to disabled with no questions. When updating settings, omitting this field preserves the existing questionnaire. Supplying it replaces the complete questionnaire, including question and response ordering. Changes do not remove or relabel saved order answers.

References Customer Questions Configuration.

Used by

Raw YAML
Download source
title: Retail Configuration
x-tags:
  - Services
description: Represents the retail configuration for an associated outlet.
type: object
properties:
  enabled:
    type: boolean
    description: Indicates if retail orders are supported by the outlet.
  customer_details_configuration:
    $ref: ./CustomerDetailsConfiguration.yaml
    description: Controls which customer detail fields are required, optional, or disabled for retail orders.
  allow_cross_outlet_collection:
    type: boolean
    description: |-
      Indicates if cross-outlet collection is enabled.

      Currently, this feature is only used by Nippon Paint.
  customer_questions:
    $ref: ./CustomerQuestionsConfiguration.yaml
    description: |-
      The retail questionnaire. Collection defaults to disabled with no questions.

      When updating settings, omitting this field preserves the existing questionnaire. Supplying it replaces the complete questionnaire, including question and response ordering. Changes do not remove or relabel saved order answers.

Search documentation

Search across this documentation site.