Table of Contents

📄 Changelog

All notable changes to this API will be documented in this file.

[1.0.4] – 2026-07-06

🔄 Changed

  • Update the Service section in Order creation and Order Model Reference to reflect the code with [Type] and [OrderType].

[1.0.3] – 2026-06-29

✨ Added

  • Add expected http headers attributes in API reference
  • Add OrderDto schema in downloadable OpenApi Spec

🔄 Changed

  • Update OpenApi Spec to 3.1.1

[1.0.2] – 2026-05-26

✨ Added

Added support for promotion mapping in Create Order payload.

  • Added Promotions field in the Items array to reference applied promotions.
  • Added AppliedPromotionId and Type fields in the Promotions object.

Updated Model Definitions Items

  • Id: Item identifier from the POS.
  • Name: Item name.
  • Language: UEAT will always send the POS name coming from the synchronization.
  • Quantity: Number of units ordered. See Quantity Management for complex use cases.
  • UnitPrice: Price in cents (undiscounted).
  • Modifiers: Array of modifier items.
  • Promotions: [AppliedPromotionId] — references promotions applied to the item.
  • Note: Optional note for the item (e.g., cooking instructions).

Promotions

  • AppliedPromotionId: Identifier of the promotion application.
    • Not the POS promotion ID.
    • Used for diagnostic/logging purposes.
  • Name: Promotion name.
  • Amount: Discount amount in cents.
  • Type: Enum (Item, Cart, Delivery).

🔄 Changed

  • Promotions are now explicitly linked between the global Promotions array and individual items.
  • The promotion model now supports multi-scope discounts:
    • Item-level
    • Cart-level
    • Delivery-level

💡 Impact

  • POS integrations must:

    • Read Promotions at both root level and item level.
    • Use AppliedPromotionId to map item discounts correctly.
    • Support multiple promotion types and scopes.

  • Enables:

    • Precise discount attribution per item
    • Better observability and debugging via logs
    • Support for stacked promotions (item + cart + delivery)

⚠️ Notes

  • AppliedPromotionId is not a POS identifier and must not be mapped as such.
  • Item-level promotions are referenced in the item but defined globally.
  • Financial totals (Payment) already include all applied promotions.

[1.0.1] – 2026-05-13

✨ Added

Added the ParentCategoryId field to the Categories object in the Menu Synchronization payload.

🔄 Changed

ParentCategoryId is now explicitly included in all category objects.

Supports hierarchical menu structures (parent / subcategories). When no parent exists, the value must be set to null.

💡 Impact

Enables proper representation of subcategories in menu structures. POS partners should:

Populate ParentCategoryId when categories are nested. Explicitly send null for top-level categories.

⚠️ Notes

This change ensures consistency and avoids ambiguity in category hierarchy handling.