Skip to content

Product sync (required for product protection)

Path: /go/packageOpenApiWeb/OpenApiV2/SyncPlatformProduct

Section titled “Path: /go/packageOpenApiWeb/OpenApiV2/SyncPlatformProduct”

Product sync. Provide at least one of items or fileUrl; when both are sent, the server uses items and ignores fileUrl. The response data contains only requestId.

For the full field reference see API reference · SyncPlatformProduct.

Notes:

  • With fileUrl, each CSV row equals one Item; complex fields (arrays / objects) are JSON strings.
  • The variant-name JSON key is Name (PascalCase).
  • variants is optional. When omitted or empty, the server synthesizes a single variant from the item-level variantId, skuId, Name, and price.
{
"items": [
{
"platformItemId": "B01N1SE4E9",
"itemState": 1,
"itemName": "Sample Product",
"currency": "USD",
"picLink": [
"https://example.com/example1.img",
"https://example.com/example2.img"
],
"itemLink": "https://example.com/item/B01N1SE4E9",
"variants": [
{
"variantId": "AFNSJHFUHUAI",
"skuId": "ABC123",
"Name": "Coconut Soap - Sauce Flavor - Buy 1 Get 1",
"price": "20.00",
"imageUrl": "https://example.com/variant1.img"
},
{
"variantId": "SHFHGSHGFH",
"skuId": "ABCABC",
"Name": "Coconut Soap - Rich Flavor - Buy 1 Get 2",
"price": "30.00",
"imageUrl": "https://example.com/variant2.img"
}
],
"itemPriceExt": "{\"discount\": \"5%\", \"specialOffer\": \"Buy 2 Get 1 Free\"}"
}
]
}
{
"requestId": "req-001",
"items": [
{
"platformItemId": "B01N1SE4E9",
"itemState": 1,
"itemName": "Sample Product",
"currency": "USD",
"picLink": ["https://example.com/example1.img"],
"itemLink": "https://example.com/item/B01N1SE4E9",
"variantId": "SHFHGSHGFH",
"skuId": "ABCABC",
"Name": "Coconut Soap - Rich Flavor - Buy 1 Get 2",
"price": "30.00"
}
]
}

The first CSV row is the header; every following row is one item. Cells for complex fields such as picLink and variants must be valid JSON with double quotes escaped per the CSV spec.

{
"fileUrl": "https://example.com/data.csv"
}
{
"errCode": 0,
"errMsg": "success",
"data": { "requestId": "req-001" }
}