YQueue DocsDevelopers

Schema

Item

Defines an item that may be ordered from a merchant.

  • Catalog

Overview

object · 26 properties · 26 required

Properties

uuid

string Required

The item's unique identifier.

Format uuid
Read only Yes

model_type

enum Required
Read only Yes

Allowed values

item

name

string Required

The item's name.

Example Latte
Min length 1
Max length 255

tags

array Required

The item's tags.

Unique items Yes
Array items

Items

string
Format uuid

media

oneOf Required

The media file that is associated with the item.

Nullable Yes
One of

One of 1

null

One of 2

reference

References Media.

media_uuid

string | null Required

The UUID of the media file to associate with the item. Catalog-management requests use this field to set or remove the association. Responses also include the resolved media file in `media`.

Format uuid
Nullable Yes

external_media_url

string | null Required

The URI of an external media file that is associated with the item. This field may be used when `media` is null as a fall-back to display a third-party asset in the application, such as an image hosted on the Deliverect CDN.

Format uri
Nullable Yes
Read only Yes

media_background_colour

string | null Required

The background colour that should be displayed behind (or in place of) media assets.

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

pricing

reference Required

References Pricing.

availability

reference Required

References Availability.

alternative_names

allOf Required
All of

All of 1

reference

References Alternative Names.

All of 2

object

dietary_tags

array Required

The dietary tags associated with the item.

Unique items Yes
Array items

Items

reference

References Dietary Tag.

description

string | null Required

The item's description.

Example The coffee for developers everywhere.
Min length 1
Max length 255
Nullable Yes

machine_readable_qr_code_data

string | null Required

The data that should be "baked into" machine readable QR codes for this product.

Example COFFEE-ESPRESSO
Min length 1
Max length 255
Nullable Yes

calories

integer | null Required

The calories associated with the item (if known).

Minimum 0
Nullable Yes

permit_upselling

boolean Required

Indicates if the item may be presented for upselling.

minimum_lead_time_in_minutes

integer | null Required

The lead time (in minutes) that this item requires.

Minimum 1
Maximum 45000
Nullable Yes

minimum_per_order_qty

integer Required

The minimum qty that is required for this item in any given order.

Minimum 0

maximum_per_order_qty

integer | null Required

The maximum qty that is permitted for this item in any given order.

Minimum 1
Nullable Yes

modifier_groups

array Required

The modifier groups that should be presented alongside the item.

Unique items Yes
Array items

Items

string
Format uuid

meals

array Required

The meals that should be presented alongside the item.

Unique items Yes
Array items

Items

string
Format uuid

food_court_outlet_route

string | null Required

The outlet that this item should be "routed to" when operating in a food court context. If the associated merchant is operating as a food court, this field cannot be _null_.

Format uuid
Nullable Yes

sku

string | null Required

The stock keeping unit (SKU) for this item.

Example COOLTSHIRT
Min length 1
Max length 255
Nullable Yes

barcodes

array Required

The barcodes associated with this item.

Min items 0
Max items 99
Unique items Yes
Array items

Items

string
Example ABC-DEF-1234
Min length 1
Max length 255

translations

object Required

The item's translated attributes.

Nested properties

name

allOf Required
All of
All of 1
reference

References Translation.

All of 2
object

description

allOf Required
All of
All of 1
reference

References Translation.

All of 2
object

created_at

string Required

The date-time that the item was created.

Format date-time
Read only Yes

Used by

Raw YAML
Download source
title: Item
x-tags:
  - Catalog
type: object
description: Defines an item that may be ordered from a merchant.
required:
  - uuid
  - model_type
  - name
  - tags
  - media
  - media_uuid
  - external_media_url
  - media_background_colour
  - pricing
  - availability
  - alternative_names
  - dietary_tags
  - description
  - machine_readable_qr_code_data
  - calories
  - permit_upselling
  - minimum_lead_time_in_minutes
  - minimum_per_order_qty
  - maximum_per_order_qty
  - modifier_groups
  - meals
  - food_court_outlet_route
  - sku
  - barcodes
  - translations
  - created_at
properties:
  uuid:
    type: string
    format: uuid
    description: The item's unique identifier.
    readOnly: true
  model_type:
    enum:
      - item
    readOnly: true
  name:
    type: string
    minLength: 1
    maxLength: 255
    description: The item's name.
    example: Latte
  tags:
    type: array
    uniqueItems: true
    description: The item's tags.
    items:
      type: string
      format: uuid
  media:
    oneOf:
      - type: 'null'
      - $ref: ./Media.yaml
    description: The media file that is associated with the item.
  media_uuid:
    type:
      - string
      - 'null'
    format: uuid
    description: |-
      The UUID of the media file to associate with the item.

      Catalog-management requests use this field to set or remove the association. Responses also include the resolved media file in `media`.
  external_media_url:
    type:
      - string
      - 'null'
    format: uri
    description: |-
      The URI of an external media file that is associated with the item.

      This field may be used when `media` is null as a fall-back to display a third-party asset in the application, such as an image hosted on the Deliverect CDN.
    readOnly: true
  media_background_colour:
    type:
      - string
      - 'null'
    description: The background colour that should be displayed behind (or in place of) media assets.
    example: '#F0F0F0'
    pattern: '^#(?:[A-Fa-f0-9]{3}|[A-Fa-f0-9]{6})$'
  pricing:
    $ref: ./Pricing.yaml
  availability:
    $ref: ./Availability.yaml
  alternative_names:
    allOf:
      - $ref: ./AlternativeNames.yaml
      - type: object
        required:
          - kitchen_slip
          - kitchen_display
  dietary_tags:
    type: array
    uniqueItems: true
    description: The dietary tags associated with the item.
    items:
      $ref: ./DietaryTag.yaml
  description:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
    example: The coffee for developers everywhere.
    description: The item's description.
  machine_readable_qr_code_data:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
    description: The data that should be "baked into" machine readable QR codes for this product.
    example: COFFEE-ESPRESSO
  calories:
    type:
      - integer
      - 'null'
    minimum: 0
    description: The calories associated with the item (if known).
  permit_upselling:
    type: boolean
    description: Indicates if the item may be presented for upselling.
  minimum_lead_time_in_minutes:
    type:
      - integer
      - 'null'
    description: The lead time (in minutes) that this item requires.
    minimum: 1
    maximum: 45000
  minimum_per_order_qty:
    type: integer
    minimum: 0
    description: The minimum qty that is required for this item in any given order.
  maximum_per_order_qty:
    type:
      - integer
      - 'null'
    minimum: 1
    description: The maximum qty that is permitted for this item in any given order.
  modifier_groups:
    type: array
    uniqueItems: true
    description: The modifier groups that should be presented alongside the item.
    items:
      type: string
      format: uuid
  meals:
    type: array
    uniqueItems: true
    description: The meals that should be presented alongside the item.
    items:
      type: string
      format: uuid
  food_court_outlet_route:
    type:
      - string
      - 'null'
    format: uuid
    description: |-
      The outlet that this item should be "routed to" when operating in a food court context.

      If the associated merchant is operating as a food court, this field cannot be _null_.
  sku:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
    example: COOLTSHIRT
    description: The stock keeping unit (SKU) for this item.
  barcodes:
    type: array
    minItems: 0
    uniqueItems: true
    description: The barcodes associated with this item.
    maxItems: 99
    items:
      type: string
      minLength: 1
      maxLength: 255
      example: ABC-DEF-1234
  translations:
    type: object
    description: The item's translated attributes.
    required:
      - name
      - description
    properties:
      name:
        allOf:
          - $ref: ./Translation.yaml
          - type: object
            required:
              - en
              - ms
              - zh
              - ta
              - hi
              - ja
              - ko
              - th
      description:
        allOf:
          - $ref: ./Translation.yaml
          - type: object
            required:
              - en
              - ms
              - zh
              - ta
              - hi
              - ja
              - ko
              - th
  created_at:
    type: string
    format: date-time
    description: The date-time that the item was created.
    readOnly: true

Search documentation

Search across this documentation site.