YQueue DocsDevelopers

Schema

Availability Request

On create, omitted availability values default to available, valid from the current time with no end, permitted for all service types and touch points, with no schedule or outlet unavailability entries. On edit, including bulk edit, omitted availability values retain the existing values independently for each selected catalog model, subject to the outlet-unavailability behaviour described below.

  • Catalog

Overview

object · 6 properties · 0 required

Properties

available

boolean

validity

oneOf

On create, omission or `null` uses the default current-time, open-ended validity. On edit, omission or `null` retains the existing validity.

Nullable Yes
One of

One of 1

null

One of 2

reference

References Validity.

permitted_services

array
Array items

Items

reference

References Service Type.

permitted_touch_points

array
Array items

Items

reference

References Touch Point.

schedule

string | null

The UUID of a catalog schedule owned by the merchant. On edit, omission retains the existing schedule and `null` removes it.

Format uuid
Nullable Yes

outlet_unavailability_entries

array

On edit, supplying this property replaces all existing outlet-unavailability entries for each selected catalog model; omission retains each model's entries. Entries whose `until` value is not later than the time the request is processed are discarded. Outlet UUIDs must be unique and owned by the merchant. For merchants that do not support outlet-specific unavailability, supplied entries are ignored and existing entries are removed, including when this property is omitted.

Array items

Items

reference

References Outlet Unavailability.

Used by

Raw YAML
Download source
title: Availability Request
x-tags:
  - Catalog
type: object
description: |-
  On create, omitted availability values default to available, valid from the current time with no end, permitted for all service types and touch points, with no schedule or outlet unavailability entries.

  On edit, including bulk edit, omitted availability values retain the existing values independently for each selected catalog model, subject to the outlet-unavailability behaviour described below.
properties:
  available:
    type: boolean
  validity:
    description: On create, omission or `null` uses the default current-time, open-ended validity. On edit, omission or `null` retains the existing validity.
    oneOf:
      - type: 'null'
      - $ref: ./Validity.yaml
  permitted_services:
    type: array
    items:
      $ref: ./ServiceType.yaml
  permitted_touch_points:
    type: array
    items:
      $ref: ./TouchPoint.yaml
  schedule:
    type:
      - string
      - 'null'
    format: uuid
    description: The UUID of a catalog schedule owned by the merchant. On edit, omission retains the existing schedule and `null` removes it.
  outlet_unavailability_entries:
    type: array
    description: |-
      On edit, supplying this property replaces all existing outlet-unavailability entries for each selected catalog model; omission retains each model's entries. Entries whose `until` value is not later than the time the request is processed are discarded.

      Outlet UUIDs must be unique and owned by the merchant. For merchants that do not support outlet-specific unavailability, supplied entries are ignored and existing entries are removed, including when this property is omitted.
    items:
      $ref: ./OutletUnavailability.yaml

Search documentation

Search across this documentation site.