Retailer flyer data specifications

Use the retailer_flyer_data object to associate flyer deals with an item. The object is keyed by flyer identifier (lowercase alphanumeric with hyphens).

Parameters

The retailer_flyer_data object accepts the following parameters.

Field	Type	Required	Description
starts_at	string	yes	The date and time when the flyer deal begins, in ISO 8601 format. For example, 2025-01-15T14:30:00Z.
ends_at	string	yes	The date and time when the flyer deal ends, in ISO 8601 format. For example, 2025-01-15T14:30:00Z.
activity_id	string	no	The activity identifier for this flyer deal.
page	integer	no	The page number in the flyer where this item appears.
top_deal	boolean	no	Whether this item is featured as a top deal in the flyer.

Example

{
  "lookup_code": "1234567890",
  "store_identifier": "1234",
  "retailer_flyer_data": {
    "weekly-flyer-2025-01": {
      "starts_at": "2025-01-15T00:00:00Z",
      "ends_at": "2025-01-21T23:59:59Z",
      "activity_id": "act-456",
      "page": 3,
      "top_deal": true
    }
  }
}