POST /v2/pds/order/notifyOrderChange

With this API call, the SaaS provider or ISV can notify D-store Platform of any changes to an order, for example, when the user modifies the pickup time of the order.

Note:

• In the request body, provide the values for relevant fields you want to change. Do not include existing values that haven't changed. For example, to update an item in the order, provide the values of the OrderItem object for the updateItems field.
• For any changes to an order, call this API to notify D-store Platform immediately, otherwise it may cause inconsistent order status.
• If you call this API to remove, update, add, or replace items in an order:

• For eat-before-payment orders, the order amount can change accordingly.
• For pay-before-eating orders with completed payments, this API cannot change the order amount. If the actual amount is less than the payment, you can specify the totalRefundAmount parameter to issue refunds to customers. However, if the actual amount exceeds the payment, merchants need to seek offline solutions.

Before you begin

Before you integrate with this API, it is recommended to learn the following basic concepts:

• Eat-before-payment

Eat-before-payment is a dining scenario where the users enjoy their meals first and check out later. In mini programs, this dining scenario is only applicable to dining-in orders and allows users to add items to their original order by placing multiple additional orders.

• Main order

A main order is the combination of the first order and all additional orders placed for one single dining experience. This type of order is available only in the eat-before-payment scenario and can have one or more subordinate orders.

• Subordinate order

A subordinate order is the first order or an additional order placed for one single dining experience. This type of order is available only in the eat-before-payment scenario and related to a main order.

• Whole order

A whole order is a dining-in order placed with a payment, which users cannot add items to. This concept is used to refer to dining-in orders that are not placed in the eat-before-payment scenario.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:

• Request header
• Response header

Request parameters

Response parameters

Result process logic

In the response, the result.resultStatus field indicates the result of processing a request. The following table describes each result status:

Error codes

Error codes are usually classified into the following categories:

• Common error codes are common for F&B mini program OpenAPIs.
• API-specific error codes: This API does not have its dedicated error codes.

Samples

Request

Change order information

The following examples demonstrate the sample requests to change order information:

Update order status

To update the order status:

• Specify the orderStatus parameters with valid values defined in the request parameters.
• Update the order status to any upcoming status instead of the previous status.

Pickup

• The value of orderType is PICKUP.
• The valid values for the orderStatus parameter include:

• ACCEPTED
• REJECTED
• PREPARING
• READY
• COMPLETED

• If the initial status specified for an order is COMPLETED or REJECTED(indicates final status), you cannot call this API to update the order status.

See the following examples:

{
    "requestId": "165163872164627201c17****",
    "requestOrderId": "pds_2109220000232584_2022050400309038585_2",
    "orderStatus": "ACCEPTED"
}

{
    "requestId": "165163872164627201c17****",
    "requestOrderId": "pds_2109220000232584_2022050400309038585_2",
    "orderStatus": "REJECTED",
    "extendInfo":"{\"rejectOrderReason\":\"The store is closed.\"}"
}

Dine-in

• The value of orderType is DINEIN.
• The valid values for the orderStatus parameter include:

• ACCEPTED
• REJECTED
• PREPARING
• READY
• FULFILLMENT_COMPLETED (only applicable to orders in the eat-before-payment scenario)
• COMPLETED

• If the initial status specified for an order is COMPLETED or REJECTED(indicates final status), you cannot call this API to update the order status.

See the following example:

{
    "requestId": "165163872164627201c17****",
    "requestOrderId": "pds_2109220000232584_2022050400309038585_2",
    "orderStatus": "ACCEPTED"
}

Delivery

• The value of orderType is DELIVERY.
• The valid values for the orderStatus parameter include:

• ACCEPTED
• REJECTED
• PREPARING
• READY
• SHIPPING
• NEARBY
• DELIVERED
• COMPLETED

See the following example:

{
    "requestId": "165163872164627201c17aa16",
    "requestOrderId": "pds_2109220000232584_2022050400309038584_1",
    "orderStatus": "SHIPPING"
}

Remove item

To remove items:

• Specify the removeRequestSubOrderIds parameter to identify the items to be removed.
• Items can only be removed when the order is in any of the following cases:

• For orders not in the eat-before-payment scenario, the value of the orderStatus parameter needs to be: ACCEPTED, PREPARING, READY, SHIPPING, NEARBY, DELIVERED, or COMPLETED
• For orders in the eat-before-payment scenario, the value of the orderStatus parameter needs to be: ACCEPTED, PREPARING, READY, or FULFILLMENT_COMPLETED

See the following example:

{
    "requestId": "165163872164627201c17aa16",
    "requestOrderId": "pds_2109220000232584_2022050400309038584_1",
    "removeRequestSubOrderIds": [
        "2022050400311864775"
    ]
}

Update item

To update items:

• Specify the updateItems parameter to indicate the items to be updated.
• Items can only be updated when the order is in any of the following cases:

• For orders not in the eat-before-payment scenario, the value of the orderStatus parameter needs to be: ACCEPTED, PREPARING, READY, SHIPPING, NEARBY, DELIVERED, or COMPLETED
• For orders in the eat-before-payment scenario, the value of the orderStatus parameter needs to be: ACCEPTED, PREPARING, READY, or FULFILLMENT_COMPLETED

See the following example:

{
    "requestId": "165163872164627201c17aa16",
    "requestOrderId": "pds_2109220000232584_2022050400309038584_1",
    "updateItems": [
        {
            "categoryId": "100",
            "itemId": "11010",
            "notAvailableOption": "Remove it from my order",
            "priceInfo": {
                "currency": "SGD",
                "saleAmount": 869
            },
            "quantity": 1,
            "skuId": "76251",
            "storeId": "121",
            "requestSubOrderId": "2022050400311864775"
        }
    ]
}

Update item quantity

To update item quantity:

• Item quantity can only be updated when the value of orderStatus is any of the following: ACCEPTED, PREPARING, READY, or COMPLETED.
• Items requiring updates must be included in the order before and after the API request. If you want to add a new item or remove an existing item, refer to Add item or Remove item respectively.

In the previous example, the quantity of the item (with itemId specified as 11010) is 1 (as specified in the quantity parameter). With the following sample code, the quantity for this same item is changed to 2:

{
  "requestId": "165163872164627201c17aa16",
  "requestOrderId": "pds_2109220000232584_2022050400309038584_1",
  "updateItems": [
    {
      "categoryId": "100",
      "itemId": "11010",
      "notAvailableOption": "Remove it from my order",
      "quantity": 2,
      "priceInfo": {
        "currency": "SGD",
        "saleAmount": 869
      },
      "skuId": "76251",
      "storeId": "121",
      "requestSubOrderId": "2022050400311864775"
    }
  ]
}

Add item

To add items:

• Specify the addItems parameter to indicate the items to be added.
• Items can only be added when the order is in any of the following cases:

• For orders not in the eat-before-payment scenario, the value of the orderStatus parameter needs to be: ACCEPTED, PREPARING, READY, SHIPPING, NEARBY, DELIVERED, or COMPLETED
• For orders in the eat-before-payment scenario, the value of the orderStatus parameter needs to be: ACCEPTED, PREPARING, READY,or FULFILLMENT_COMPLETED

See the following example:

{
    "requestId": "165163872164627201c17aa16",
    "requestOrderId": "pds_2109220000232584_2022050400309038584_1",
    "addItems": [
        {
            "categoryId": "100",
            "itemId": "11010",
            "notAvailableOption": "Remove it from my order",
            "priceInfo": {
                "currency": "SGD",
                "saleAmount": 869
            },
            "quantity": 1,
            "skuId": "76251",
            "storeId": "121"
        }
    ]
}

Replace item

To replace items:

• Specify the addItems parameter to indicate the new items and the removeRequestSubOrderIds parameter to indicate the old items to be replaced.
• Items can only be replaced when the order is in any of the following cases:

• For orders not in the eat-before-payment scenario, the value of the orderStatus parameter needs to be: ACCEPTED, PREPARING, READY, SHIPPING, NEARBY, DELIVERED, or COMPLETED
• For orders in the eat-before-payment scenario, the value of the orderStatus parameter needs to be: ACCEPTED, PREPARING, READY, or FULFILLMENT_COMPLETED

See the following example:

{
    "requestId": "165163872164627201c17aa16",
    "requestOrderId": "pds_2109220000232584_2022050400309038584_1",
    "addItems": [
        {
            "categoryId": "100",
            "itemId": "11010",
            "notAvailableOption": "Remove it from my order",
            "priceInfo": {
                "currency": "SGD",
                "saleAmount": 869
            },
            "quantity": 1,
            "skuId": "76251",
            "storeId": "121"
        }
    ],
    "removeRequestSubOrderIds": [
        "2022050400311864775"
    ]
}

Change pickup time

To change the pickup time:

• Specify the pickUpTime parameter with a new value, which is only applicable for dine-in or pickup orders.
• The pickup time can only be changed when the current order status is ACCEPTED, PREPARING, or READY.
• For a request to change the order status and pickup time, make sure the order status changed is ACCEPTED, PREPARING, or READY.

See the following example:

{
    "requestId": "165163872164627201c17aa16",
    "requestOrderId": "pds_2109220000232584_2022050400309038584_1",
    "pickUpTime": "2019-11-27T12:01:01+08:30"
}

Change delivery detail

To change delivery detail:

• Specify the deliveryDetail object with new values, which is only applicable for delivery orders.
• The delivery detail can only be changed after the order is accepted by the merchant (ACCEPTED) and before the order is delivered (DELIVERED).

See the following example:

{
    "requestId": "165163872164627201c17aa16",
    "requestOrderId": "pds_2109220000232584_2022050400309038584_1",
    "deliveryDetail": {
        "expectedDeliveryTimeStart": "2019-11-27T12:01:01+08:30",
        "expectedDeliveryTimeEnd": "2019-11-27T12:01:01+08:30",
        "estimatedDeliveryTimeStart": "2019-11-27T12:01:01+08:30",
        "estimatedDeliveryTimeEnd": "2019-11-27T12:01:01+08:30",
        "delayReason": "WEATHER"
    }
}

Adjust amount

The following sample shows that an amount of 5,500 SGD is deducted from the main order in the eat-before-payment scenario:

{
  "requestId": "165163872164627201c17aa16",
  "requestOrderId": "pdsful_2023033100061527027_2023033101726454027",
  "adjustAmount":{
    "type":"REDUCE",
    "adjustPrice":{
      "value":5500,
      "currency":"SGD"
    }
  }
}

Initiate a refund

To initiate a refund,

• Specify the totalRefundAmount parameter to indicate the amount to be refunded to the user.
• The refund can only be processed when the order is in ACCEPTED and subsequent statuses (including PREPARING, READY, SHIPPING, NEARBY, DELIVERED, and COMPLETED).
• The total refund amount, including failed refunds, cannot be greater than the payment amount.
• Refund is not applicable to orders in the eat-before-payment scenario when the payment is made in store.

See the following example:

{
    "requestId": "165163872164627201c17aa16",
    "requestOrderId": "pds_2109220000232584_2022050400309038584_1",
    "totalRefundAmount": 55
}

Response

Add item

The following provides the sample response for adding an item to the order:

{
    "addResults": [
        {
            "categoryId": "100",
            "itemId": "11010",
            "notAvailableOption": "Remove it from my order",
            "priceInfo": {
                "currency": "SGD",
                "saleAmount": 869
            },
            "quantity": 1,
            "skuId": "76251",
            "storeId": "121",
            "requestSubOrderId": "2022050400311864775"
        }
    ],
    "result": {
        "resultCode": "SUCCESS",
        "resultMessage": "success",
        "resultStatus": "S"
    }
}

Replace item

The following provides the sample response for replacing items in an order:

{
    "addResults": [
        {
            "categoryId": "100",
            "itemId": "11010",
            "notAvailableOption": "Remove it from my order",
            "priceInfo": {
                "currency": "SGD",
                "saleAmount": 869
            },
            "quantity": 1,
            "skuId": "76251",
            "storeId": "121",
            "requestSubOrderId": "2022050400311864775"
        }
    ],
    "result": {
        "resultCode": "SUCCESS",
        "resultMessage": "success",
        "resultStatus": "S"
    }
}

Other changes to the order

The following provides the sample response for other changes to the order, for example, removing items, updating items, or changing pickup time, delivery detail, order status, or refund amount.

{
    "result": {
        "resultCode": "SUCCESS",
        "resultMessage": "success",
        "resultStatus": "S"
    }
}