iOS SDK - Offer Objects

DOCS

Last updated: Aug 15th, 8:07am

PDOffer

Identifies a particular offer within the WLW platform.

Property	Description
`offerExpiryDate`	NSDate Date after which the offer is no longer valid for redemption.
`offerCampaign`	`PDOfferCampaign` Defines the full offer content.
`offerDiscountAmount`	NSNumber The dollar amount or percentage by which the offer reduces the total amount due on qualifying purchases.
`discountAmount`	Decimal Deprecated as of SDK 5.5 and replaced by `offerDiscountAmount`.
`offerUri`	String WLW’s unique identifier for the offer.
`offerCombinable`	Boolen Specifies if the offer can be combined with other qualifying offers within the same purchase.
`isRefundable`	Boolean Specifies if the offer can be refunded once redeemed.
`offerStatus`	`PDOfferStatus` Enum Identifies the current status of the offer.
`couponCode`	String The identifier of a multi-channel, customer-agnostic version of the offer.

PDOfferSummary

A high-level overview of an offer instance containing just the information pertaining to its display in a summary list in the app.

Property	Description
`offerCampaignSummary`	`PDOfferCampaignSummary` Defines the content of the offer as it will appear in the offer summary.
`expiryDate`	NSDate The date after which the offer is no longer valid for redemption.
`offerUri`	String WLW’s unique identifier for the offer.
`offerCombinable`	Boolen Specifies if the offer can be combined with other qualifying offers within the same purchase.
`offerStatus`	`PDOfferStatus` Enum Specifies the current status of the offer for the user.

PDOfferDetail

The details about an offer as they appear once the user selects the offer from the summary list to review its specifics.

Property	Description
`offerCampaignDetail`	`PDOfferCampaignDetail` Defines the content of the offer as it will appear in the detail screen.
`expiryDate`	NSDate The date after which the offer campaign is no longer valid for redemption.
`offerUri`	String WLW’s unique identifier of the offer.
`offerCombinable`	Boolean Specifies if the offer can be combined with other qualifying offers within the same purchase.
`offerStatus`	`PDOfferStatus` Enum Specifies the current status of the offer for the user.

PDOfferSummaryAcceptancePartner

A higher-level depiction of the merchant for which the offer is valid as it would appear in the offer summary. For example, this value may identify National Drug Store but not call out individual participating locations.

Property	Description
`acceptancePartnerUri`	String WLW’s unique identifier for the acceptance partner.
`merchantCode`	String A secondary identifier for the acceptance partner that distinguishes it within the offer manager.
`name`	String The name of the acceptance partner as it would appear in the offer summary.
`logo`	String A URL value that resolves to the acceptance partner’s logo image to display in the offer summary.

PDOfferDetailAcceptancePartner

A higher-level depiction of the merchant for which the offer is valid as it would appear in the offer details. For example, this value may identify National Drug Store but not call out individual participating locations.

Property	Description
`acceptancePartnerUri`	String WLW’s unique identifier for the acceptance partner.
`merchantCode`	String A secondary identifier for the acceptance partner that distinguishes it within the offer manager.
`name`	String The name of the acceptance partner as it would appear in the offer summary.
`logo`	String A URL value that resolves to the acceptance partner’s logo image to display in the offer summary.

PDOfferArtifact

Defines a piece of content that makes up the body of an offer.

Property	Description
`content`	String The body of text associated with this piece of content.
`offerImage`	`PDUIImage` The image that is appears beside the text in the Offers list in the app.
`artifactName`	String A name that distinguished the piece of content represented by this artifact.
`offerArtifactChannelType`	`PDOfferArtifactChannelType` Enum Specifies the media channel for which the artifact is formatted.
`offerArtifactViewType`	`PDOfferArtifactViewType` Enum Specifies the section of the offer in which this artifact will appear.
`offerArtifactContentType`	`PDOfferArtifactContentType` Enum Specifies the media format of the artifact.

PDOfferSummaryArtifact

Defines the text and display properties of the offer summary abstract shown in a list of offers in the app.

Property	Description
`content`	String The text that represents the high level description of the offer summary.
`offerArtifactChannelType`	`PDOfferArtifactChannelType` Enum Specifies the device for which the content is formatted.
`offerArtifactViewType`	`PDOfferArtifactViewType` Enum Specifies the section of the offer summary in which this piece of content will appear.
`offerArtifactContentType`	`PDOfferArtifactContentType` Enum Specifies the media format.

PDOfferDetailArtifact

Defines a piece of content that makes up the offer as it is displayed in the detail view, once a user has selected it from the summary list.

Property	Description
`content`	String The text displayed in the content piece.
`offerArtifactChannelType`	`PDOfferArtifactChannelType` Enum Specifies the device channel for which the content is formatted.
`offerArtifactViewType`	`PDOfferArtifactViewType` Enum Specifies the section of the offer detail in which this piece of content will appear.
`offerArtifactContentType`	`PDOfferArtifactContentType` Enum Specifies the media format.

PDOfferCampaign

Defines the display content of the offer campaign and the criteria for its redemption.

Property	Description
`offerArtifacts`	Array The collection of offer artifacts available for the campaign.
`offerCategories`	Array The set of categories with which the campaign is associated.
`storeLocations`	Array The store locations for which the campaign is valid.
`offerCampaignSponsor`	`PDOfferCampaignSponsor` Identifies the entity issuing the offer.
`offerCampaignRedemptionSpecification`	`PDOfferCampaignRedemptionSpecification` Defines the valid conditions for the offer.
`offerProcessingPointType`	`PDOfferProcessingPointType`Enum Identifies the entity through which the offer was redeemed.
`offerReward`	`PDOfferReward` Defines any non-monetary item that is included in the offer, for example, `Free bag of cookies with purchase.`
`offerType`	`PDOfferType` Enum Identifies the type of incentive used by the offer.
`checkoutTokenValue`	String The value of a QR Code that the user can scan to activate the offer in the mobile wallet. This property is not currently supported.
`offerCampaignUri`	String WLW’s unique identifier for the campaign.
`offerCampaignExternalId`	String The unique identifier for the campaign, as provided by a third party, such as a coupon manager. This property is not currently supported.
`skuItems`	Array The set of `PDSkuItem` objects that define any products that are redeemable for the offer, such as buy one, get one free.
`offerStartDate`	NSDate The first day the offer is valid for redemption.
`offerEndDate`	NSDate The last day the offer is valid for redemption.

PDOfferCampaignSummary

The content of an offer campaign as it will appear in the summary list view.

Property	Description
`offerSummaryArtifacts`	Array The set of `PDOfferSummaryArtifact` instances representing the individual pieces of content that make up the offer summary. Each offer summary includes the following offer artifacts: Title, Summary, Thumbnail, and AdditionalInfo.
`offerSummaryCategories`	Array The set of`PDOfferSummaryCategory` instances that identify the categories to which the offer is related.
`offerSummaryAcceptancePartners`	Array The set of `PDOfferSummaryAcceptancePartner` instances specifying the retailers at which the offer is valid for redemption.
`offerCampaignSummaryRedemption`	`PDOfferCampaignSummaryRedemption` Defines the high-level criteria for redemption that will be displayed in the offer.
`offerSummaryReward`	`PDOfferSummaryReward` Defines the primary incentive of the offer as it would appear in the offer summary, such as `$5 off` or `free cookie`.
`offerCampaignUri`	String WLW’s unique identifier for the offer campaign that the summary represents.
`offerCampaignExternalId`	String A unique identifier for the campaign designated by an external entity, such as a coupon manager.
`checkoutTokenValue`	String The value of a QR Code that the user can scan to activate the offer in the mobile wallet.
`startDate`	NSDate The first day the offer is valid for redemption.
`endDate`	NSDate The last day the offer is valid for redemption.

PDOfferCampaignDetail

The content of an offer campaign as it will appear in the detail view, once selected by a user from the summary list.

Property	Description
`offerDetailArtifacts`	Array The set of `PDOfferDetailArtifact` instances for the individual pieces of content that render the offer detail.
`offerDetailCategories`	Array The set of `PDOfferDetailCategory` instances that identify the categories to which the offer is related.
`offerDetailAcceptancePartners`	Array The set of `PDOfferDetailAcceptancePartner` instances that specify the retailers at which the offer is valid for redemption.
`offerCampaignDetailRedemptionSpecification`	`PDOfferCampaignDetailRedemptionSpecification` Defines the high-level criteria for redemption that will be displayed in the offer.
`offerDetailReward`	`PDOfferDetailReward` Defines the primary incentive of the offer as it would appear in the offer summary, such as `$5 off` or `free cookie`.
`offerCampaignUri`	String WLW’s unique identifier for the offer campaign.
`offerCampaignExternalId`	String A unique identifier for the campaign designated by an external entity, such as a coupon manager.
`checkoutTokenValue`	String The value of a QR Code that the user can scan to activate the offer in the mobile wallet.
`startDate`	NSDate The first day the offer is valid for redemption.
`endDate`	NSDate The last day the offer is valid for redemption.
`offerCampaignDetailSponsor`	`PDOfferCampaignDetailSponsor` Identifies the sponsor that is issuing or promoting the offer in the wallet.

PDOfferCampaignFilterParameters

Defines the different criteria by which an offer campaign lookup can be filtered to narrow down the search by relevance.

Property	Description
`startDate`	NSDate Limits the list of offer summaries to only those that are valid for redemption on or after this NSDate value.
`endDate`	NSDate Limits the list of offer summaries to only those that are valid for redemption on or before this NSDate value.
`startIndex`	Integer Limits the list of offer summaries to only those with an index number equal to or greater than this value.
`maxNumberofRows`	Integer Limits the number of offer summaries maximum number of offers to display on a single page of the app.

PDOfferCampaignSummaryFilterParameters

Defines the different criteria by which an offer campaign lookup can be filtered to narrow down the search by relevance.

Property	Description
`startDate`	NSDate Limits the list of offer summaries to only those that are valid for redemption on or after this NSDate value.
`endDate`	NSDate Limits the list of offer summaries to only those that are valid for redemption on or before this NSDate value.
`startIndex`	Integer Limits the list of offer summaries to only those with an index number equal to or greater than this value.
`maxNumberofRows`	Integer Limits the number of offer summaries maximum number of offers to display on a single page of the app.

PDOfferCampaignRedemptionSpecification

Contains the properties that define the valid conditions for the offer.

Property	Description
`minSpendValue`	NSNumber The minimum purchase amount required in order to qualify for the offer.
`minimumSpendValue`	Decimal Deprecated as of SDK 5.5 and replaced by `minSpendValue`.
`offerType`	`PDOfferType` Enum Identifies the type of incentive used by the offer.
`offerCampaignRedemptionSchedules`	Array An Array of `PDOfferCampaignRedemptionSchedule` objects that define a particular range of dates and times when the offer is valid.

PDOfferCampaignSummaryRedemption

Defines the high-level redemption criteria associated with an offer summary.

Property	Description
`minimumSpendValue`	NSNumber The minimum purchase amount required to qualify for the offer.
`offerType`	`PDOfferType` Enum Specifies whether offer qualification is based on dollar value or product purchase.

PDOfferCampaignDetailRedemptionSpecification

Defines the full set of specific redemption criteria associated with the offer details.

Property	Description
`minimumSpendValue`	NSNumber The minimum purchase amount required to qualify for the offer.
`offerType`	`PDOfferType` Enum Specifies if offer qualification is based on dollar value or product purchase.
`offerCampaignDetailRedemptionSchedules`	`PDOfferCampaignRedemptionSchedule` Array Defines a particular date and time range during which the offer can be redeemed.

PDOfferCampaignRedemptionSchedule

Defines a specific date and time during which the offer is valid. A single offer may have several of these rules defined to capture different times that the offer is valid, such as "Monday between 11am and 2pm".

Property	Description
`scheduleType`	`PDOfferArtifactScheduleType` Enum Indicates if the valid use specification is a day of the week or a day of the month.
`scheduleValue`	String The specific day to which this specification applies, based on the `scheduleType`: - If the `scheduleType` is a day of the week, the acceptable value is a number between 1-7, where `1` = `Sunday`. - If the `scheduleType` is a day of the month, the acceptable value is a number between `1`-`31`.
`redemptionStartTime`	String The time at which the offer begins to be valid, using the 24-hour string format: `HH:mm:ss`.
`redemptionEndTime`	String The time at which the offer ceases to be valid, using the 24-hour string format: `HH:mm:ss`.

PDOfferCampaignDetailRedemptionSchedule

Defines a specific time period (day of the week and time range) during which the offer can be redeemed. A single offer may have several of these schedules defined to articulate individual time periods, such as "Monday between 11am and 2pm" and "Friday between 5pm and 8pm".

Property	Description
`scheduleType`	`PDOfferArtifactScheduleType` Enum Indicates if the schedule represents a monthly or weekly occurrence.
`scheduleValue`	Integer A number representing a specific day, based on the corresponding `scheduleType`. - If the `scheduleType` is a day of the week, the acceptable value is a number between 1-7, where `1` = `Sunday`. - If the `scheduleType` is a day of the month, the acceptable value is a number between `1`-`31`.
`redemptionStartTime`	String The time of day, relative to the acceptance location, at which the offer begins to be valid, using the 24-hour string format `HH:mm:ss`.
`redemptionEndTime`	String The time of day, relative to the acceptance location, at which the offer ceases to be valid, using the 24-hour string format HH:mm:ss.

PDOfferCampaignSponsor

Identifies the entity that is issuing the offer, which may be an individual merchant or a coupon aggregator.

Property	Description
`sponsorDisplayName`	String The name of the issuing entity as it appears all sponsor references.
`offerSponsorType`	String The category into which the sponsor falls. For example, retailer, bank, or third-party.
`advertisingNetworkUri`	String WLW’s unique identifier for the third-party advertiser through which the offer is being promoted.
`partnerNetworkUri`	String WLW’s unique identifier for the processing network of the entity sponsoring the offer.
`partnerUri`	String WLW’s unique identifier for the partner, issuing or acceptance, who is sponsoring the offer.
`sponsorLogoUri`	String WLW’s unique identifier for the logo image associated with the sponsor.

PDOfferCampaignDetailSponsor

Defines the entity that is issuing the offer for inclusion and use in the mobile wallet.

Property	Description
`sponsorDisplayName`	String The name of the issuing entity as it appears all sponsor references.
`offerSponsorType`	`PDOfferCampaignDetailSponsor` Enum Specifies the nature of the sponsor’s relationship to the offer.
`sponsorLogoUri`	String WLW’s unique identifier for the sponsor’s logo image.

PDOfferCategory

Defines a category into which one or more offers can be grouped.

Property	Description
`offerCategoryUri`	String WLW’s unique identifier for the offer category.
`name`	String The name of the category.
`description`	String A brief explanation of the types of offers this category represents.

PDOfferSummaryCategory

Defines a specific grouping into which similar offer summaries might be bucketed.

Property	Description
`offerCategoryUri`	String WLW’s unique identifier for the offer summary category.
`name`	String The name of the category, such as `HolidayOffers` or `LoyaltySpecials`.
`offerSummaryCategoryDescription`	String A brief explanation of the types of offers this category represents.

PDOfferDetailCategory

Defines a specific grouping into which similar offer summaries might be bucketed.

Property	Description
`offerCategoryUri`	String WLW’s unique identifier for the offer category.
`name`	String The name of the category, such as `DailyDeal` or `Combos`.
`offerCategoryDescription`	String A brief explanation of the types of offers this category represents.

PDOfferCollection

A set of offers grouped according to specific filters.

Property	Description
`offers`	Array The set of `PDOffer` objects included in the collection.
`startIndex`	Integer The record number of the first offer in the collection.
`endIndex`	Integer The record number of the last offer in the collection.
`maxNumberOfRows`	Integer The total number of offers that can be added to the collection.
`offerStartDate`	NSDate The first day offers began to be collected for this group.
`offerEndDate`	NSDate The last day offers were collected for this group.

PDOfferSummaryFilterParameters

Defines the different data points by which a list of offer summaries can be filtered before returned by the server in order to display only the items that are most relevant to the time and place of the user and limit unnecessary data transfer and performance usage.

Property	Description
`offerStartDate`	NSDate Limits the list of offer summaries to only those that are valid for redemption on or after this NSDate value.
`offerEndDate`	NSDate Limits the list of offer summaries to only those that are valid for redemption on or before this NSDate value.
`startIndex`	Integer Limits the list of offer summaries to only those with an index number equal to or greater than this value.
`maxNumberofRows`	Integer Limits the number of offer summaries maximum number of offers to display on a single page of the app.

PDOfferLocation

Identifies a particular geographical area as it pertains to where an offer is valid.

Property	Description
`zipCode`	String The zip code associated with a particular U.S. city or region.
`state`	String The name of a U.S. state.
`city`	String The name of a U.S. city.

PDOfferSummaryLocationFilter

Uniquely identifies a particular geographical city as it pertains to where an offer is valid so the list of displayed offer summaries can be limited to relevant locations. An instance of this object must populate city and state OR zipCode.

Property	Description
`zipCode`	String The zip code associated with a particular U.S. city or region.
`state`	String The name of a U.S. state.
`city`	String The name of a U.S. city.

PDOfferCampaignSummaryLocationFilter

Uniquely identifies a particular geographical city as it pertains to where a coupon code is valid so the list of displayed offer summaries can be limited to relevant locations. An instance of this object must populate city and state OR zipCode.

Property	Description
`zipCode`	String The zip code associated with a particular U.S. city or region.
`state`	String The name of a U.S. state.
`city`	String The name of a U.S. city.

PDOfferReward

Defines the incentive being proffered by the offer.

Property	Description
`offerDiscountValue`	NSNumber The dollar amount by which the offer reduces the total amount due for qualifying purchases.
`discountValue`	Decimal Deprecated as of SDK 5.5 and replaced by `offerDiscountValue`.
`rewardType`	`PDRewardType` Enum The type of incentive extended in the offer.
`offerDiscountPercentage`	NSNumber The dollar amount or percentage by which this offer reduces the total amount due for qualifying purchases.
`discountPercentage`	Decimal Deprecated as of SDK 5.5 and replaced by `offerDiscountPercentage`.

PDOfferSummaryReward

Defines the offer incentive as it is represented in the summary.

Property	Description
`discountPercentage`	NSNumber A percentage by which this offer reduces the total amount due for qualifying purchases. For example, `10`% off.
`discountValue`	NSNumber A dollar amount by which the offer reduces the total amount due for qualifying purchases (for example, $`5` off).
`rewardType`	`PDRewardType` Enum Indicates the type of reward the user would receive.

PDOfferDetailReward

Defines the incentive as described in the offer detail view.

Property	Description
`discountPercentage`	NSNumber A percentage by which this offer reduces the total amount due for qualifying purchases. For example: `10`% off.
`discountValue`	NSNumber A dollar amount by which the offer reduces the total amount due for qualifying purchases. For example: $`5` off.
`rewardType`	`PDRewardType` Enum Identifies the type of reward the user would receive.

PDSkuItem

Defines a particular product as it pertains to an offer. For example, if an offer states that the customer is entitled to a free cookie when a meal is purchased, the cookie product identification, or SKU, would need to be associated with the offer.

Property	Description
`itemCode`	String The unique SKU code that identifies the product.

Offer Message Objects

PDRetrieveAvailableOfferCampaignSummariesRequest

Applies filtering parameters to the retrieval of available offer campaign summaries.

Property	Description
`offerSummaryLocationFilters`	Array The set of `PDOfferSummaryLocationFilter` instances for the set of geographical areas used to filter the list of available offers. For example, the app may only show offers that are valid in `California` or zip code `02116`.
`offerCategoryNames`	Array Offer category names used to filter list of results.
`offerCategoryUris`	Array The set of unique URI string value identifiers for offer categories used to filter lists.
`offerSummaryFilterParameters`	`PDOfferSummaryFilterParameters` Specifies the boundaries used when the list of returned offer summaries are constrained, such as by a valid date range or by valid merchants.

PDRetrieveAvailableOfferCampaignSummariesResponse

Returns the list of offer campaign summaries based on the specifications in the originating request.

Property	Description
`offerCampaignSummaries`	Array The set of `PDOfferCampaignSummary` instances for the campaign summaries that matched the request criteria.
`noOfRecords`	Integer The number of summary instances included in the response.
`offerSummaryFilterParameters`	`PDOfferSummaryFilterParameters` Specifies the boundaries used to filter the list of returned offer summaries.

PDRetrieveOfferCampaignSummaryUsingCouponCodeRequest

Queries the list of offer campaign summaries associated with a coupon code.

Property	Description
`couponCode`	String The identifier of a multi-channel, customer-agnostic version of the offer campaign.
`offerCampaignSummaryLocationFilters`	Array The set of `PDOfferCampaignSummaryLocationFilter` instances for the set of geographical areas used to filter the list of returned offer campaigns. For example, the app may only show offers that are valid in `California` or zip code `02116`.
`offerCategoryNames`	Array Set of offer category name strings used to filter list of results.
`offerCategoryUris`	Array The set of unique URI string value identifiers for offer categories used to filter lists.
`offerCampaignSummaryFilterParameters`	`PDOfferCampaignSummaryFilterParameters` Specifies the boundaries used to filter the list of returned offer campaigns.

PDRetrieveOfferCampaignSummaryUsingCouponCodeResponse

Returns the list of offer campaign summaries based on the specifications in the originating request.

Property	Description
`offerCampaignSummaries`	Array The set of `PDOfferCampaignSummary` instances for the campaign summaries that matched the request criteria.
`noOfRecords`	Integer The number of campaign summary instances included in the response.
`offerCampaignSummaryFilterParameters`	`PDOfferCampaignSummaryFilterParameters` Specifies the boundaries used to filter the list of returned offer campaigns.
`couponCode`	String If the offer is distributed in an external channel such as email or social media, this is code used to identify the coupon to the system.

PDRetrieveMyOfferSummariesRequest

Retrieves the set of activated offer summaries (My Offers) for the wallet that corresponds to the specified filtering criteria.

Property	Description
`offerSummaryFilterParameters`	`PDOfferSummaryFilterParameters` Specifies the boundaries used to constrain the list of returned offer summaries, such as by a valid date range or valid merchants.

PDRetrieveMyOfferSummariesResponse

Returns the list of offer summaries based on the specifications in the originating request.

Property	Description
`offerSummaries`	Array The set of `PDOfferSummary` instances for the offer summaries that matched the request criteria.
`noOfRecords`	Integer The number of summary instances included in the response.
`offerSummaryFilterParameters`	`PDOfferSummaryFilterParameters`` Specifies the boundaries used to filter the list of returned offer summaries.

PDRetrieveAvailableOfferCampaignDetailRequest

Retrieves the details for the specified campaign.

Property	Description
`offerCampaignUri`	String The unique identifier for the offer campaign for which details are requested.

PDRetrieveAvailableOfferCampaignDetailResponse

Returns the full content detail of the campaign specified in the originating request.

Property	Description
`offerCampaignDetail`	`PDOfferCampaignDetail` The offer campaign specified in the request.

PDRetrieveMyOfferDetailRequest

Retrieves the full content detail for the specified activated offer (My Offer) in the wallet.

Property	Description
`offerUri`	String The unique identifier for an offer that the user has activated in the wallet.

PDRetrieveMyOfferDetailResponse

Returns the full content detail of the offer specified in the originating request.

Property	Description
`offerDetail`	`PDOfferDetail` The offer specified in the originating request.

PDActivateOfferRequest

Convert an available offer or coupon code to an activated offer (My Offer) in the wallet.

Property	Description
`offerCampaignUri`	String The unique identifier for an offer that the user has activated in the wallet.
`checkoutTokenValue`	String If an offer is presented to the user during an active transaction, identify that transaction by the checkoutToken that initiated it for ROI tracking purposes.
`couponCode`	String If the offer is distributed in an external channel such as email or social media, identify the coupon code.

PDActivateOfferResponse