1

POS & Platform Integration: Technical Overview

This guide summarizes all relevant API endpoints, technical requirements, and key recommendations for a successful integration.

MERGEPORT

Last Update 2 месяца назад

API Documentation

Key API Endpoints

EndpointDescriptionURL
GetOrdersRetrieves all active orders for the restaurant https://ordering.mergeport.com/v4/documentation#operation/GetOrders
SetOrderStateUpdates the order status (e.g., “acceptedByPos”) https://ordering.mergeport.com/v4/documentation#operation/SetOrderState
SetPosItemsSends item data from the POS to MERGEPORT (mandatory for item sync) https://ordering.mergeport.com/v4/documentation#operation/SetPosItems
DeletePosItemDeletes outdated items (optional)https://ordering.mergeport.com/v4/documentation#operation/DeletePosItem

Technical Requirements & Checklist

Supported Order Types (Required)


  • Delivery

  • Pickup

  • Dine-in (table orders)


Status Handling & Allowed Transitions (Required)


  • acceptedByPos is mandatory (e.g. triggers "Preparation started" SMS on Lieferando); can be set automatically or manually

  • Other supported statuses: rejectedByPos, canceledByProvider, readyForPickup

  • Each order’s order.possibleStateChanges defines allowed transitions

  • timeChange: true/false allows adjusting delivery time


Handling Unknown Items (Required for platforms without item sync)


Some platforms (e.g. Lieferando) do not support item sync. Manual mapping is required.


Recommended strategies:

  • Map to a generic fallback item

  • Manual assignment in POS

  • Automatic name-based matching

  • Create item with name/price, apply highest tax rate, and flag for correction


Delivery Time Handling (Recommended)


Flexible options:

  • Static delivery time from POS configuration

  • Dynamic per order via timeChange


Additional Charges (Required)
  • Discounts

  • Delivery fees

  • Tip

Item Data & Synchronization (Required for platforms with item sync)


Sync methods:

  • Automatically on change

  • Periodically (e.g. daily)

  • Manually by the user


Structure & fields:

  • parentIds: links variants/toppings to the main item

  • options: defines item options and selection groups

  • categoryIds: assigns items to categories

  • Menus: technically supported, but currently not recommended (not actively used)

Item Synchronization

Some platforms (especially self-ordering solutions) support item synchronization. They fetch the menu directly from MERGEPORT (populated from the POS system) to build their menu.


⚠️ Important:
Other platforms like Lieferando do not support item sync. In that case:

  • Menu must be maintained manually on the platform

  • posItemId must be set on the platform side

  • Unknown incoming items should be handled via a fallback strategy (recommended)


In general, POS item data is not ideal for consumer-facing menus, as important fields like images, descriptions, and allergens are often missing.

➡️ We recommend managing your delivery menus directly on the platforms for the best customer experience.
MERGEPORT treats the POS system as the “source of truth” for all structured item data.

Item Structure in Orders
  • internalId: ID used by MERGEPORT

  • orderItemId: ID of the item within the order

  • posItemId: POS ID or platform-assigned item ID

After Integration

  • Automatically connected to all major platforms:
    👉 mergeport.com/integrate

  • Test stores available upon request (e.g. Lieferando, Wolt)



📨 Technical contact for integration:
support@mergeport.com


🔧 MERGEPORT Controller:
https://controller.mergeport.com

Was this article helpful?

0 out of 0 liked this article

Still need help? Message Us