YQueue DocsDevelopers

Schema

Customer Details Configuration

Controls whether the name, phone_number, and email_address fields are required, optional, or disabled when a customer provides their details at checkout.

  • Foundation

Overview

object · 3 properties · 3 required

Properties

name

string Required

Controls whether the customer's name is required, optional, or not collected.

Allowed values

mandatoryoptionaldisabled

phone_number

string Required

Controls whether the customer's phone number is required, optional, or not collected.

Allowed values

mandatoryoptionaldisabled

email_address

string Required

Controls whether the customer's email address is required, optional, or not collected.

Allowed values

mandatoryoptionaldisabled

Used by

Raw YAML
Download source
title: Customer Details Configuration
type: object
x-tags:
  - Foundation
description: |-
  Controls whether the `name`, `phone_number`, and `email_address` fields are required, optional, or disabled
  when a customer provides their details at checkout.
required:
  - name
  - phone_number
  - email_address
properties:
  name:
    type: string
    enum:
      - mandatory
      - optional
      - disabled
    description: Controls whether the customer's name is required, optional, or not collected.
  phone_number:
    type: string
    enum:
      - mandatory
      - optional
      - disabled
    description: Controls whether the customer's phone number is required, optional, or not collected.
  email_address:
    type: string
    enum:
      - mandatory
      - optional
      - disabled
    description: Controls whether the customer's email address is required, optional, or not collected.

Search documentation

Search across this documentation site.