YQueue DocsDevelopers

Schema

Item Request

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

  • Catalog

Overview

object · 21 properties · 0 required

Properties

name

string
Example Latte
Min length 1
Max length 255

tags

allOf

UUIDs of tags to associate with the item.

All of

All of 1

reference

References Catalog UUID List.

media_uuid

string | null

The UUID of an image or video in the merchant's media library. Supply `null` to remove existing media.

Format uuid
Nullable Yes

media_background_colour

string | null
Example #F0F0F0
Pattern ^#(?:[A-Fa-f0-9]{3}|[A-Fa-f0-9]{6})$
Nullable Yes

pricing

object
Nested properties

base

allOf Required
All of
All of 1
reference

References Money.

All of 2
object
Nested properties
amount
schema
Minimum 0
Maximum 4294967295
currency
schema

Must match the merchant's ISO 4217 currency code.

take_away

oneOf
Nullable Yes
One of
One of 1
null
One of 2
allOf
All of
All of 1
reference

References Money.

All of 2
object
Nested properties
amount
schema
Minimum 0
Maximum 4294967295
currency
schema

Must match the merchant's ISO 4217 currency code.

dine_in

oneOf
Nullable Yes
One of
One of 1
null
One of 2
allOf
All of
All of 1
reference

References Money.

All of 2
object
Nested properties
amount
schema
Minimum 0
Maximum 4294967295
currency
schema

Must match the merchant's ISO 4217 currency code.

delivery

oneOf
Nullable Yes
One of
One of 1
null
One of 2
allOf
All of
All of 1
reference

References Money.

All of 2
object
Nested properties
amount
schema
Minimum 0
Maximum 4294967295
currency
schema

Must match the merchant's ISO 4217 currency code.

retail

oneOf
Nullable Yes
One of
One of 1
null
One of 2
allOf
All of
All of 1
reference

References Money.

All of 2
object
Nested properties
amount
schema
Minimum 0
Maximum 4294967295
currency
schema

Must match the merchant's ISO 4217 currency code.

membership

oneOf
Nullable Yes
One of
One of 1
null
One of 2
allOf
All of
All of 1
reference

References Money.

All of 2
object
Nested properties
amount
schema
Minimum 0
Maximum 4294967295
currency
schema

Must match the merchant's ISO 4217 currency code.

availability

reference

References Availability Request.

alternative_names

reference

References Alternative Names.

dietary_tags

array
Unique items Yes
Array items

Items

reference

References Dietary Tag.

description

string | null
Min length 1
Max length 255
Nullable Yes

machine_readable_qr_code_data

string | null
Min length 1
Max length 255
Nullable Yes

calories

integer | null
Minimum 0
Nullable Yes

permit_upselling

boolean

minimum_lead_time_in_minutes

integer | null
Minimum 1
Maximum 45000
Nullable Yes

minimum_per_order_qty

integer

Must not exceed a supplied `maximum_per_order_qty`. On edit, when the maximum is omitted, this value must not exceed the existing maximum.

Minimum 0

maximum_per_order_qty

integer | null

A non-null value must be supplied together with `minimum_per_order_qty` and must be greater than or equal to it.

Minimum 1
Nullable Yes

modifier_groups

allOf

UUIDs of modifier groups to associate with the item.

All of

All of 1

reference

References Catalog UUID List.

meals

allOf

UUIDs of meals to associate with the item.

All of

All of 1

reference

References Catalog UUID List.

food_court_outlet_route

string

Must identify an eligible secondary outlet owned by the merchant. Required on create for food-court merchants. On edit, it is required only when the item does not already have a route; omitting it otherwise retains the existing route. Prohibited for non-food-court merchants.

Format uuid

sku

string | null
Min length 1
Max length 255
Nullable Yes

barcodes

array
Max items 99
Unique items Yes
Array items

Items

string
Min length 1
Max length 255

translations

object
Nested properties

name

reference

References Translation.

description

reference

References Translation.

Used by

Raw YAML
Download source
title: Item 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
    example: Latte
  tags:
    allOf:
      - $ref: ./CatalogUuidList.yaml
    description: UUIDs of tags to associate with the item.
  media_uuid:
    type:
      - string
      - 'null'
    format: uuid
    description: The UUID of an image or video in the merchant's media library. Supply `null` to remove existing media.
  media_background_colour:
    type:
      - string
      - 'null'
    pattern: '^#(?:[A-Fa-f0-9]{3}|[A-Fa-f0-9]{6})$'
    example: '#F0F0F0'
  pricing:
    type: object
    required:
      - base
    properties:
      base:
        allOf:
          - $ref: ./Money.yaml
          - type: object
            properties:
              amount:
                minimum: 0
                maximum: 4294967295
              currency:
                description: Must match the merchant's ISO 4217 currency code.
      take_away:
        oneOf:
          - type: 'null'
          - allOf:
              - $ref: ./Money.yaml
              - type: object
                properties:
                  amount:
                    minimum: 0
                    maximum: 4294967295
                  currency:
                    description: Must match the merchant's ISO 4217 currency code.
      dine_in:
        oneOf:
          - type: 'null'
          - allOf:
              - $ref: ./Money.yaml
              - type: object
                properties:
                  amount:
                    minimum: 0
                    maximum: 4294967295
                  currency:
                    description: Must match the merchant's ISO 4217 currency code.
      delivery:
        oneOf:
          - type: 'null'
          - allOf:
              - $ref: ./Money.yaml
              - type: object
                properties:
                  amount:
                    minimum: 0
                    maximum: 4294967295
                  currency:
                    description: Must match the merchant's ISO 4217 currency code.
      retail:
        oneOf:
          - type: 'null'
          - allOf:
              - $ref: ./Money.yaml
              - type: object
                properties:
                  amount:
                    minimum: 0
                    maximum: 4294967295
                  currency:
                    description: Must match the merchant's ISO 4217 currency code.
      membership:
        oneOf:
          - type: 'null'
          - allOf:
              - $ref: ./Money.yaml
              - type: object
                properties:
                  amount:
                    minimum: 0
                    maximum: 4294967295
                  currency:
                    description: Must match the merchant's ISO 4217 currency code.
  availability:
    $ref: ./AvailabilityRequest.yaml
  alternative_names:
    $ref: ./AlternativeNames.yaml
  dietary_tags:
    type: array
    uniqueItems: true
    items:
      $ref: ./DietaryTag.yaml
  description:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
  machine_readable_qr_code_data:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
  calories:
    type:
      - integer
      - 'null'
    minimum: 0
  permit_upselling:
    type: boolean
  minimum_lead_time_in_minutes:
    type:
      - integer
      - 'null'
    minimum: 1
    maximum: 45000
  minimum_per_order_qty:
    type: integer
    minimum: 0
    description: Must not exceed a supplied `maximum_per_order_qty`. On edit, when the maximum is omitted, this value must not exceed the existing maximum.
  maximum_per_order_qty:
    type:
      - integer
      - 'null'
    minimum: 1
    description: A non-null value must be supplied together with `minimum_per_order_qty` and must be greater than or equal to it.
  modifier_groups:
    allOf:
      - $ref: ./CatalogUuidList.yaml
    description: UUIDs of modifier groups to associate with the item.
  meals:
    allOf:
      - $ref: ./CatalogUuidList.yaml
    description: UUIDs of meals to associate with the item.
  food_court_outlet_route:
    type: string
    format: uuid
    description: |-
      Must identify an eligible secondary outlet owned by the merchant.

      Required on create for food-court merchants. On edit, it is required only when the item does not already have a route; omitting it otherwise retains the existing route. Prohibited for non-food-court merchants.
  sku:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
  barcodes:
    type: array
    maxItems: 99
    uniqueItems: true
    items:
      type: string
      minLength: 1
      maxLength: 255
  translations:
    type: object
    properties:
      name:
        $ref: ./Translation.yaml
      description:
        $ref: ./Translation.yaml

Search documentation

Search across this documentation site.