Returns an HTTP status code that indicates whether 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 Kiosk via short-polling to see if the order confirmation QR code has been scanned yet, so it knows when to auto-dismiss the prompt for the patron to scan the QR code.

Once the tracking event expiry (of 10 minutes) elapses this endpoint will no longer retain a record of this event and will continue returning Microsoft.AspNetCore.Http.StatusCodes.Status202Accepted again, as if the event was not set.

Licenses Required

  • Vista.Ocapi
Request
path Parameters
trackingId
required
string

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

header Parameters
Connect-Region-Code
string

Region Code

Responses
202

Completed order link opened event not found, client can keep polling.

204

Completed order link has been opened, client can auto-dismiss the prompt to scan the QR code.

get/ocapi/v1/tracking-events/completed-order-link-opened/{trackingId}
Request samples