MSPI Catalog feed specification
The MSPI (Multiple Sellers per Item) Catalog Feeds are designed to accommodate e-commerce situations where catalog structure offers a many-to-many (n:m) relationship between sellers and items. This arrangement allows for a single item to be offered from multiple sellers. Consequently, an Item ID is not tied exclusively to a particular seller within the platform system and can be associated with multiple seller IDs.
Item catalog feed
Required fields
The following fields are required for each item in your catalog. If any required fields are missing or formatted incorrectly, items may not upload to your catalog and can be missing from your ads.
Field | Data Type | Note |
|---|---|---|
id | String (up to 50 characters) | A unique identifier for the item Example: |
title | String (up to 200 characters) | A specific, relevant title for the item Example: |
image_link | String (up to 2,000 characters) | The URL of the main image of the item. It should begin with Example: |
category | String (up to 750 characters) | Category of the product. Choose the most granular categories that describe the item. Use > as a delimiter among depths and use; as a delimiter among multiple categories. Include the full path of the categories. Example |
Recommended fields
The following fields are recommended to boost ad performance or filter out undesirable results.
Field | Data Type | Note |
|---|---|---|
rating | Number (up to 4 characters) | The rating of the product. Example: |
review_count | Number (up to 20 characters) | The number of product reviews (purchase reviews) Example: |
brand | String (up to 70 characters) | The brand name Example: |
brand_id | String (up to 70 characters) | The brand ID Example: |
adult | String | Whether the item is not allowed for minors or contains adult content. It must be one of the following: |
created_time | String (up to 25 characters) | Created time of the item information. Example: |
updated_time | String (up to 25 characters) | Last updated time of the item information. Example: |
Optional fields
You can also include many optional fields to share more item information with customers or control how items are displayed.
Field | Data Type | Note |
|---|---|---|
location | String (up to 750 characters) | Locations where the product is eligible to sell. Provide the most specific product location possible from the list. Example: If a value is absent in the Seller catalog, it will be taken from the Item catalog |
availability | String | The current availability of the item. You must use one of the following: When this field is set to If a value is absent in the Seller catalog, it will be taken from the Item catalog |
blocked | String (up to 50 characters) | Use this field to block items from advertising. If it contains any text, the item cannot be added to new campaigns, and existing campaigns will exclude the item from advertising. This field should explain why the item is blocked, otherwise leave this field empty. Example: If the “blocked” column contains a non-empty string in the Item Catalog, no seller can use that item for their campaigns, even if the “blocked” column in the Seller Catalog is empty. |
shipping_charge | Number (up to 25 characters) | Shipping charge. Use the same format as the price field. Example If a value is absent in the Seller catalog, it will be taken from the Item catalog |
condition | String | The condition of the item. It must be one of the following: If a value is absent in the Seller catalog, it will be taken from the Item catalog |
delivery_option | String (up to 200 characters) | The delivery option that is offered for the item. It must be one of the following: If a value is absent in the Seller catalog, it will be taken from the Item catalog |
description | String (up to 5,000 characters) | A short, relevant description of the item. Example: Lightweight fabric and a relaxed cut. A comfortable jacket that slips on like a shirt. |
link | String (up to 1,024 characters) | The link to your business’s website lets people learn more about or buy the item. Example: |
mobile_link | String (up to 1,024 characters) | The mobile link to your business’s website lets people learn more about or buy the item. Example: |
additional_image_link | String (up to 1,024 characters) | Additional image URL for the item. Example: |
reward_point | String (up to 100 characters) | Enter if reward points are paid when purchasing a product Example: |
google_product_category | String (up to 750 characters) | Google product category. Example |
item_group_id | String (up to 50 characters) | ID for a product group that comes in different versions (variants). Example: |
color | String (up to 100 characters) | The main color of the item. Example: |
gender | String | The gender your item is targeted towards. It must be one of the following values: |
size | String (up to 100 characters) | The size of the item. Example: |
material | String (up to 200 characters) | The material the item is made from. Example: |
pattern | String (up to 100 characters) | The pattern or graphic print on the item Example: |
age_group | String | The age group that the item is targeted towards. It must be one of the following: |
class | String | This field is only for the update feed. |
is_bundle | String | Used if the item is sold in a bundle. It must be one of the following: |
gtin | String (up to 200 characters) | The Global Trade Item Number (GTIN) assigned by the manufacturer Example: |
custom_label_0 | String (up to 200 characters) | Label that you assign to items to help organize bidding and reporting in sponsored ad campaigns. Example: |
custom_label_1 | String (up to 200 characters) | Label that you assign to items to help organize bidding and reporting in sponsored ad campaigns. Example: |
custom_label_2 | String (up to 200 characters) | Label that you assign to items to help organize bidding and reporting in sponsored ad campaigns. Example: |
custom_label_3 | String (up to 200 characters) | Label that you assign to items to help organize bidding and reporting in sponsored ad campaigns. Example: |
custom_label_4 | String (up to 200 characters) | Label that you assign to items to help organize bidding and reporting in sponsored ad campaigns. Example: |
Seller catalog feed
Required fields
To establish a mapping relationship between an item and a seller in your catalog, the following fields must be provided. In case any of these mandatory fields are either absent or formatted incorrectly, it could result in the data not being uploaded in the mapping table, potentially leading to incorrect ad serving behavior.
Field | Data Type | Note |
|---|---|---|
item_id | String (up to 50 characters) | A unique identifier for the item Example: |
seller_id | String (up to 50 characters) | A unique seller/vendor ID. It is an Ad account ID for ad servicing & campaign management. Example: |
seller_title | String (up to 200 characters) | Name of seller/vendor. It is used as an Ad account title for ad servicing & campaign management. Example: |
price | Number (up to 25 characters) | The item's price that’s determined by the seller. Format the price as a number. Always use a period (.) as the decimal point, which supports up to two decimal places. For KRW and JPY, the value must be set as an integer, or the feed will not be processed. Example: |
sale_price | Number (up to 25 characters) | Price after discounts. If the item is not discounted, set this equal to the ‘price’ value. Format the price as a number. Always use a period (.) as the decimal point, which supports up to two decimal places. For KRW and JPY, the value must be set as an integer or the feed will not be processed. Example: |
Recommended fields
Field | Data Type | Note |
|---|---|---|
updated_time | String (up to 25 characters) | Last updated time of the item information. Example: `2023-02-24T11:07+0100 |
Optional fields
You can also include many optional fields to share more item information with customers or control how seller’s items are displayed.
Field | Data Type | Note |
|---|---|---|
location | String (up to 750 characters) | Locations where the product is eligible to sell. Provide the most specific product location possible from the list. Example: If a value is absent in the Seller catalog, it will be taken from the Item catalog. |
availability | String | The current availability of the item. It must be one of the following: The item can be added to new campaigns, but all campaigns will exclude it from advertising while it's out of stock. ( |
blocked | String (up to 50 characters) | Use this field to block items from advertising. If it contains any text, the item can’t be added to new campaigns, and existing campaigns will exclude it from advertising. This field should explain why the item is blocked, otherwise leave this field empty. Example: The item will only be available for campaigns if the “blocked” column is empty in both the Item and Seller Catalogs. If the “blocked” column contains a non-empty string in the Item Catalog, no seller can use that item for their campaigns, even if the “blocked” column in the Seller Catalog is empty. If the “blocked” column in the Item Catalog is empty, the item is available to sellers with an empty “blocked” column for that item in the Seller Catalog. |
shipping_charge | Number (up to 25 characters) | Shipping charge. Use the same format as the price field. Example If a value is absent in the Seller catalog, it will be taken from the Item catalog |
condition | String | The condition of the item. It must be one of the following: If a value is absent in the Seller catalog, it will be taken from the Item catalog |
delivery_option | String (up to 200 characters) | The delivery option that is offered for the item. It must be one of the following: If a value is absent in the Seller catalog, it will be taken from the Item catalog |
Updated about 1 month ago