synchronizeContent

2025-08-22 10:10

POST https://domain/asap/synchronizeContent

The synchronizeContent API is used by wallets and their merchants to synchronize a variety of content information, including merchants, products, stores, and coupons, to ASAP for recommendation purposes. Ultimately, the content information will be utilized within ASAP's recommendation scenarios.

Structure

Request parameters

Field name	Data type	Required	Description
contents	List<Content>	Yes	A list with a maximum of 50 content items.
bizDate	Date	No	Business operation time.

Response parameters

Field name	Data type	Required	Description
result	ResultInfo	Yes	The request result.

Data Model

Content

Field name	Data type	Required	Description
contentType	String	Yes	Content type. Valid values are: `MERCHANT`: Indicates the content represents merchant information. `STORE`: Indicates the content represents store information. `BENEFIT`: Indicates the content represents coupon information. `LOCAL_SKU`: Indicates the content represents product information.
contentId	String	Yes	The unique ID for content data in GCash, such as merchant ID, store ID, or benefit ID.
contentInfo	String	Yes	The detailed content information in the form of a JSON string, where each key represents a specific field. For detailed information on the JSON fields for different content types, please refer to the Appendix.
contentStatus	Integer	Yes	The status of the content information. Valid values are: `0` : Invalid `1` : Valid
contentVersion	Long	Yes	The version number of the modified content information. The number should increase with each subsequent modification to prevent older versions from overwriting newer ones. It is recommended to use a timestamp as the version number.

ResultInfo

Field name	Data type	Required	Description
resultCode	String	Yes	The result code that indicates the detailed processing result.
resultStatus	String	Yes	The result status that indicates the processing result. Valid values are: `S`: Successful `F`: Failed `U`: Unknown
resultMessage	String	No	The result message that describes the result code in detail.

Sample

Request

Synchronize store information

copy
{
    "contents":
    [
        {
            "contentId": "000001010101010101",
            "contentInfo": "{\"multilLang\":{\"en_PH\":{\"address\":\"Maynila, Pilipinas\",\"storeName\":\"Mga McDonald's\"},\"en_US\":{\"address\":\"Manila, Philippines\",\"storeName\":\"McDonald's\"}},\"address\":\"Manila, Philippines\",\"city\":\"810000\",\"businessTime\":\"Monday to Sunday 10 a.m. to 10 p.m\",\"storeId\":\"00000001\",\"phoneNumbers\":[\"0123456789\"],\"businessArea\":\"81000202\",\"province\":\"810000\",\"merchantId\":\"2160000000000001\",\"district\":\"810002\",\"storeName\":\"McDonald's\",\"location\":\"22.27524,114.187487\"}",
            "contentStatus": 1,
            "contentType": "STORE",
            "contentVersion": 1723603075786,
            "requestTime": 1723603076043,
            "tntInstId": "GCASH"
        }
    ],
    "requestTime": 1723603076043
}

Synchronize SKU information

copy
{
    "contents":
    [
        {
            "contentId": "1000000000000000101",
            "contentInfo": "{\"multilLang\":{\"en-PH\":{\"skuName\":\"Hamburg\",\"brandName\":\"Mga McDonald's\",\"skuPictures\":[\"https://mass-office.alipay.com/yunfengdie_automate/afts/file/FHMmQawaKoYAAAAAAAAAABAADoLIAQBr?af_fileName=9213b07eca8065380cd78040a988b644ad3459822411.webp\"],\"description\":\"McDonald's masarap na burgers\"},\"en_US\":{\"skuName\":\"Hamburg\",\"brandName\":\"McDonald's\",\"skuPictures\":[\"https://mass-office.alipay.com/yunfengdie_automate/afts/file/FHMmQawaKoYAAAAAAAAAABAADoLIAQBr?af_fileName=9213b07eca8065380cd78040a988b644ad3459822411.webp\"],\"description\":\"A delicious burger from McDonald's\"}},\"brandName\":\"McDonald's\",\"keywords\":[\"catering\",\"Hamburg\",\"Snack\"],\"discount\":80,\"description\":\"A delicious burger from McDonald's\",\"currentAmount\":{\"amount\":160.00,\"cent\":16000,\"centFactor\":100,\"currency\":\"PHP\",\"currencyCode\":\"PHP\",\"currencyValue\":\"608\"},\"storeId\":\"100101\",\"skuName\":\"Hamburg\",\"originAmount\":{\"amount\":200.00,\"cent\":20000,\"centFactor\":100,\"currency\":\"PHP\",\"currencyCode\":\"HKD\",\"currencyValue\":\"608\"},\"merchantId\":\"21600000000000001\",\"brandId\":\"1001\",\"skuPictures\":[\"https://p3-pc-sign.douyinpic.com/tos-cn-i-0813/6d2d5908a27f481fa8bba82c382190cf~tplv-dy-aweme-images-v2:3000:3000:q75.webp?biz_tag=aweme_images&from=327834062&s=PackSourceEnum_AWEME_DETAIL&sc=image&se=false&x-expires=1723255200&x-signature=xgQINJXUENyDRzi2SwZuqinvS0w%3D\"],\"linkUrl\":\"mini://platformapi/startapp?appId=2160000001&page=pages/sku/detail/detail\"}",
            "contentStatus": 1,
            "contentType": "SKU",
            "contentVersion": 1706096669000,
            "requestTime": 1723537340701,
            "tntInstId": "GCASH"
        }
    ],
    "requestTime": 1723537340712
}

Response

copy
{
    "resultCode": "SUCCESS",
    "resultMessage": "Success",
    "resultStatus": "S"
}

Appendix

The following tables provide best practices that detail content information for various content types. In certain special cases, the fields for these content types can be adjusted as needed.

MERCHANT

Field name	Data type	Required	Multi-Language supported	Description	Sample value
merchantId	String	Yes	No	The unique ID of the merchant.
merchantName	String	Yes	Yes	The merchant name.
logoUrl	String	Yes	No	The merchant logo image URL.
linkUrl	String	Yes	No	The URL to access the merchant's mini program.
imageURLs	List<String>	Yes	No	The URLs of the images for the merchant's detail page.
description	String	Yes	Yes	The merchant description.
badgeText	String	No	Yes	Text content for a badge of a merchant, displayed if the current widget supports it. If this field is empty, no badge will be rendered.
multilLang	Map<String,Map<String,String>>	Yes	Yes	Multilingual information. You can provide it if there are fields supporting multiple languages.
extInfo	String	No	Yes	Extended information.
externalTags	List<String>	No	Yes	The external tags of the merchant.
merchantEmail	String	Yes	No	The email of the merchant.
externalCategories	List<String>	No	Yes	The external categories of the merchant.
stdCategories	List<String>	Yes	Yes	The ASAP standard categories. Provide them based on the ASAP's standard rules for category codes.

BENEFIT

Field name	Data type	Required	Multi-Language supported	Description	Sample value
benefitId	String	Yes	No	The unique ID of the benefit.
merchantId	String	Yes	No	The merchant ID associated with the benefit.
merchantName	String	No	Yes	The merchant name.
availableStoreIds	List<String>	No	No	The list of available store IDs.
campaignId	String	No	No	The campaign ID associated with the benefit.
benefitName	String	Yes	Yes	The benefit name.
coverImageUrl	String	Yes	No	The cover image URL of the benefit.
imageURL	String	No	No	The URL of the image for the benefit's detail page.
linkUrl	String	No	No	The URL to access the benefit's detail page.
description	String	No	Yes	The description of the benefit.
externalCategories	List<String>	No	No	The external categories of the benefit.
stdCategories	List<String>	No	No	The ASAP standard categories. Provide them based on the ASAP's standard rules for category codes.
amount	MultiCurrencyMoney	No	No	The discount amount of the benefit.
discount	Integer	No	No	The discount rate of the benefit.
limitDetail	String	No	Yes	The usage restrictions of the benefit.
startTime	Long	No	No	The start time of the benefit.
endTime	Long	No	No	The end time of the benefit.
validPeriod	String	No	No	The validity period of the benefit.
benefitType	String	No	No	The benefit type. Valid values are: `1`: Instant discount, a fixed amount directly deducted from the purchase price when buying a product, without requiring any specific threshold. `2`: Full Discount, applied when the total purchase amount reaches a specified threshold. `3`: Cashback, a coupon with a random monetary value, similar to a cash rebate. `4`: Discount, a certain percentage discounted from the original price. `5`: Points Redemption, where points can be redeemed for a coupon of a certain value. `6`: Buy and Get, where purchasing a specified product allows you to receive another product or benefit for free. `7`: Merchant Voucher, presented to the merchant offline to enjoy the corresponding benefits.
externalTags	List<String>	No	No	Custom tags passed from external sources.
extInfo	String	No	No	Extended information.
badgeText	String	No	Yes	Text content for a badge of a benefit, displayed if the current widget supports it. If this field is empty, no badge will be rendered.

STORE

Field name	Data type	Required	Multi-Language supported	Description	Sample value
merchantId	String	Yes	No	The merchant ID associated with the store.
merchantName	String	No	Yes	The merchant name associated with the store.
storeId	String	Yes	No	The unique ID of the store.
storeName	String	Yes	Yes	The name of the store.
logoURL	String	No	No	The URL of the store logo image.
linkURL	String	Yes	No	The URL for accessing the merchant's mini program.
imageURLs	List<String>	Yes	No	The URL of the image for the store detail page.
description	String	Yes	Yes	The description of the store.
multilLang	Map<String,Map<String,String>>	No	No	Multilingual information. You can provide it if there are fields supporting multiple languages.
businessTime	String	No	Yes	Opening hours of the store.
address	String	No	Yes	The address of the store.
location	String	No	No	The latitude and longitude coordinates of the store.
minPriceRange	MultiCurrencyMoney	Yes	No	The minimum price of products in the store.
maxPriceRange	MutiCurrencyMoney	Yes	No	The maximum price of products in the store.
externalRating	String	No	No	User's rating for the store.
extInfo	String	No	Yes	Extended information.
externalTags	List<String>	No	Yes	Custom tags passed from external sources.
externalCategories	List<String>	No	Yes	The external categories of the store.
stdCategories	List<String>	No	Yes	ASAP standard categories. Provide them based on the ASAP's standard rules for category codes.
badgeText	String	No	Yes	Text content for a badge of a store, displayed if the current widget supports it. If this field is empty, no badge will be rendered.
coverImageUrl	String	Yes	No	The cover image URL of the store.

LOCAL_SKU

Field ame	Data type	Required	Multi-Language supported	Description	Sample value
merchantId	String	Yes	No	The merchant ID associated with the SKU.
miniProgramId	String	No	No	The mini program ID associated with the SKU.
storeIds	List<String>	No	No	The list of store IDs associated with the SKU.
name	String	Yes	Yes	The SKU name.
itemDetailImageList	List<String>	No	No	List of image URLs for the SKU.
outItemId	String	Yes	No	The SKU code on the merchant side.
originalPrice	MultiCurrencyMoney	No	No	The original price of the SKU.
salePrice	MultiCurrencyMoney	Yes	No	The sales price of the SKU.
soldStartTime	Long	No	No	The start time of SKU sales.
soldEndTime	Long	No	No	The end time of SKU sales.
linkURL	String	Yes	No	The URL to access the SKU detail page.
descriptionImage	List<String>	No	No	List of image URLs for the SKU detail page.
detailDesc	String	No	Yes	The description of the SKU.
externalCategories	List<String>	No	Yes	The external categories of the SKU.
stdCategories	List<String>	No	No	ASAP standard categories. Provide them based on the ASAP's standard rules for category codes.
externalTags	List<String>	No	Yes	Custom tags passed from external sources.
supplier	String	No	Yes	The supplier of the SKU.
discount	String	No	No	The discount information of the SKU.
brandName	String	No	Yes	The brand name of the SKU.
refundRule	List<String>	No	No	The refund policy of the SKU.
preorderRule	String	No	No	The reservation policy of the SKU.
couponUsageRule	String	No	No	Restrictions on the discount usage.
badgeText	String	No	Yes	Text content for a badge of an SKU, displayed if the current widget supports it. If this field is empty, no badge will be rendered.