## Promotions
---
### PromotionResponse
**Declared In:**
Headers/SNRPromotionResponse.h
**Related To:**
[PromotionResponseMetadata](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionresponsemetadata)
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)
**Inherits From:**
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
**Declaration:**
Swift Objective-C
```Swift
class PromotionResponse: BaseModel
```
```Objective-C
@interface SNRPromotionResponse : SNRBaseModel
```
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **metadata** | [PromotionResponseMetadata](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionresponsemetadata) | yes | Metadata of the promotion response |
| **items** | [[Promotion]](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers/#promotion) | no | List of promotion items |
All properties are read-only.
Swift Objective-C
```Swift
class PromotionResponseMetadata: BaseModel
```
```Objective-C
@interface SNRPromotionResponseMetadata : SNRBaseModel
```
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **totalCount** | Int | no | Total count of promotions |
| **totalPages** | Int | no | Total count of pages |
| **page** | Int | no | Current page |
| **limit** | Int | no | Limit of promotions per page |
| **code** | Int | no | HTTP code of the response |
All properties are read-only.
Swift Objective-C
```Swift
class Promotion: BaseModel
```
```Objective-C
@interface SNRPromotion : SNRBaseModel
```
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **uuid** | String | no | Promotion's UUID |
| **code** | String | no | Promotion's code |
| **status** | [PromotionStatus](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionstatus) | no | Promotion's status |
| **type** | [PromotionType](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiontype) | no | Promotion's type |
| **details** | [PromotionDetails](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondetails) | yes | Promotion's details |
| **redeemLimitPerClient** | NSNumber | yes | Redemption limit per customer |
| **redeemQuantityPerActivation** | NSNumber | yes | Redemption quantity per activation |
| **currentRedeemedQuantity** | NSNumber | no | Current redemption quantity |
| **currentRedeemLimit** | NSNumber | no | Current redemption limit |
| **activationCounter** | NSNumber | no | Promotion's activation counter |
| **possibleRedeems** | NSNumber | no | Maximum number of promotion redemptions |
| **requireRedeemedPoints** | NSNumber | yes | Required redeemed points |
| **discountType** | [PromotionDiscountType](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscounttype) | no | Discount type |
| **discountValue** | NSNumber | no | Discount value |
| **discountMode** | [PromotionDiscountMode](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscountmode) | no | Discount mode |
| **discountModeDetails** | [PromotionDiscountModeDetails](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscountmodedetails) | yes | Discount mode details |
| **priority** | NSNumber | no | Promotion's priority |
| **price** | NSNumber | no | Item price |
| **itemScope** | [PromotionItemScope](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionitemscope) | no | Promotion's item scope |
| **minBasketValue** | NSNumber | yes | Minimum basket value |
| **maxBasketValue** | NSNumber | yes | Maximum basket value |
| **name** | String | no | Promotion's name |
| **headline** | String | yes | Promotion's headline |
| **descriptionText** | String | yes | Promotion's description |
| **images** | [[PromotionImage](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionimage)] | yes | List of promotion images |
| **startAt** | Date | yes | Start time of a promotion |
| **expireAt** | Date | yes | Expiration time of the promotion |
| **lastingAt** | Date | yes | Date when the promotion expires for the current profile |
| **lastingTime** | NSNumber | yes | Duration of the promotion in seconds |
| **displayFrom** | String | yes | Date as a string when the promotion starts being displayed |
| **displayTo** | String | yes | Date as a string when the promotions ends being displayed |
| **catalogIndexItems** | [String] | yes | List of item indexes |
| **params** | [AnyHashable: Any] | yes | Promotion's custom parameters |
| **tags** | [AnyObject] | yes | Promotion's custom tags |
All properties are read-only.
Swift Objective-C
```Swift
enum PromotionStatus: Int {
none,
active,
assigned,
redeemed
}
```
```Objective-C
typedef NS_ENUM(NSUInteger, SNRPromotionStatus) {
SNRPromotionStatusNone = 0,
SNRPromotionStatusActive,
SNRPromotionStatusAssigned,
SNRPromotionStatusRedeemed
}
```
**Functions:**
Converts from **PromotionStatus** to **String**.
Swift Objective-C
```Swift
func SNR_PromotionStatusToString(_: PromotionStatus) -> String
```
```Objective-C
NSString * SNR_PromotionStatusToString(SNRPromotionStatus type)
```
---
Converts from **String** to **PromotionStatus**.
Swift Objective-C
```Swift
func SNR_StringToPromotionStatus(_: String) -> PromotionStatus
```
```Objective-C
SNRPromotionStatus SNR_StringToPromotionStatus(NSString * _Nullable string)
```
**Note:**
The following string constants can be used in [PromotionsApiQuery](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionsapiquery) object:
- SNR_PROMOTION_STATUS_NONE
- SNR_PROMOTION_STATUS_ACTIVE
- SNR_PROMOTION_STATUS_ASSIGNED
- SNR_PROMOTION_STATUS_REDEEMED
---
---
### PromotionType
**Declared In:**
Headers/SNRPromotionType.h
**Related To:**
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)
**Declaration:**
Swift Objective-C
```Swift
enum PromotionType: Int {
unknown,
membersOnly,
custom,
general,
handbill
}
```
```Objective-C
typedef NS_ENUM(NSUInteger, SNRPromotionType) {
SNRPromotionTypeUnknown = 0,
SNRPromotionTypeMembersOnly,
SNRPromotionTypeCustom,
SNRPromotionTypeGeneral,
SNRPromotionTypeHandbill
}
```
**Functions:**
Converts from **PromotionType** to **String**.
Swift Objective-C
```Swift
func SNR_PromotionTypeToString(_: PromotionType) -> String
```
```Objective-C
NSString * SNR_PromotionTypeToString(SNRPromotionType type)
```
---
Converts from **String** to **PromotionType**.
Swift Objective-C
```Swift
func SNR_StringToPromotionType(_: String) -> PromotionType
```
```Objective-C
SNRPromotionType SNR_StringToPromotionType(NSString * _Nullable string)
```
**Note:**
The following string constants can be used in [PromotionsApiQuery](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionsapiquery) object:
- SNR_PROMOTION_TYPE_UNKNOWN
- SNR_PROMOTION_TYPE_MEMBERS_ONLY
- SNR_PROMOTION_TYPE_CUSTOM
- SNR_PROMOTION_TYPE_GENERAL
---
---
### PromotionItemScope
**Declared In:**
Headers/SNRPromotionItemScope.h
**Related To:**
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)
**Declaration:**
Swift Objective-C
```Swift
enum PromotionItemScope: Int {
lineItem,
basket
}
```
```Objective-C
typedef NS_ENUM(NSUInteger, SNRPromotionItemScope) {
SNRPromotionItemScopeLineItem = 0,
SNRPromotionItemScopeBasket
}
```
**Functions:**
Converts from **PromotionItemScope** to **String**.
Swift Objective-C
```Swift
func SNR_PromotionItemScopeToString(_: PromotionItemScope) -> String
```
```Objective-C
NSString * SNR_PromotionItemScopeToString(SNRPromotionItemScope scope)
```
---
Converts from **String** to **PromotionItemScope**.
Swift Objective-C
```Swift
func SNR_StringToPromotionItemScope(_: String) -> PromotionItemScope
```
```Objective-C
SNRPromotionItemScope SNR_StringToPromotionItemScope(NSString * _Nullable string)
```
---
---
### PromotionDetails
**Declared In:**
Headers/SNRPromotionDetails.h
**Related To:**
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)
[PromotionDiscountTypeDetails](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscounttypedetails)
**Inherits From:**
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
**Declaration:**
Swift Objective-C
```Swift
class PromotionDetails: BaseModel
```
```Objective-C
@interface SNRPromotionDetails : SNRBaseModel
```
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **discountType** | [PromotionDiscountTypeDetails](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscounttypedetails) | no | Discount details |
All properties are read-only.
Swift Objective-C
```Swift
class PromotionDiscountTypeDetails: BaseModel
```
```Objective-C
@interface SNRPromotionDiscountTypeDetails : SNRBaseModel
```
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **name** | String | no | Discount's name |
| **outerScope** | Bool | no | When `true`, the items required to trigger the promotion are different than the items included in that promotion. |
| **requiredItemsCount** | Int | no | Number of items required to qualify for the discount |
| **discountedItemsCount** | Int | no | Number of discounted items |
All properties are read-only.
Swift Objective-C
```Swift
enum PromotionDiscountMode: Int {
static,
step
}
```
```Objective-C
typedef NS_ENUM(NSUInteger, SNRPromotionDiscountMode) {
SNRPromotionDiscountModeStatic = 0,
SNRPromotionDiscountModeStep
}
```
**Functions:**
Converts from **PromotionDiscountMode** to **String**.
Swift Objective-C
```Swift
func SNR_PromotionDiscountModeToString(_: PromotionDiscountMode) -> String
```
```Objective-C
NSString * SNR_PromotionDiscountModeToString(SNRPromotionDiscountMode mode)
```
---
Converts from **String** to **PromotionDiscountMode**.
Swift Objective-C
```Swift
func SNR_StringToPromotionDiscountMode(_: String) -> PromotionDiscountMode
```
```Objective-C
SNRPromotionDiscountMode SNR_StringToPromotionDiscountMode(NSString * _Nullable string)
```
---
---
### PromotionDiscountModeDetails
**Declared In:**
Headers/SNRPromotionDiscountModeDetails.h
**Related To:**
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)
[PromotionDiscountStep](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscountstep)
**Inherits From:**
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
**Declaration:**
Swift Objective-C
```Swift
class PromotionDiscountModeDetails: BaseModel
```
```Objective-C
@interface SNRPromotionDiscountModeDetails : SNRBaseModel
```
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **discountSteps** | [[SNRPromotionDiscountStep]](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers/#promotion) | no | List of discount steps |
| **discountUsageTrigger** | [PromotionDiscountUsageTrigger](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscountusagetrigger) | no | Usage trigger for the discount |
All properties are read-only.
Swift Objective-C
```Swift
class PromotionDiscountStep: BaseModel
```
```Objective-C
@interface SNRPromotionDiscountStep : SNRBaseModel
```
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **discountValue** | NSNumber | no | Value of the discount |
| **usageThreshold** | NSNumber | no | Usage threshold |
All properties are read-only.
Swift Objective-C
```Swift
enum PromotionDiscountUsageTrigger: Int {
transaction,
redeem
}
```
```Objective-C
typedef NS_ENUM(NSUInteger, SNRPromotionDiscountUsageTrigger) {
SNRPromotionDiscountUsageTriggerTransaction = 0,
SNRPromotionDiscountUsageTriggerRedeem
}
```
**Functions:**
Converts from **PromotionDiscountUsageTrigger** to **String**.
Swift Objective-C
```Swift
func SNR_PromotionDiscountUsageTriggerToString(_: PromotionDiscountUsageTrigger) -> String
```
```Objective-C
NSString * SNR_PromotionDiscountUsageTriggerToString(SNRPromotionDiscountUsageTrigger trigger)
```
---
Converts from **String** to **PromotionDiscountUsageTrigger**.
Swift Objective-C
```Swift
func SNR_StringToPromotionDiscountUsageTrigger(_: String) -> PromotionDiscountUsageTrigger
```
```Objective-C
SNRPromotionDiscountUsageTrigger SNR_StringToPromotionDiscountUsageTrigger(NSString * _Nullable string)
```
---
---
### PromotionImage
**Declared In:**
Headers/SNRPromotion.h
**Related To:**
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)
[PromotionImageType](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionimagetype)
**Inherits From:**
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
**Declaration:**
Swift Objective-C
```Swift
class PromotionImage: BaseModel
```
```Objective-C
@interface SNRPromotionImage : SNRBaseModel
```
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **url** | String | no | Image's URL |
| **type** | [PromotionImageType](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionimagetype) | no | Image type |
All properties are read-only.
Swift Objective-C
```Swift
enum PromotionImageType: Int {
image,
thumbnail
}
```
```Objective-C
typedef NS_ENUM(NSUInteger, SNRPromotionImageType) {
SNRPromotionImageTypeImage = 0,
SNRPromotionImageTypeThumbnail
}
```
**Functions:**
Converts from **PromotionImageType** to **String**.
Swift Objective-C
```Swift
func SNR_PromotionImageTypeToString(_: PromotionImageType) -> String
```
```Objective-C
NSString * SNR_PromotionImageTypeToString(SNRPromotionImageType type)
```
---
Converts from **String** to **PromotionImageType**.
Swift Objective-C
```Swift
func SNR_StringToPromotionImageType(_: String) -> PromotionImageType
```
```Objective-C
SNRPromotionImageType SNR_StringToPromotionImageType(NSString * _Nullable string)
```
---
---
### PromotionDiscountType
**Declared In:**
Headers/SNRPromotionDiscountType.h
**Related To:**
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)
**Declaration:**
Swift Objective-C
```Swift
enum PromotionDiscountType: Int {
none,
percent,
amount,
2For1,
points,
multibuy,
exactPrice
}
```
```Objective-C
typedef NS_ENUM(NSUInteger, SNRPromotionDiscountType) {
SNRPromotionDiscountTypeNone = 0,
SNRPromotionDiscountTypePercent,
SNRPromotionDiscountTypeAmount,
SNRPromotionDiscountType2For1,
SNRPromotionDiscountTypePoints,
SNRPromotionDiscountTypeMultibuy,
SNRPromotionDiscountTypeExactPrice
}
```
**Functions:**
Converts from **PromotionDiscountType** to **String**.
Swift Objective-C
```Swift
func SNR_PromotionDiscountTypeToString(_: PromotionDiscountType) -> String
```
```Objective-C
NSString * SNR_PromotionDiscountTypeToString(SNRPromotionDiscountType type)
```
---
Converts from **String** to **PromotionDiscountType**.
Swift Objective-C
```Swift
func SNR_StringToPromotionDiscountType(_: String) -> PromotionDiscountType
```
```Objective-C
SNRPromotionDiscountType SNR_StringToPromotionDiscountType(NSString * _Nullable string)
```
---
---
### PromotionIdentifier
**Declared In:**
Headers/SNRPromotionIdentifier.h
**Inherits From:**
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
**Declaration:**
Swift Objective-C
```Swift
class PromotionIdentifier: BaseModel
```
```Objective-C
@interface SNRPromotionIdentifier : SNRBaseModel
```
**Initializers:**
Swift Objective-C
```Swift
init(uuid: String)
```
```Objective-C
- (instancetype)initWithUUID:(NSString *)UUID
```
---
Swift Objective-C
```Swift
init(code: String)
```
```Objective-C
- (instancetype)initWithCode:(NSString *)code
```
---
---
### PromotionsApiQuery
Object for setting parameters to facilitate fetching promotions from the API.
**Declared In:**
Headers/SNRPromotionsApiQuery.h
**Related To:**
[PromotionResponse](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionresponse)
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)
[ApiQuerySortingOrderString](/developers/mobile-sdk/class-reference/ios/miscellaneous#apiquerysortingorder)
**Inherits From:**
[NSObject](https://developer.apple.com/documentation/objectivec/nsobject)
**Declaration:**
Swift Objective-C
```Swift
class PromotionsApiQuery: NSObject
```
```Objective-C
@interface SNRPromotionsApiQuery : NSObject
```
**Properties:**
| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **statuses** | [[SNRPromotionStatusString]](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers/#promotionstatus) | no | [] | List of promotion statuses for query |
| **types** | [[SNRPromotionTypeString]](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers/#promotiontype) | no | [] | List of promotion types for query |
| **sorting** | [[SNRPromotionSortingKey: SNRApiQuerySortingOrderString]] | yes | [] | Specifies sorting rules for items in the response |
| **limit** | Int | no | 100 | Limit of items per page in the response |
| **page** | Int | no | 1 | Page number |
| **includeMeta** | Bool | no | false | Specifies if meta data should be included in the response |
- Check the list of promotion sorting keys available in [Loyalty - Promotion sorting options](/developers/mobile-sdk/loyalty#promotion-sorting-options) section.
- See [ApiQuerySortingOrderString](/developers/mobile-sdk/class-reference/ios/miscellaneous#apiquerysortingorder) to check ordering options.
Swift Objective-C
```Swift
init()
```
```Objective-C
- (instancetype)init
```
---
---
## Vouchers
---
### AssignVoucherResponse
**Declared In:**
Headers/SNRAssignVoucherResponse.h
**Related To:**
[AssignVoucherData](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#assignvoucherdata)
**Inherits From:**
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
**Declaration:**
Swift Objective-C
```Swift
class AssignVoucherResponse: BaseModel
```
```Objective-C
@interface SNRAssignVoucherResponse : SNRBaseModel
```
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **message** | String | no | Message from the Voucher assignment response |
| **assignVoucherData** | [AssignVoucherData](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#assignvoucherdata) | yes | List of vouchers in a pool |
All properties are read-only.
Swift Objective-C
```Swift
class VoucherCodesResponse: BaseModel
```
```Objective-C
@interface SNRVoucherCodesResponse : SNRBaseModel
```
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **items** | [[VoucherCodesData]](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers/#vouchercodesdata) | no | List of voucher items |
All properties are read-only.
Swift Objective-C
```Swift
class AssignVoucherData: BaseModel
```
```Objective-C
@interface SNRAssignVoucherData : SNRBaseModel
```
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **code** | String | no | Voucher's code |
| **expireIn** | Date | yes | Voucher's expiration date |
| **redeemAt** | Date | yes | Voucher's redemption date |
| **assignedAt** | Date | yes | Voucher's assignment date |
| **createdAt** | Date | no | Voucher's creation date |
| **updatedAt** | Date | no | Voucher's update date |
All properties are read-only.
Swift Objective-C
```Swift
class VoucherCodesData: BaseModel
```
```Objective-C
@interface SNRVoucherCodesData : SNRBaseModel
```
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **code** | String | no | Voucher's code |
| **status** | [VoucherStatus](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#voucherstatus) | no | Voucher's status |
| **clientId** | String | no | ID of the customer to whom the voucher is assigned |
| **clientUuid** | String | no | UUID of the customer to whom the voucher is assigned |
| **poolUuid** | String | no | Voucher's pool ID |
| **expireIn** | Date | no | Voucher's expiration date |
| **redeemAt** | Date | no | Voucher's redemption date |
| **assignedAt** | Date | no | Voucher's assignment date |
| **createdAt** | Date | no | Voucher's creation date |
| **updatedAt** | Date | no | Voucher's update date|
All properties are read-only.
Swift Objective-C
```Swift
enum VoucherStatus: Int {
unassigned,
assigned,
redeemed,
canceled
}
```
```Objective-C
typedef NS_ENUM(NSUInteger, SNRVoucherStatus) {
SNRVoucherStatusUnassigned = 0,
SNRVoucherStatusAssigned,
SNRVoucherStatusRedeemed,
SNRVoucherStatusCanceled
}
```
**Functions:**
Converts from **VoucherStatus** to **String**.
Swift Objective-C
```Swift
func SNR_VoucherStatusToString(_: VoucherStatus) -> String
```
```Objective-C
NSString * SNR_VoucherStatusToString(SNRVoucherStatus type)
```
---
Converts from **String** to **VoucherStatus**.
Swift Objective-C
```Swift
func SNR_StringToVoucherStatus(_: String) -> VoucherStatus
```
```Objective-C
SNRVoucherStatus SNR_StringToVoucherStatus(NSString * _Nullable string)
```