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
