Synchronize Content
The Synchronize Content API allows partners to synchronize product information to AlipayHK. To ensure the quality of products on AlipayHK, partners are responsible for, but not limited to, the following:
- Data Quality Assurance:
Ensure that all synchronized product information is accurate, complete, and clear, including but not limited to product descriptions, pricing, and high-quality images.
- Synchronization Success Guarantee:
Ensure that product data is successfully synchronized to the AlipayHK system.
- Real-Time Update Obligation:
Promptly update the AlipayHK platform whenever product information changes.
- Product Status Management:
Timely perform status changes such as listing and delisting products on AlipayHK.
General Headers
Name | Description | Type | Sample |
Client-Id | An ID provided by AlipayHK, used to identify partner and application system. | String | 4Q5Y8W0WSG45P907917 |
Content-Type | The RFC 2616 media type of the request body, the charset should be as same as the one used for cryptographic operations. | String | application/json; charset=UTF-8 |
Signature | A key-value pairs string separated by commas (,), which keys and values are joined by equal signs (key=value). Valid keys include:
| String | algorithm=RSA256,keyVersion=1,signature=KEhXthj4bJ801Hqw8kaLvEKc0Rii8KsNUazw7kZgjxyGSPuOZ48058UVJUkkR21iD9JkHBGR rWiHPae8ZRPuBagh2H3qu7fxY5GxVDWayJUhUYkr9m%2FOW4UQVmXaQ9yn%2Fw2dCtzwAW0htPHYrKMyrT pMk%2BfDDmRflA%2FAMJhQ71yeyhufIA2PCJV8%2FCMOa46303A0WHhH0YPJ9%2FI0UeLVMWlJ1XcBo3Jr bRFvcowQwt0lP1XkoPmSLGpBevDE8%2FQ9WnxjPNDfrHnKgV2fp0hpMKVXNM%2BrLHNyMv3MkHg9iTMOD% 2FFYDAwSd%2B6%2FEOFo9UbdlKcmodJwjKlQoxZZIzmF8w%3D%3D |
Encrypt | when message content needs to be encrypted. A key-value pairs string separated by commas (,), which keys and values are joined by equal signs (key=value). Valid keys include:
| String | algorithm=RSA_AES,keyVersion=1,symmetricKey=bqS8HSmdaRrpKSuPy7CqUlyd8lJurG93 |
Request-only Headers
Name | Description | Type | Sample |
Request-Time | The ISO-8601 datetime of this API request with timezone. | String | 2024-05-22T06:42:21+05:30 |
Response-only Headers
Name | Description | Type | Sample |
Response-Time | The ISO-8601 datetime of this API response with timezone. | String | 2024-05-22T06:42:21+05:30 |
Tracer-Id | An ID for tracing this request. | String | abcdefg135202000000000263818 |
Request parameters
requestId string REQUIRED
An unique request ID (uuid) to identify this API request.
More information:
- Maximum length: 32 characters
contentId string REQUIRED
An unique ID reference for this content.
When there are multiple prices for the same content, a different contentId must be passed.
contentType string REQUIRED
- VIRTUAL_GOODS
contentStatus number REQUIRED
Status of the content.
0: invalid-
1: valid
This status will control the availability of card wallet and performance notification, etc.
contentInfo string
Response parameters
resultInfo object REQUIRED
A metadata object indicates the result of the request.
Request
Response
Result/Error codes
| Code | Value | Message |
|---|---|---|
| SUCCESS | S | Success |
| PARAM_ILLEGAL | F | Request is invalid, usually missing parameters. |
| CONTENT_RISKY | F | Content passed is risky, no need to retry. |
| UNKNOWN_EXCEPTION | F | Unknown exception, please retry. |