Share via


Commerce Foundation RequestedPromoCode

This Commerce Server 2009 commerce entity represents a promotion code the shopper applied to the shopper's order to obtain the related discounts.

Model

This commerce entity can be modified, as required. This model, taken from the out-of-the-box site, is provided as an example.

<CommerceEntity name="RequestedPromoCode">
    <EntityMappings>
      <EntityMapping csType="Microsoft.CommerceServer.Runtime.Orders.PromoCodeRecord" csAssembly="Microsoft.CommerceServer.Runtime, Version=6.0.1.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35">
        <PropertyMappings>
          <PropertyMapping property="Applied" csProperty="PromoApplied"/>
          <PropertyMapping property="Code" csProperty="PromoCode"/>
          <PropertyMapping property="DefinitionId" csProperty="PromoCodeDefinitionId"/>
          <PropertyMapping property="LookupDate" csProperty="PromoCodeLookupDate"/>
          <PropertyMapping property="Reserved" csProperty="PromoCodeReserved"/>
          <PropertyMapping property="Status" csProperty="PromoCodeStatus"/>
        </PropertyMappings>
      </EntityMapping>
    </EntityMappings>
 </CommerceEntity>

Properties

Property

Type

Description

Applied

bool?

Gets or sets a value that indicates if one or more discounts associated with the current PromoCode definition is actually applied to the basket.

Code

String

Gets or sets a promotion code entered by the shopper.

DefinitionId

String

Gets or sets the identifier of the promo code definition.

LookupDate

DateTime

Gets or sets the date and time when the promotion code was last validated or reserved.

Reserved

bool?

Gets or sets a value that indicates the reservation for the current instance was successful.

Status

int?

Gets or sets the status of the current instance.

ValueDescription
0Valid. Indicates that the PromoCode is valid.
1Invalid. Indicates that the value provided by the shopper was not a valid PromoCode.
2LimitReached. Indicates that the promotion code definition associated with this PromoCode has reached its limit.
3IdentityMismatch. Indicates there has been an identity mismatch for this PromoCode.

Relationships

None.

Supported Operations

Commerce Foundation Basket CommerceQuery

Commerce Foundation Basket CommerceUpdate

See Also

Other Resources

Developing with the Commerce Foundation Orders System