Orders - Models - Item

Key	Type	Example Value	Description
name	string	Veggie Pizza 123	REQUIRED- Item name here
partners_uuid	string	97-34-3534	OPTIONAL - This is your unique order item reference number from your internal system. This should be unique across all items of an order
category	string	Pizza	List of categories include Pizza, Salad, etc
addons_type	string	pizza	OPTIONAL - Specify the type of addons can only be pizza or empty string
addons	Array or Hash	[ "chilli sauce", "cheese", "nachos" ], {"whole": ["chicken"]}	This should be an array of strings or hash to specify pizza addons(whole, left, right). The latter requires addons_type to be set to pizza
quantity	number	1	number of this item
special_instructions	string	"more cheese"	Add any special instructions for the item
display_on_kds	boolean	true	Specify if this item should be displayed on the KDS application, true by default.
price	decimal	12.34	price of this item
cookable	boolean	true	Specify if this item is cookable, true by default.
display_names	Hash	Item Display Names	Optional - Localized display names for the item
addons_display_names	Hash	Addons Display Names	Optional - Localized display names for addons

Display Names Structure

Item Display Names

The display_names field accepts a hash with context-specific localized names:

{
  "customer": { "en": "Large Pizza", "fr": "Grande Pizza" },
  "internal": { "en": "LG PZ", "fr": "GR PZ" }
}

• internal: Used in Kitchen Display Systems (KDS) - typically abbreviated
• customer: Reserved for future customer-facing displays

Addons Display Names

The addons_display_names field follows the same pattern, keyed by addon identifier which must match the value in the addons field:

{
  "chicken": {
    "customer": { "en": "Chicken", "fr": "Poulet" },
    "internal": { "en": "CHK", "fr": "PLT" }
  }
}

Language Codes

Both display name structures use ISO 639-1 language codes:

• en: English translations
• fr: French translations

Additional language codes can be added as needed (e.g., es for Spanish, de for German). The system will fall back to a default language if a requested locale is not available.

Example Item

{
  "name": "Veggie Pizza 123",
  "partners_uuid": "97-34-3534",
  "category": "Salad",
  "addons_type": "",
  "quantity": 1,
  "special_instructions": "make sure it fresh",
  "display_on_kds": true,
  "price": "12.34",
  "cookable": true,
  "display_names": {
    "customer": { "en": "Veggie Pizza 123", "fr": "Pizza Végétarienne 123" },
    "internal": { "en": "VEG PZ 123", "fr": "PZ VEG 123" }
  }
}

Example Item - Pizza Addons

{
  "name": "Meat Pizza 123",
  "partners_uuid": "97-34-3534",
  "category": "pizza",
  "addons_type": "pizza",
  "addons": {
    "whole": ["vegan cheese"],
    "left": ["tuna", "cucumbers"],
    "right": ["steak", "mayo"]
  },
  "quantity": 1,
  "special_instructions": "extra steak please",
  "display_on_kds": true,
  "price": "12.34",
  "cookable": true,
  "display_names": {
    "customer": { "en": "Meat Pizza 123", "fr": "Pizza à la Viande 123" },
    "internal": { "en": "MT PZ 123", "fr": "PZ VND 123" }
  },
  "addons_display_names": {
    "vegan cheese": {
      "customer": { "en": "vegan cheese", "fr": "fromage végétalien" },
      "internal": { "en": "VGN CHZ", "fr": "FRM VGN" }
    },
    "tuna": {
      "customer": { "en": "tuna", "fr": "thon" },
      "internal": { "en": "TUNA", "fr": "THON" }
    },
    "cucumbers": {
      "customer": { "en": "cucumbers", "fr": "concombres" },
      "internal": { "en": "CUC", "fr": "CONC" }
    },
    "steak": {
      "customer": { "en": "steak", "fr": "steak" },
      "internal": { "en": "STK", "fr": "STK" }
    },
    "mayo": {
      "customer": { "en": "mayo", "fr": "mayo" },
      "internal": { "en": "MAYO", "fr": "MAYO" }
    }
  }
}