OpenMenu Deals - Details

The details of each property is listed below - each property lists the allowable information for that property.

omd
Attributes
  • openmenu_id

    Corresponds to the OpenMenu (via the OpenMenu ID) that these deals are attached to format: UUID v4 (aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee) required

  • version

    The version of the OMD spec that this OpenMenu Deals file adheres to format: decimal with a . (period) seperator required

deals
deal
Attributes
  • uid

    Globally unique identifier for this deal format: UUID v4 (aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee) - must be random values / lower case and globally unique to OpenMenu required

  • created_date

    date the deal was created. format: yyyy-mm-dd (ISO 8601) required

  • disabled

    Sets that this deal has been disabled format: select from 0 | 1 (0 = no | 1 = yes) not required

  • force_print

    Sets that the deal must be printed and brought into the restaurant to claim (makes the deal a coupon) format: select from 0 | 1 (0 = no | 1 = yes) not required

Tags
  • provider

    Who is providing this deal - where was the deal created format: 0 - 75 characters required

  • provider_url

    Direct URL to the deal on the providers site (if applicable) format: 0 - 120 characters starting with http:// not required

  • headline

    Headline for the deal format: 0 - 100 characters required

  • description

    Description of the deal format: 0 - 255 characters required

  • disclaimer

    Legal disclaimer that appears at the bottom of the deal format: 0 - 125 characters not required

  • date_start

    Start date for deals which must be used during/before specific dates format: yyyy-mm-dd (ISO 8601) not required

  • date_end

    End date for deals which must be used during/before specific dates format: yyyy-mm-dd (ISO 8601) not required

  • hours_start

    Starting time for deals which occur during specific times of the day format: hh:mm (ISO 8601 - 24 hour time) not required

  • hours_end

    Ending time for deals which occur during specific times of the day format: hh:mm (ISO 8601 - 24 hour time) not required

  • days_valid

    Selects specific days this deal is valid for format: empty tag (defined by its attributes) not required

    Attributes
    • mon

      Monday format: select from 0 | 1 (0 = no | 1 = yes)

    • tue

      Tuesday format: select from 0 | 1 (0 = no | 1 = yes)

    • wed

      Wednesday format: select from 0 | 1 (0 = no | 1 = yes)

    • thu

      Thursday format: select from 0 | 1 (0 = no | 1 = yes)

    • fri

      Friday format: select from 0 | 1 (0 = no | 1 = yes)

    • sat

      Saturday format: select from 0 | 1 (0 = no | 1 = yes)

    • sun

      Sunday format: select from 0 | 1 (0 = no | 1 = yes)

  • image_url

    URL to an image used in the deal display - size must be 64px x 64px format: URL starting with http:// in GIF|JPG|PNG format not required