What's New

2024-11-29 08:04

What's New provides you with new, enhanced, or deleted product features and system capabilities.

2024-11-29

Document improvements

Add the Mini program template management section.

2024-11-08

Document improvements

Updated the onboarding link for Alipay+ merchants. For more information, see Alipay+ merchant onboarding.

2024-11-01

Enhanced features

Enabled the super app to delete their created features. For more information, refer to the function description of Features.

2024-10-18

Document improvements

In the Developer's Guide:

Remove the reset parameter in the my.setNavigationBar JSAPI.

2024-10-11

Document improvements

In the Developer's Guide:

Add the my.isCollected JSAPI.
Add the my.getMenuButtonBoundingClientRect JSAPI.

2024-09-29

Enhanced features

Optimize to configure the authorization list for server domains and WAP URLs to access to servers and WAP web pages. For details, see Authorized WAP URLs for Mini Programs and Configure mini programs in Platform Users Guide.

Document improvements

Optimize the Error Code table for the my.request JSAPI.

2024-09-20

Enhanced features

Optimize to configure the authorization list for WAP URLs to access WAP web pages and configure the authorization list for server domains to access data. For details, see Authorized WAP URLs for Mini Programs and Configure mini programs in Platform Users Guide.

2024-09-06

Document improvements

In Platform User's Guide:

Added the Manage mini program update mode topic.
Added the Restricted WAP URLs for Mini Programs section in Settings.

2024-08-30

New features

Support to configure the authorization list for WAP URLs to access WAP web pages. For details see Configure mini programs in Platform Users Guide.

Document improvements

Add the IDE base libraries document, including IDE version 2.x upgrade document.

2024-08-23

New features

Provide three mini program update modes: Default mode, Async mode, and Sync mode. For details see Mini program update mechanism.

2024-06-28

Enhanced features

Support 5G as the network type. For more information, refer to my.getNetworkType.

2024-04-03

New features

Released the mini-program rating feature to allow users to provide star ratings and written reviews for mini programs. For more information, refer to Rating.

2024-02-29

New features

Added the cover-view component to enable mini-program developers to overlay text views on top of native components to provide informative texts. For more information, refer to cover-view.

Document improvements

Added the Customize fonts topic to introduce how to customize fonts in mini programs.

2024-02-27

Enhanced features

Improved the QR code generating feature to allow more flexibility in creating a QR code by changing the following fields from required to optional:

URL Parameter
Query Parameter

For more information, refer to Generate QR codes.

2024-02-02

Enhanced features

Improved the my.uploadFile JSAPI as follows:

Deprecated the fileType request parameter.
Added the timeout request parameter to enable mini-program developers to set a timeout period for requests.
Added the hideLoading request parameter to enable mini-program developers to customize the display of a loading icon during the uploading process.

For more information, refer to my.uploadFile.

Document improvements

Updated the description for the header request parameter of the my.uploadFile JSAPI to clarify the usage. For more information, refer to my.uploadFile.

2024-01-31

New features

Released MiniProgram Command-line Interface (MiniProgram CLI) to enable mini-program developers to automate their development process. For more information, refer to MiniProgram Command-line Interface.

2024-01-09

New features

Released the biometric authentication feature to allow mini programs to authenticate users based on their biometrics. For more information, refer to Biometric authentication API overview.

2023-11-17

Enhanced features

Added the enableCookie request parameter to the my.request JSAPI, enabling the choice to use or ignore the cookie request header. For more information, refer to my.request.

2023-10-13

Deprecated features

For the syncStore API, deprecated the defaultLang parameter in the MultiLanguageText data model. For more information about how multiple languages are displayed, refer to the description of the value parameter in the MultiLanguageText data model.

2023-09-15

Enhanced features

For the syncStore API, added the salesChannel key to the store.menus.categories.extendInfo parameter to support the display of different categories on different sales channels.
For mini programs that are released to AlipayCN, merchants can apply for the message template at an earlier stage of the release process. For more information, refer to Step 1: Get template code in Message sending.

2023-09-01

New features

Released the subpackage loading feature to improve the mini program launch speed. For more information, refer to Subpackage loading.

2023-07-06

Enhanced features

For the syncStore API, added the commonItemId parameter in the Item data model. For more information, see Item in Data dictionary.

Document improvements

For the syncStore API, updated the description of the itemId parameter in the Item data model to clarify how to specify this parameter. For more information, see Item in Data dictionary.
For the notifyOrderChange API (release 1 / release 2):

Updated the description of how removing, updating, adding, or replacing items in an order changes the order amount, and moved it from the corresponding sample codes to the notes in the opening paragraph.
Updated the description of the adjustAmount request parameter to clarify how the adjustment is determined.
Added a request sample for updating item quantity, which is nested in the Update item section.

2023-06-01

New features

Released the my.createLivePlayerContext JSAPI to enable mini programs to stream live videos.
Added the download app resources feature in the tenant workspace to simplify the integration. For more information, refer to the Download app resources section of Manage apps.

Enhanced features

For the createOrder API (release 1 / release 2), added the extendInfo.orderMode and the extendInfo.payTypes request parameters to enhance the eat-before-payment feature.
For order-related APIs, changed the OrderItem.categoryId parameter from required to optional and clarified when to specify it.

Document improvements

Updated Manage apps to introduce the edit app information feature and how to add or delete an app.
For the createOrder API (release 1 / release 2), added a request sample for creating an eat-before-payment order.

2023-04-28

New features

Released the updateCardDetail, sendVerificationCode, and checkVerificationCode APIs to enhance the functions regarding membership.

Enhanced features

To enhance the functions regarding membership, updated the following APIs:

For the notifyCardRegistration API, added the following enum values to the registrationFields.fieldCode request parameter:

USER_SALUATION
PASSWORD

For the inquireCardDetail API:

Added the appId and loginIdentity request parameters.
Updated the cardNo request parameter from Required to Optional.
Added the following enum values to the cardFields.fieldCode response parameter:

FIRST_NAME
LAST_NAME
USER_NAME
USER_SALUATION
GENDER
BIRTH_DATE
MOBILE_PHONE
EMAIL
PASSWORD

Added a code sample about querying card details based on loginIdentity.

For the inquireMemberAssets and topup APIs, added the EXPIRED_CRM_BIND_TOKEN error code.

2023-04-18

Enhanced features

To support orders in the eat-before-payment scenarios, updated the following APIs:

For the createOrder API (Release 1 / Release 2), added the extendInfo.mainOrderId request parameter.
For the notifyOrderChange API (Release 1 / Release 2):

Added the adjustAmount request parameter.
Added the FULFILLMENT_COMPLETED enum value to the orderStatus request parameter, which is applicable when the value of orderType is DINEIN.

For the inquireOrderDetail API (Release 1 / Release 2), added the FULFILLMENT_COMPLETED enum value to the orderStatus request parameter, which is applicable when the value of orderType is DINEIN.

2023-03-03

New features

Released the solution for SaaS providers to support both local acquiring type and cross-border acquiring type in a mini program. For more information, see Scenario-oriented payment options.
Released the my.createVideoContext JSAPI to enable mini programs to play videos.

Enhanced features

Updated the latitude and longitude parameters in the AddressInfo object from Required to Optional, which affects the createOrder (Release 1 / Release 2) API.

2023-02-10

Enhanced features

The syncStore API is enhanced as follows:

Added the sequence parameter to the Items object and a use case on how to specify this parameter. For more information, see Set item or modifier group sequence.
Updated the description of the store.brandId parameter to clarify its application scenarios. For more information, see Store.

2023-02-03

New features

Released the consult API for D-store Platform to request the SaaS provider or ISV to calculate order price. For more information, see consult.

Enhanced features

Added the following request parameters to the createOrder API (Release 1 / Release 2):

extendInfo.consultId
extendInfo.brandId

Added the modifierGroupDetailObjects parameter to the OrderItem model to improve integration efficiency.

2022-12-23

New features

Released the my.chooseVideo JSAPI to enable mini programs to shoot a video or choose a video from the album. For more information, see my.chooseVideo.

Document improvements

The syncStore API is enhanced as follows:

Added a use case for changing banners. For more information, see Change banners.
Updated rules for specifying store locations. For more information, see Location in Data dictionary.

2022-12-02

Enhanced features

The syncStore API is enhanced as follows:

Added the extendInfo.tags key in the request parameters to specify the store tags, for example, cuisines. For the valid values, see Valid values for tags.
The extendInfo.cuisine key is to be deprecated. To specify the cuisine types, use the tags key.

Document improvements

For the use cases of the syncStore API:

Added a use case for changing tags. For more information, see Change tags.
Added a use case for reusing and changing an item. For more information, see Reuse and change an existing item.
Added use cases for sharing menus in different store. For more information, see Share menus in different stores.

Updated the following order-related API for Food and Beverage:

The createOrder API (Release 1 / Release 2) is improved as follows:

Updated the required notes of the tableNo and pickUpTime parameters in the request parameters.
Added the extendInfo.storeSnapshot key.
Deleted the extendInfo.mccType key.
Added sample requests.

The notifyOrderChange API (Release 1 / Release 2) is improved as follows:

Updated sample requests.

2022-11-17

Document improvements

Release the solutions for F&B D-store template. For more information, see About design tokens and How to change color scheme and fonts.

2022-10-28

Enhanced features

The /v2/miniprogram/order/sync API is enhanced as follows:

Updated the description of the goods.goodsPaymentAmount parameter.
Changed the goods.goodsQuantity parameter from Optional to Required.

Document improvements

Released the uses cases for the syncStore API. For more information, see Exploring API use cases.

2022-10-14

New features

Released the syncStore API for SaaS providers to insert, update, or hide a store, such as updating or hiding menus, categories, or items for a store.

Enhanced features

The notifyCardRegistration API is enhanced as follows:

Added the FIRST_NAME and LAST_NAME values to the registrationFields.fieldCode parameter in the request parameters.

The createOrder API is enhanced as follows:

Added the memoToSeller parameter to the extendInfo parameter in the request parameters.

Document improvements

Added notes about JSAPI call permissions in the following topics:

2022-09-27

Enhanced features

Added SKU_STATUS_RULE to the scene parameter in BusinessRule for Sku to specify the SKU availability. For sample requests, see Specify SKU status rule in the initializeStore API.

Document improvements

Changed the data type of the timeSlot parameter in PriceScheduleRule and ItemStatusRule from Array to Object.

2022-09-16

Enhanced features

The issueCard API is enhanced as follows:

Added an application scenario to the externalCardNo parameter in request parameters.

The inquireCardDetail API is enhanced as follows:

Changed the cardFields parameter in the response parameters from Optional to Required.

The inquireMemberAssets API is enhanced as follows:

Changed the assetDetails parameter in the response parameters from Optional to Required.

The inquireOrderDetail API is enhanced as follows:

Changed the data type of the extendInfo parameter in the response parameters from String to Map<String,String>.

2022-08-29

New features

Released the Memberships API reference for merchants to integrate with the membership capability. For more information, refer to the following documents:

Enhanced features

The initializeStore, addStore, updateStore, addItem, and updateItem APIs are enhanced as follows:

Added the appId parameter to the request parameters in the initializeStore API.
Added the appId parameter to the request parameters in the addStore API.
Added the appId parameter to the request parameters in the updateStore API.
Added the businessRules parameter to the request parameters in the initializeStore API to specify the business rules of a store, an item, or an SKU.
Added the businessRules parameter to the request parameters in the addStore and updateStore APIs to specify the business rules of a store.
Added the businessRules parameter to the request parameters in the addItem and updateItem APIs to specify the business rules of an item or an SKU.
Differentiate the BusinessRule data model when specifying the business rules of the Store, Item, and Sku data model. For more information, see BusinessRule in Data dictionary.
Updated the valid values of the scene parameter in the BusinessRule model to support more business scenarios. The following values are added:

DINE_IN_ORDER
DINE_IN_SCHEDULE
PRICE_SCHEDULE
ITEM_STATUS_RULE

Added the sample requests to help better understand how to specify different business rules. For more information, check the sample request section in the following APIs:

initializeStore

addStore

Business rules for Store

updateStore

Business rules for Store

addItem

updateItem

Added the extInfo parameter to the request parameters in the initializeStore, addStore, and updateStore APIs. The following three parameters can be specified:

mccType
inQueueScopes
reservationScopes

The createOrder API is updated as follows:

Added the appId parameter to the request parameters.
Added the following parameters to the extendInfo parameter in the request parameters.

dineInScene
numberOfPax
cardNo
paymentAmountDetails

Removed the promoCode parameter from the promoDetails.extendInfo parameter.
Moved the data models out of this API document to Data dictionary for consistency, which include:

OrderItem
ModifierGroupDetail
DeliveryDetail
AddressInfo
OrderAmountDetail
PromoDetail

Differentiate the DeliveryDetail data model when specifying the delivery detail in the createOrder and notifyOrderChange APIs. For more information, see DeliveryDetail in Data dictionary.
Added the following three result codes:

INSUFFICIENT_USER_BALANCE
INSUFFICIENT_USER_POINTS
INVALID_USER_BENEFIT

The notifyOrderChange API is enhanced as follows:

Added the rebatedAssets parameter to the extendInfo parameter in the request parameters.
Moved the data models out of this API document to Data dictionary for consistency, which include:

OrderItem
ModifierGroupDetail
DeliveryDetail

Updated the scenarios of the orderStatus parameter to specify the dine-in order statuses.

The inquireOrderDetail API is enhanced as follows:

Added the extendInfo parameter to the response parameters. The following parameter can be specified:

rebatedAssets

Updated the scenarios of the orderStatus parameter to specify the dine-in order statuses.

The updateVendorInfo API is enhanced as follows:

Moved the data models out of this API document to Data dictionary for consistency, which include:

Vendor
SmallOrderFeeRule

Updated the paymentAmount calculation in the Calculate order totals document.
Added two properties to the image component, which include:

lazy-load
default-source

Document improvements

Changed the following document titles:

OpenAPIs for merchants is changed to Common functionalities, which includes authorization, message sending, payment, and other common fuctionalities.
OpenAPIs for ISVs is changed to Promotions, which includes the marketing promotion functionalities.
OpenAPIs for F&B SaaS provider is changed to Food and Beverage, which includes the functionalities related to the food and beverage industry.

Removed the promoCode parameter from the promoDetails.extendInfo parameter in /v2/miniprogram/order/sync.
Changed the data type of the value parameter from String to Integer and added its value range in the Amount model for Common functionalities.
Updated the Idempotency chapter to include the idempotent fields in the Memberships APIs.

2022-08-19

New features

Released the integration solution for mini programs released to AlipayCN to integrate the message sending capability. For more information, see Message sending.

Enhanced features

Removed the version check in the integration solutions for mini programs released to AlipayCN. For more information, see the following three documents:

Improved the release process for mini program released to AlipayCN. For more information, see the following three documents:

Improved the release process for mini program released to other Alipay+ partner apps. For more information, see the following three documents:

Updated the scopes parameter in the my.getAuthCode JSAPI.

2022.08.12

New features

my.calculateRoute JSAPI is added and MapContext.showRoute is updated to configure route calculating capability.

2022-07-29

New features

my.createLottieContext JSAPI and Lottie animation are added to configure Lottie capabilities.
/v2/miniprogram/order/sync API is added for merchants to synchronize an order to super apps.

2022-07-19

New features

Guide to Goldfish is added to introduce the Goldfish framework to mini program developers.

2022-05-26

New features

updateVendorInfo API is added for F&B SaaS providers to update their information.

2022-04-26

New features

You can add openAPI features to implement certain capabilities on your mini program, such as the user authorization or message sending feature.

2022-04-15

New features

/v2/authorizations/applyTokenAndInquiryUserInfo API is added for merchants to obtain an access token and inquire about user information.
my.getScreenOrientation and my.setScreenOrientation JSAPIs are added to get and set the screen orientation.

Enhanced features

The /v2/miniprogram/message/send API is enhanced with the following changes:

Add authClientId to the request parameters.
Update the valid values of customerBelongsTo.

The /v2/users/inquiryUserInfo API is enhanced with the following changes:

Add customerBelongsTo to the request parameters.
Add APP_NOT_EXIST and MERCHANT_AUTH_INFO_NOT_EXIST to the error codes.

The /v2/authorizations/revoke API is enhanced with the following changes:

Add customerBelongsTo to the request parameters.

The /v2/merchant/report/query API is enhanced with the following changes:

Update the valid values of customerBelongsTo.

The /v2/authorizations/applyToken API is enhanced with the following changes:

Update the valid values of customerBelongsTo.
Delete EXPIRED_ACCESS_TOKEN in the error codes.

2022-03-24

New features

OpenAPIs for F&B SaaS providers are added, including

Full data synchronization

Incremental data synchronization

Order

2022-01-18

Enhanced features

Update JS bridge for calling JSAPIs for mini programs in the cross-app launch scenario.

2022-01-12

New features

The /v2/merchant/report/query API is added for merchants to query the performance data of mini programs.

2021-12-24

Enhanced features

The /v2/authorizations/applyToken API is enhanced with the following changes:

Add extendInfo.appCustomerId and extendInfo.acqCustomerId to extendInfo field in the response.

The /v2/users/inquiryUserInfo API is enhanced with the following changes:

Add appUserId and acqUserId to extendInfo within userInfo field in the response.

OpenAPIs for ISVs is enhanced with the following changes:

Add ACCESS_FORBIDDEN to the common error codes section.
Add benefitCollectRule field to the request of the syncBenefit API.

2021-12-14

Enhanced features

The /v2/messages/sendInbox API is no longer maintained. All the functionalities of this API have been migrated to the /v2/miniprogram/message/send/ API. We recommend you to utilize the /v2/miniprogram/message/send/ API for new features or enhancements.
The /v2/miniprogram/message/send API is enhanced with the following changes:

Add messageId in the response parameters.
Add the following error codes and corresponding actions to solve these issues:

TEMPLATE_NOT_EXIST
USER_NOT_SUBSCRIBED
MESSAGE_SEND_EXCEED_LIMIT

2021-12-07

New features

The Mini Program Platform is updated with the following new features:

my.crossPay JSAPI is added to enable cashier payment and start a payment transaction in the cross-app launch scenario.
OpenAPIs for ISVs are added, including:

Enhanced features

The JSAPIs are enhanced with the following changes:

my.getAuthCode:

Add system requirements for Alipay China and other wallet apps.
Clarify authorization scopes for Alipay China and other Alipay+ partner apps.

The openAPIs are enhanced with the following changes:

/v2/miniprogram/message/send:

Add CHOPE in cutomerBelongsTo.

2021-11-26

New features

The Mini Program Platform is updated with the following new features:

Through service management, ISVs can release services to Service Market for merchants to order and help merchants develop mini programs. They can also manage services and service orders on the Platform.
On Service Market, merchants can order services provided by ISVs to meet their business needs. They can also manage their orders on the Platform.
The advertising function helps merchants configure customized ads' content to drive engagement and enhance conversion rate.

2021-10-22

New features

The Mini Program Platform is updated with the following new features:

ISV role is added to help you benefit from Mini Program Platform ecosystem.
ISV onboarding enables you to get boarded to Mini Program Platform quickly.
You can release and manage your Alipay+ mini programs in Alipay China.

Enhanced features

Added appId and other parameters in the following three Open APIs to support the cross-app launch functionality:

2021-06-10

New features

The Mini Program Platform is updated with the following new features:

New member roles are added to help you collaborate on mini programs more efficiently.
The compatibility test is now available for you in the release progress to build more stable mini programs.
Owners can create mini programs directly after onboarding the Mini Program Platform for the first time.

Enhanced features

Enhanced the user interface of manage mini programs.

Changed the showActionSheet boolean to be false by default in the my.saveImage JSAPI.

Added kakaotalk in the app value reference table of the my.getSystemInfo JSAPI.

2021-04-27

Enhanced features

In the Quality page, you can see statistics for HTTP requests, JSAPI calls, JS errors, and details of abnormal URLs.

2021-04-14

Enhanced features

In the list page of Manage Mini Program, you can view the past performance, real-time analysis, and quality of each mini program and navigate to these pages.

In the detail page of a mini program, you can see the expiration time of the QR code for testing.

In the Real-Time Analysis page, you can see the success rate and error details of JSAPI calls.

Deleted features

The Launch feature is no longer available from the navigation menu.