Class PromoCode

• Defined in File PromoCode.cs

Inheritance Relationships

Base Type

• public xbe.sdk.EntityBase (Class EntityBase)

Class Documentation

class xbe.sdk.Models.PromoCode : xbe.sdk.EntityBase

A promotional code that can be applied to an order to obtain a pricing discount, cash back or free product.

REQUIRES: Purchasing Services

Public Functions

PromoCode ()

PromoCode (Object obj)

Properties

string Name { get; set; }

The unique name of the promotional code.

string Description { get; set; }

The textual description of the promotion.

int MaxUses { get; set; }

The maximum number of times that the promotion can be redeemed. If -1 indicates no limit.

DateTime Expires { get; set; }

The date and time that the promotion expires and can no longer be redeemed. A null value indicates no expiration date.

DateTime Starts { get; set; }

The date and time that the promotion begins and can be redeemed.

int Redeemed { get; set; }

The number of times that this promotion has been redeemed.

string > Products { get; set; }

The list of product uid’s that this promotion can be applied to. If null then applies to all products.

string > Customers { get; set; }

The list of wallet uid’s that can redeem this promotion. If null then anyone can redeem.

double Amount { get; set; }

The amount of the promotion to apply when redeemed.

PromoCodeType Type { get; set; }

The type of promotion that will be applied when redeemed.

Public Static Functions

new PromoCode Parse (string json)

Parses the given JSON encoded string into a new PromoCode instance.

Param json:

Return: