Queue Up

This page discuss the extended information for queuing up scenarios, please also check the base API.


Order Status

Notification can start from any status below and status can be skipped if necessary, but not in reverse.

Order Status

Description

Display Sample (Index Page)

CALL_NUM

When the customer start queuing up / number is updated.


**You should update this status every time a number is called.

image.png

NUMBER_ARRIVED

When the queue number matched.

image.png

Hide notification after 10 mins.

NUMBER_PASSED

When the queue number has already called.

image.png

Hide notification after 10 mins.

CANCELLED

When the queuing is cancelled.


**Only available in CALL_NUM status.

Hide notification.

FINISHED

When the service order is completed.

Hide notification.



Below is the extra fields of this scenario, please also check the base API fields.

Request parameters

shopInfo object  REQUIRED

Information of the shop.

Show child parameters

extInfo object  REQUIRED

Extended information of this service order.

Show child parameters

Response parameters

No request parameters.
API Explorer

Request

Request Body

Response

Response Body