YQueue DocsDevelopers

Schema

Pickup Display Column

Represents the configuration of a column rendered in the pickup display.

  • Pickup Display

Overview

object · 3 properties · 3 required

Properties

heading

string Required

The display name of the heading.

Example In Kitchen
Min length 1
Max length 255

order_statuses

array Required

The order statuses that should be matched.

Min items 1
Unique items Yes
Array items

Items

enum

Allowed values

pending_acceptanceassigning_driverscheduledin_kitchenpackingpending_collectionen_route

background_colour

string Required

The background colour of the column.

Example #F0F0F0
Pattern ^#?([A-F0-9]{6})$

Used by

Raw YAML
Download source
title: Pickup Display Column
type: object
required:
  - heading
  - order_statuses
  - background_colour
properties:
  heading:
    type: string
    minLength: 1
    maxLength: 255
    example: In Kitchen
    description: The display name of the heading.
  order_statuses:
    type: array
    uniqueItems: true
    minItems: 1
    description: The order statuses that should be matched.
    items:
      enum:
        - pending_acceptance
        - assigning_driver
        - scheduled
        - in_kitchen
        - packing
        - pending_collection
        - en_route
  background_colour:
    type: string
    pattern: '^#?([A-F0-9]{6})$'
    example: '#F0F0F0'
    description: The background colour of the column.
description: Represents the configuration of a column rendered in the pickup display.
x-tags:
  - Pickup Display

Search documentation

Search across this documentation site.