YQueue DocsDevelopers

Schema

Service Configuration

Represents the service-specific configuration in OMS.

  • OMS

Overview

object · 5 properties · 0 required

Properties

colour

string

The colour displayed on order tiles for orders with this service type.

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

new_orders_sound

oneOf

The sound that is played when a new order arrives with this service type.

Nullable Yes
One of

One of 1

null

One of 2

reference

References Sound.

new_orders_repeat_in_minutes

integer | null

The interval in which the sound will be repeated if the order is not actioned.

Minimum 1
Nullable Yes

action_required_sound

oneOf

The sound that is played when an action is required on an order with this service type.

Nullable Yes
One of

One of 1

null

One of 2

reference

References Sound.

action_required_repeat_in_minutes

integer | null

The interval in which the sound will be repeated if the order is not actioned.

Minimum 1
Nullable Yes

Used by

Raw YAML
Download source
title: Service Configuration
type: object
x-tags:
  - OMS
description: Represents the service-specific configuration in OMS.
properties:
  colour:
    type: string
    pattern: '^#?([A-F0-9]{6})$'
    description: The colour displayed on order tiles for orders with this service type.
  new_orders_sound:
    oneOf:
      - type: 'null'
      - $ref: ./Sound.yaml
    description: The sound that is played when a new order arrives with this service type.
  new_orders_repeat_in_minutes:
    type:
      - integer
      - 'null'
    minimum: 1
    description: The interval in which the sound will be repeated if the order is not actioned.
  action_required_sound:
    oneOf:
      - type: 'null'
      - $ref: ./Sound.yaml
    description: The sound that is played when an action is required on an order with this service type.
  action_required_repeat_in_minutes:
    type:
      - integer
      - 'null'
    minimum: 1
    description: The interval in which the sound will be repeated if the order is not actioned.

Search documentation

Search across this documentation site.