Open API Updates: New Image Ratios and Promotional Image Fields

Dear developers,

Please take note of the following changes applicable to sellers in all regions:

1. In addition to the original 1:1 aspect ratio images, whitelisted sellers are now able to upload images with a 3:4 aspect ratio. For whitelisted sellers, you can upload 1:1 or 3:4 images in the OpenAPI.

1. The v2.media_space.upload_image API has a new parameter, "ratio," supporting only 1:1 or 3:4. If you do not pass "ratio" field, it defaults to uploading a 1:1 image.

2. Subsequently, in v2.product.update_item and v2.product.add_item, you can use the new "ratio" field to specify the aspect ratio (1:1 or 3:4) when uploading images to an item. Only one aspect ratio can be selected for upload.

3. After adding or updating images to a product, you can call v2.product.get_item_base_info to view the image aspect ratio using the newly added "ratio" field.

Note: The "ratio" field applies only to whitelisted users. Non-whitelisted sellers can not pass the "ratio" field and can only upload 1:1 images by default. If the uploaded image does not adhere to the 1:1 or 3:4, Shopee will automatically adjust the image to the corresponding ratio.

2. A new 1:1 aspect ratio promotion image field has been added. Promotion Image will be used on the promotion page, search result page, daily discover, etc. Upload Promotion Image will inspire buyers to click on the product.

1. When creating or updating a product in v2.product.add_item and v2.product.update_item, you can edit this "promotion_images" field only if the product image aspect ratio is 3:4. It exclusively supports 1:1 image ratio. If left blank or if the product's image ratio is 1:1, the first product image will be automatically processed into a 1:1 ratio for the promotion image.

2. You can call v2.product.get_item_base_info，to view products' “promotion_images”

Related APIs:

v2.product.add_item

v2.product.update_item

v2.product.get_item_base_info

v2.media_space.upload_image

Effective Date: Lived

尊敬的开发者，

请留意以下变动，适用于所有地区的卖家：

1. 除原本的 1:1 比例图片外，白名单卖家现支持上传 3:4 比例的图片。对于白名单内的卖家，在 OpenAPI 端您可以选择上传 1:1 图片或 3:4 图片。

1）v2.media_space.upload_image 新增字段 ratio，仅支持传入1:1或 3:4。如未传入ratio，默认上传1:1图片。

2）然后，通过 v2.product.update_item 和 v2.product.add_item，在新增字段 ratio 中传入对应比例，上传 1:1 或 3:4 比例的图片至item。仅支持选择一种比例进行上传。 3）在添加图片至商品后，可以调用 v2.product.get_item_base_info，通过新增的 “ratio” 字段查看图片比例。

注意：仅白名单用户有 ratio 字段，非白名单卖家无需填写 ratio，默认只能上传 1:1 图片。如果上传的比例不符合 1:1 或 3:4 规范，虾皮将自动处理图片至相应比例。

2. 新增 1:1 比例的促销图片字段。促销图片将用于促销页面、搜索结果页面、每日发现等，上传促销图片将激发买家点击您的产品。

1）在创建商品和更新商品时，在 v2.product.add_item 和 v2.product.update_item 中，仅当商品图片比例为 3:4 时，才可以编辑该活动图片字段"promotion_images"，且活动图片仅支持1:1的图片格式。如果未传入“promotion_images”或商品的图片比例为 1:1，默认将第一张商品图片处理成 1:1 格式的促销图片。

2）可以调用 v2.product.get_item_base_info，查看商品的 “promotion_images” 字段

涉及到的API:

v2.product.add_item

v2.product.update_item

v2.product.get_item_base_info

v2.media_space.upload_image

生效日期：已上线