Offer

Provides public information about a WingCash offer. See the Offer API Calls and OfferDetail.

Attributes

accepted_quantity
Integer: the number of times the authenticated profile has accepted this offer. The value is 0 for anonymous users.
amount
String containing a decimal amount. Specifies the amount of open-loop cash required for purchase. May be zero. Don’t display this amount without also consulting the show_amount_as parameter. Depending on the offer and the option chosen by the purchaser, the amount may be funded by either the purchaser, merchant, or distributor.
banner
The URL of the banner image. May be an empty string. The dimensions of the image vary based on the offer template, but offers using the common “Canvas A” template provide images exactly 636 pixels wide and 404 pixels tall. See also metadata_image.
base_loops
A list of LoopAmount objects describing the base cash the purchaser will receive for any option. See also the loops and bonus_loops attributes of OfferOption.
body
HTML describing the offer. WingCash uses a whitelist to ensure the HTML contains only the following tags and attributes:
  • <a> with href and/or title attributes only
  • <b> without attributes
  • <br> without attributes
  • <div> without attributes
  • <em> without attributes
  • <h1> through <h6> without attributes
  • <i> without attributes
  • <img> with the following attributes:
    • alt
    • height
    • src, pointing to wingcash.com only
    • srcset, pointing to wingcash.com only
    • style, limited to providing image dimensions only
    • title
    • width
  • <li> without attributes
  • <ol> without attributes
  • <p> without attributes
  • <span> without attributes
  • <strike> without attributes
  • <strong> without attributes
  • <u> without attributes
  • <ul> without attributes
currency
String: the currency of the amount attribute.
display
A list of strings specifying what to display with the offer. Values may include:
  • address
  • phone
  • purchases_remain
  • date_range
  • time_remain
end
String: the ISO 8601 date and time when the offer ends. May be null.
from_id
String: the ID of the profile who is providing this offer. It may be the merchant or distributor of the offer. This is null if the offer provider does not wish to be named.
id
String: the ID of the offer.
metadata_description
String: the description of the offer in plain text (no HTML). Social media sites show this description next to offer page links. May be empty.
metadata_image
The URL of the metadata image. May be an empty string. Social media sites show the metadata_image or the banner next to offer page links. The dimensions of the image vary based on the offer template, but offers using the common “Canvas A” template provide images 250 pixels wide and 250 pixels tall.
modified
String: the ISO 8601 date and time when the offer was last edited. (Note that some offer attributes may change without offer edits, such as the render_status at expiration.)
options
The list of OfferOption objects for this offer. In order to accept the offer, the purchaser must choose one option. Many offers have only one option, in which case the choice is generally not shown to users.
purchases_remain
Integer: the number of purchases remaining for this offer. May be null, indicating the number of purchases is not limited.
render_status
String: indicates whether the offer is active. Contains either active, before_active, expired, or sold_out.
require_confirmation
Boolean: true if the offer can only be accepted by WingCash members with confirmed contact information (such as a confirmed email address or SMS number.) If false, the offer can be accepted by WingCash members without confirmed contact information.
show_amount_as
String: specifies how to show the price of the offer. Contains one of:
  • amount: show the purchase amount
  • free: the purchaser pays nothing
  • no_add: the purchaser pays nothing, but the UI should use the term “no additional charge”, suggesting the purchaser may have paid already and doesn’t need to pay any more.
show_limit
Integer: the per-wallet quantity limit to show to users. May be null if the offer is unlimited or if the offer provider chooses not to show the limit.
show_wyg
String: specifies where to show what the purchaser will get upon accepting this offer. Possible values:
  • before: Show what they will get before the body text. The default.
  • after: Show what they will get afer the body text.
  • hide: Don’t show the “what you get” section; that information is presumably included in the body HTML or the banner image.
sidebar_image
The URL of the sidebar image. May be an empty string. The dimensions of the image vary based on the offer template, but offers using the common “Canvas A” template provide images of variable dimensions, up to 260 pixels wide and up to 600 pixels tall.
start
String: the ISO 8601 date and time when the offer begins. May be null.
sticker_heading
String: A short string (no more than 10 characters) to show on the top line of a “sticker” area.
sticker_value
String: A short string (no more than 5 characters) to show on the bottom line of a “sticker” area.
template_name
String: Which template to apply to the offer. canvas_a is the most common.
title
String: the offer title.
url
String: the published URL of the offer. If the offer is not published, this is the numeric offer URL.
visible
Boolean: true if the offer is visible. When visible is false, render_status is before_active.