v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB

Tracking Events

Sets a tracking event to record that a patron has opened a link on their own device to view a digital representation of their order

This endpoint would be used by the web or mobile app that is opened on the patron's device after they have scanned the order confirmation QR code on the Kiosk.

Note: This tracking event will not be permanently stored. It will expire after 10 minutes.

Licenses Required

Vista.Ocapi

put/ocapi/v1/tracking-events/completed-order-link-opened/{trackingId}

Path parameters

trackingIdstring required

The identifier of the tracking event, typically the unique identifier of the completed order base that is being monitored

Headers

Connect-Region-Codestring

Region Code

Response

Completed order link opened event has been stored.