AlipayHKAlipayHKDOCS

How can we help?

Queue Up

{"content":{"bizType":"NOTIFICATION","endpoint":"api/open/alipay/intl/promotion/order/contractCardSync","hideEndpoint":true,"description":"

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.

","descriptionLake":"

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

Order Status


","titleTag":"","result":[],"more":"


","moreLake":"


","moreCodes":[],"request":[{"name":"shopInfo","description":"

Information of the shop.

","descriptionLake":"

Information of the shop.

","editType":"object","type":"object","warning":"","warningLake":"","required":true,"kvs":[{"name":"extInfo","description":"

Extended information of this shop.

","descriptionLake":"

Extended information of this shop.

","editType":"object","type":"object","warning":"","warningLake":"","required":true,"kvs":[{"name":"multiLang","description":"

An object providing business dedicated display information of different locale.

  • zh_HK: Traditional Chinese
  • en_US: English
","descriptionLake":"

An object providing business dedicated display information of different locale.

  • zh_HK: Traditional Chinese
  • en_US: English
","editType":"object","type":"object","warning":"","warningLake":"","required":true,"kvs":[{"name":"name","description":"

Display name of this shop.

","descriptionLake":"

Display name of this shop.

","editType":"string","type":"string","warning":"","warningLake":"","required":true},{"name":"address","description":"

Display address of this shop.

","descriptionLake":"

Display address of this shop.

","editType":"string","type":"string","warning":"","warningLake":""},{"name":"merchantShopLinkPage","description":"

An URL redirects to the shop, starts with allpayhk://.

","descriptionLake":"

An URL redirects to the shop, starts with allpayhk://.

","editType":"string","type":"string","warning":"","warningLake":"","required":true}]}]}]},{"name":"extInfo","description":"

Extended information of this service order.

","descriptionLake":"

Extended information of this service order.

","editType":"object","type":"object","warning":"","warningLake":"","required":true,"kvs":[{"name":"queue_number","description":"

The queue number of this order.

","descriptionLake":"

The queue number of this order.

","editType":"string","type":"string","warning":"","warningLake":"","required":true,"maxLength":8},{"name":"wait_tables","description":"

Number of tables before this order, should be 0 after status CALL_NUM

","descriptionLake":"

Number of tables before this order, should be 0 after status CALL_NUM

","editType":"string","type":"string","warning":"

This field should be dynamically updated.

","warningLake":"

This field should be dynamically updated.

","required":true,"maxLength":20},{"name":"wait_time","description":"

Estimated wait time of this order in minutes.

","descriptionLake":"

Estimated wait time of this order in minutes.

","editType":"string","type":"string","warning":"

This field should be dynamically updated.

","warningLake":"

This field should be dynamically updated.

"},{"name":"waiting_time","description":"

The waited time of this order in milliseconds.

","descriptionLake":"

The waited time of this order in milliseconds.

","editType":"string","type":"string","warning":"

This field should be dynamically updated.

","warningLake":"

This field should be dynamically updated.

"},{"name":"multiLang","description":"

An object providing business dedicated display information of different locale.

  • zh_HK: Traditional Chinese
  • en_US: English
","descriptionLake":"

An object providing business dedicated display information of different locale.

  • zh_HK: Traditional Chinese
  • en_US: English
","editType":"object","type":"object","warning":"","warningLake":"","required":true,"kvs":[{"name":"order_detail_link_url","description":"

URL reference to the details of this service order, starts with allpayhk://.

","descriptionLake":"

URL reference to the details of this service order, starts with allpayhk://.

","editType":"string","type":"string","warning":"","warningLake":"","required":true},{"name":"table_type","description":"

Type of table this order is queuing for.

","descriptionLake":"

Type of table this order is queuing for.

","editType":"string","type":"string","warning":"","warningLake":""},{"name":"show_merchant_name","description":"

Display merchant name on the card (title).

","descriptionLake":"

Display merchant name on the card (title).

","editType":"string","type":"string","warning":"","warningLake":"","required":true},{"name":"show_merchant_icon_url","description":"

An URL reference the display merchant icon (72 x 72px) on the card, starts with ​https://​

","descriptionLake":"

An URL reference the display merchant icon (72 x 72px) on the card, starts with https://

","editType":"string","type":"string","range":"<100 KB","warning":"","warningLake":"","required":true},{"name":"order_remark","description":"

Display remarks on the card, i.e. Valid within 30 minutes.

","descriptionLake":"

Display remarks on the card, i.e. Valid within 30 minutes.

","editType":"string","type":"string","warning":"

Maximum length: 14 Chinese characters, 23 English characters.

","warningLake":"

Maximum length: 14 Chinese characters, 23 English characters.

","required":true}]}]}],"response":[],"examples":[{"scene":[],"request":"{ \"shopInfo\": { \"extInfo\": { \"multiLang\": { \"zh_HK\": { \"name\": \"飛豬茶餐廳（銅鑼灣店）\", \"address\": \"香港銅鑼灣勿地臣街 1 號\" }, \"en_US\": { \"name\": \"Fliggy Cafe (CWB)\", \"address\": \"1 Matheson Street, Causeway Bay, Hong Kong\" } } } }, \"extInfo\": { \"queue_number\": \"A10\", \"wait_tables\": 3, \"multiLang\": { \"zh_HK\": { \"order_detail_link_url\": \"alipayhk://platformapi/startapp?appId=2102000032500019\", \"table_type\": \"1-2 人桌\", \"show_merchant_name\": \"香港支付寶\", \"show_merchant_icon_url\": \"https://mdn.alipayobjects.com/huamei_xfceij/afts/img/A*Wbi4SpWwX_IAAAAAAAAAAAAADgeDAQ/original\", \"order_remark\": \"過號 30 分鐘後，需要重新輪候\" }, \"en_US\": { \"order_detail_link_url\": \"alipayhk://platformapi/startapp?appId=2102000032500019\", \"table_type\": \"1-2 People\", \"show_merchant_name\": \"AlipayHK\", \"show_merchant_icon_url\": \"https://mdn.alipayobjects.com/huamei_xfceij/afts/img/A*Wbi4SpWwX_IAAAAAAAAAAAAADgeDAQ/original\", \"order_remark\": \"Expire after 30 minutes\" } } }}"}],"exampleResponse":[]},"sceneConfig":[{"name":"APP","items":[{"icon":"https://gw.alipayobjects.com/mdn/rms_b3f2c2/afts/img/A*g-x4R5biJnsAAAAAAAAAAAAAARQnAQ","name":"ALIPAY","width":70,"text":""},{"icon":"https://gw.alipayobjects.com/mdn/rms_b3f2c2/afts/img/A*oWi6R65CbmgAAAAAAAAAAAAAARQnAQ","name":"ALIPAY_HK","width":70,"text":""},{"icon":"https://gw.alipayobjects.com/mdn/rms_b3f2c2/afts/img/A*BGsoRLcqPFAAAAAAAAAAAAAAARQnAQ","name":"GCASH","width":70,"text":""},{"icon":"https://gw.alipayobjects.com/mdn/rms_b3f2c2/afts/img/A*3gswS6s147sAAAAAAAAAAAAAARQnAQ","name":"DANA","width":70,"text":""},{"icon":"https://gw.alipayobjects.com/mdn/rms_b3f2c2/afts/img/A*aN3iTZOdEhgAAAAAAAAAAAAAARQnAQ","name":"KAKAO_PAY","width":70,"text":""}]},{"name":"CLIENT","direction":"row","items":[{"name":"APP","icon":"https://gw.alipayobjects.com/mdn/rms_b3f2c2/afts/img/A*sHjISq1PKn8AAAAAAAAAAAAAARQnAQ","width":40},{"name":"H5","icon":"https://gw.alipayobjects.com/mdn/rms_b3f2c2/afts/img/A*cOz7T50g1I0AAAAAAAAAAAAAARQnAQ","width":40},{"name":"DESKTOP","icon":"https://gw.alipayobjects.com/mdn/rms_b3f2c2/afts/img/A*NKaIRq-KfQYAAAAAAAAAAAAAARQnAQ","width":40}]},{"name":"MERCHANT","items":[{"name":"INST","text":"机构商户"},{"name":"DIRECT","text":"直联商户"}]},{"name":"GRANT_TYPE","items":[{"name":"AUTHORIZATION_CODE","text":"AUTHORIZATION_CODE"},{"name":"REFRESH_TOKEN","text":"REFRESH_TOKEN"}]},{"name":"CREATE_MEMBERSHIP_CARD","items":[{"name":"WITH_USER_INFO","text":"With user information"},{"name":"WITHOUT_USER_INFO","text":"Without user information"}]},{"name":"COLLECT_PMS_INFORMATION","items":[{"name":"MERCHANT_PMS","text":"MERCHANT_PMS"},{"name":"IPAY_TRADE_NO","text":"IPAY_TRADE_NO"}]},{"name":"Card Type","items":[{"name":"COUPON","text":"COUPON"},{"name":"TICKET","text":"TICKET"}]},{"name":"Ticket Type","items":[{"name":"PASS","text":"PASS"},{"name":"MOVIE","text":"MOVIE"},{"name":"AIR TICKET","text":"AIR TICKET"},{"name":"TRAIN TICKET","text":"TRAIN TICKET"},{"name":"BUS TICKET","text":"BUS TICKET"},{"name":"SHIP TICKET","text":"SHIP TICKET"}]},{"name":"Display Code Type","items":[{"name":"BARCODE","text":"BARCODE"},{"name":"QR CODE","text":"QR CODE"},{"name":"PROMO CODE","text":"PROMO CODE"},{"name":"NONE","text":"NONE"}]},{"name":"Card Status","items":[{"name":"USED","text":"USED"},{"name":"CLOSED","text":"CLOSED"},{"name":"UPDATE","text":"UPDATE"},{"name":"REFUND","text":"REFUND"}]}]}