YQueue DocsDevelopers

Schema

Product Group

Represents a product group in the catalog.

  • Catalog

Overview

object · 8 properties · 8 required

Properties

uuid

string Required

The product group's unique identifier.

Format uuid
Read only Yes

model_type

enum Required
Read only Yes

Allowed values

product_group

name

string Required

The product group's name.

Example Breakfast Items
Min length 1
Max length 255

tags

array Required

The associated tags.

Unique items Yes
Array items

Items

string
Format uuid

categories

array Required

The associated categories. Only their directly associated items are included; sub-category links do not expand product group membership.

Unique items Yes
Array items

Items

string
Format uuid

items

array Required

The associated items.

Unique items Yes
Array items

Items

string
Format uuid

modifiers

array Required

Explicit modifier membership used by fixed product-group surcharges. Item and category membership do not implicitly include their modifiers.

Unique items Yes
Array items

Items

string
Format uuid

created_at

string Required

The date-time that the product group was created.

Format date-time
Read only Yes

Used by

Raw YAML
Download source
title: Product Group
x-tags:
  - Catalog
type: object
description: Represents a product group in the catalog.
properties:
  uuid:
    type: string
    format: uuid
    description: The product group's unique identifier.
    readOnly: true
  model_type:
    enum:
      - product_group
    readOnly: true
  name:
    type: string
    minLength: 1
    maxLength: 255
    description: The product group's name.
    example: Breakfast Items
  tags:
    type: array
    uniqueItems: true
    description: The associated tags.
    items:
      type: string
      format: uuid
  categories:
    type: array
    uniqueItems: true
    description: The associated categories. Only their directly associated items are included; sub-category links do not expand product group membership.
    items:
      type: string
      format: uuid
  items:
    type: array
    uniqueItems: true
    description: The associated items.
    items:
      type: string
      format: uuid
  modifiers:
    type: array
    uniqueItems: true
    description: Explicit modifier membership used by fixed product-group surcharges. Item and category membership do not implicitly include their modifiers.
    items:
      type: string
      format: uuid
  created_at:
    type: string
    format: date-time
    description: The date-time that the product group was created.
    readOnly: true
required:
  - uuid
  - model_type
  - name
  - tags
  - categories
  - items
  - modifiers
  - created_at

Search documentation

Search across this documentation site.