Metadata file requirements
The metadata file contains a list of items featured in each store's flyer and the date range when the flyer is displayed on your storefront. This file can also include optional fields for enabling a shoppable flyer experience.
SFTP upload folder
sftp://sftp-partners.instacart.com/flyers
General attributes
Column | Type | Required | Description | Example |
---|---|---|---|---|
upc | String | Yes | Product identifier. Must match the upc value defined for this product in the catalog. | "00842096100802" |
tag | String | Yes | Describes the type of flyer. | "weekly" |
storenumber | String | Yes | Specifies which store a specific item belongs to. Must match the values defined in your warehouse data. | "1" |
startdate | String | Yes | Specifies when the flyer is visible on your storefront. The timezone is set based automatically based on store location. Format is YYYY-MM-DD HH:MM:SS | "2025-05-13 00:00:00" (beginning of the day) |
enddate | String | Yes | Specifies when the flyer is no longer visible on your storefront. The timezone is set based automatically based on store location. Format is YYYY-MM-DD HH:MM:SS | "2025Y-05-20 23:59:59" (end of the day) |
locale | String | No | Specifies the language. Defaults to en_US if not provided. | "en_CA" |
Shoppable attributes
To enable a shoppable flyer experience, include the following attributes in your metadata file.
Column | Type | Required? | Description | Example | Customer experience |
---|---|---|---|---|---|
activityid | String | Yes | Assign the same activity ID to related products so they are displayed within the same "block" on the flyer page. For more information, see Flyers in the Instacart Platform Portal documentation. Work with your IT department and Instacart representative to determine whether any of the attributes you currently use for grouping promotions should be sent as the activity ID. | "20230101_12345" | ![]() |
pagenumber | Integer | Yes | Specifies the page of the print flyer where this promotion is located. Can be used to help identify top deals. | 1 | |
promotitle | String | Yes | Primary copy displayed for the promotion. This value typically describes the offer or incentive, such as "2 for $5." | "2 for $5" | ![]() |
promodescription | String | No | Secondary copy displayed for the promotion. This value is typically a description of the eligible items. If the value is not provided in your data file, a description is automatically generated based on the product names. | "Arizona Iced Teas" | ![]() |