Release notes

2024-04-30

Document improvements

• Added the following information on using the syncProduct API:

• Details on the shared product parameters for stores of the same merchant.
• Guidance on specifying the posProductId parameter.

For more information, refer to the Product data model description.

• Updated the FAQs chapter to help resolve subproduct display issues. For more information, refer to Why do some modifiers or modifier groups disappear from a previously functioning store?

2024-03-14

Enhanced features

Added the following parameters to support order modifications from GrabFood:

• For the createOrder API, added the orderProducts.subOrderId and extendInfo.cutleryNumber request parameters. For more information, refer to createOrder.
• For the pushOrderChange API, added the updatedOrderProducts and refundInfo request parameters. For more information, refer to pushOrderChange.

2024-02-04

Enhanced features

Updated the syncProduct API to enable POS providers to update product statuses. The update involves changing the following request parameters from required to optional:

• products.type
• products.name
• products.price

For more information, refer to syncProduct.

Document improvements

Updated the specification of the syncProduct API as follows:

• Clarified the API's usage for synchronizing full product information.
• Added a note to the description of the products request parameter to specify the quantity limit for synchronized products.

For more information, refer to syncProduct.

2024-01-31

New features

Added the syncStore API to enable POS providers to help merchants create new stores and update store statuses. For more information, refer to syncStore.

2024-01-19

Document improvements

Added the FAQs chapter to provide answers to frequently asked questions for easier troubleshooting. For more information, refer to FAQs.

2023-12-21

Enhanced features

Added or changed the following to support orders from Foodpanda and provide more order details:

• For the createOrder API:

• Added the deliveryDetail, the extendInfo.acceptanceExpiryTime, and the extendInfo.scheduleType request parameters.
• Added the FOODPANDA enumeration value to the orderChannel request parameter.

For more information, refer to createOrder.

• For the notifyOrderChange API:

• Added the CANCELLED enumeration value to the orderStatus request parameter.
• Added the deliveryStatus and the extendInfo.failureReason request parameters.
• Added the INVALID_ORDER_STATUS result code.

For more information, refer to notifyOrderChange.

• For the pushOrderChange API:

• Changed the orderStatus request parameter from required to optional and updated the description of the CANCELLED enumeration value.
• Added the deliveryStatus request parameter.

For more information, refer to pushOrderChange.

2023-11-01

Enhanced features

• For the createOrder API:

• Added the channelOrderId request parameter to help identify an order.
• Added the orderAmountDetail.paymentDetails request parameter to provide payment details of an order.

For more information, refer to createOrder.

• Updated the orderStatus response parameter in the inquireOrderDetail API to support more order statuses:

• Added the CANCELLED enumeration value.
• Expanded the usage scenarios of the ORDER_FAIL enumeration value.

For more information, refer to inquireOrderDetail.

• Added the orderReadyTime request parameter to the notifyOrderChange API to update the order ready time. For more information, refer to notifyOrderChange.

2023-09-26

Enhanced features

Added the following request parameters to the createOrder API to provide tax details of the order:

• orderAmountDetail.taxDetail
• extendInfo.isTaxIncludedInProductPrice

For more information, refer to createOrder.

2023-09-19

New features

Added the pushOrderChange API to transmit order status updates from the order channel to the POS provider. For more information, refer to pushOrderChange.

Enhanced features

To support orders from GrabFood, made the following changes to the request parameters of the createOrder API:

• For the orderChannel parameter, added the GRABFOOD enumeration value.
• For the serviceType parameter, added the DELIVERY enumeration value.
• For the customer parameter, changed it from required to optional and clarified the occasion when it is not passed.
• For the extendInfo parameter, added the shortOrderNumber and the isAutoAcceptanceRequired keys.
• Added the orderAmountDetail.deliveryFee parameter.

For more information, refer to createOrder.