YQueue DocsDevelopers

Schema

Product Group Request

On edit, omitted top-level properties retain their existing values.

  • Catalog

Overview

object · 5 properties · 0 required

Properties

name

string
Min length 1
Max length 255

tags

allOf

UUIDs of tags to associate with the product group.

All of

All of 1

reference

References Catalog UUID List.

categories

allOf

UUIDs of categories to associate with the product group. Only their direct items are included; specify child categories explicitly to include their items.

All of

All of 1

reference

References Catalog UUID List.

items

allOf

UUIDs of items to associate with the product group.

All of

All of 1

reference

References Catalog UUID List.

modifiers

allOf

UUIDs of modifiers owned by the merchant to associate explicitly with the product group. On edit, a supplied list replaces membership and an empty list clears it. Item and category membership do not imply modifier membership.

All of

All of 1

reference

References Catalog UUID List.

Used by

Raw YAML
Download source
title: Product Group Request
x-tags:
  - Catalog
type: object
description: On edit, omitted top-level properties retain their existing values.
properties:
  name:
    type: string
    minLength: 1
    maxLength: 255
  tags:
    allOf:
      - $ref: ./CatalogUuidList.yaml
    description: UUIDs of tags to associate with the product group.
  categories:
    allOf:
      - $ref: ./CatalogUuidList.yaml
    description: UUIDs of categories to associate with the product group. Only their direct items are included; specify child categories explicitly to include their items.
  items:
    allOf:
      - $ref: ./CatalogUuidList.yaml
    description: UUIDs of items to associate with the product group.
  modifiers:
    allOf:
      - $ref: ./CatalogUuidList.yaml
    description: UUIDs of modifiers owned by the merchant to associate explicitly with the product group. On edit, a supplied list replaces membership and an empty list clears it. Item and category membership do not imply modifier membership.

Search documentation

Search across this documentation site.