notifyOrderCompletion

2023-04-28 21:00

Note: This API is no longer maintained. The current functionality remains for compatibility. We recommend using the notifyOrderChange API to notify us of any changes to an order.

POST /v2/pds/order/notifyOrderCompletion

With this API call, the SaaS provider or ISV can notify us of whether the order is completed.

Structure

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

Request parameters

Field

Data type

Required

Description

Example

requestId

String

Yes

Indicates the unique ID assigned by the SaaS provider or ISV to identify a request for order completion notification.

Maximum length: 255 characters

Note: This field is an API idempotency field. For the notifyOrderCompletion requests that are initiated with the same requestId value, our server must return the same result. For details about API idempotency, see the Idempotency chapter.

We suggest using orderId_timestamp, for example, "12324534534534_12321"

requestOrderId

String

Yes

Indicates the unique ID assigned by our server to identify an order.

Maximum length: 255 characters

Response parameters

Field	Data type	Required	Description
result	Result	Yes	Indicates the request result, such as status and error codes.

Result process logic

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

Result status	Description
S	The notification is sent successfully. The corresponding result.resultCode is `SUCCESS` and result.resultMessage is `SUCCESS`.
U	The status of the notification request is unknown. The corresponding result.resultCode is `UNKNOWN_EXCEPTION` and result.resultMessage is "An API calling is failed, which is caused by unknown reasons.". For details, see the Common error codes section.
F	The notification is failed to be sent. The corresponding result.resultCode and result.resultMessage may vary based on different situations. For details, see the following Error codes section.

Error codes

Error codes are usually classified into the following categories:

Common error codes are common for F&B mini program OpenAPIs.

Samples

Request

copy
{
    "requestId": "165163872164627201c17aa16",
    "requestOrderId": "pds_2109220000232584_2022050400309038584_1"
}

Response

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