Class GiftCertificateMgr

The GiftCertificateMgr class contains a set of static methods for interacting with GiftCertificates.

ConstantDescription
GC_ERROR_DISABLED: String = "GIFTCERTIFICATE-100"Indicates that an error occurred because the Gift Certificate is currently disabled.
GC_ERROR_INSUFFICIENT_BALANCE: String = "GIFTCERTIFICATE-110"Indicates that an error occurred because the Gift Certificate does not have a sufficient balance to perform the requested operation.
GC_ERROR_INVALID_AMOUNT: String = "GIFTCERTIFICATE-140"Indicates that an error occurred because the Gift Certificate Amount was not valid.
GC_ERROR_INVALID_CODE: String = "GIFTCERTIFICATE-150"Indicates that an error occurred because the Gift Certificate ID was not valid.
GC_ERROR_PENDING: String = "GIFTCERTIFICATE-130"Indicates that an error occurred because the Gift Certificate has been fully redeemed.
GC_ERROR_REDEEMED: String = "GIFTCERTIFICATE-120"Indicates that an error occurred because the Gift Certificate has been fully redeemed.

This class does not have a constructor, so you cannot create it directly.

MethodDescription
static createGiftCertificate(Number)Creates a Gift Certificate.
static createGiftCertificate(Number, String)Creates a Gift Certificate.
static getGiftCertificate(String)Returns the Gift Certificate identified by the specified gift certificate code.
static getGiftCertificateByCode(String)Returns the Gift Certificate identified by the specified gift certificate code.
static getGiftCertificateByMerchantID(String)Returns the Gift Certificate identified by the specified merchant ID.
static redeemGiftCertificate(OrderPaymentInstrument)Redeems an amount from a Gift Certificate.

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

GC_ERROR_DISABLED: String = "GIFTCERTIFICATE-100"

Indicates that an error occurred because the Gift Certificate is currently disabled.

Deprecated:

Use GiftCertificateStatusCodes instead.
GC_ERROR_INSUFFICIENT_BALANCE: String = "GIFTCERTIFICATE-110"

Indicates that an error occurred because the Gift Certificate does not have a sufficient balance to perform the requested operation.

Deprecated:

Use GiftCertificateStatusCodes instead.
GC_ERROR_INVALID_AMOUNT: String = "GIFTCERTIFICATE-140"

Indicates that an error occurred because the Gift Certificate Amount was not valid.

Deprecated:

Use GiftCertificateStatusCodes instead.
GC_ERROR_INVALID_CODE: String = "GIFTCERTIFICATE-150"

Indicates that an error occurred because the Gift Certificate ID was not valid.

Deprecated:

Use GiftCertificateStatusCodes instead.
GC_ERROR_PENDING: String = "GIFTCERTIFICATE-130"

Indicates that an error occurred because the Gift Certificate has been fully redeemed.

Deprecated:

Use GiftCertificateStatusCodes instead.
GC_ERROR_REDEEMED: String = "GIFTCERTIFICATE-120"

Indicates that an error occurred because the Gift Certificate has been fully redeemed.

Deprecated:

Use GiftCertificateStatusCodes instead.
static createGiftCertificate(amount: Number): GiftCertificate

Creates a Gift Certificate. The system will assign a code to the new Gift Certificate.

Parameters:

  • amount - the amount of the gift certificate. Must not be negative or zero.

Returns:

  • the newly created Gift Certificate.
static createGiftCertificate(amount: Number, code: String): GiftCertificate

Creates a Gift Certificate. If a non-empty Gift Certificate code is specified, the code will be used to create the Gift Certificate. Be aware that this code must be unique for the current site. If it is not unique, the Gift Certificate will not be created.

Parameters:

  • amount - the amount of the gift certificate. Must not be negative or zero.
  • code - the code for the new gift certificate. If parameter is null or empty , the system will assign a code to the new gift certificate.

Returns:

  • the newly created Gift Certificate.
static getGiftCertificate(giftCertificateCode: String): GiftCertificate

Returns the Gift Certificate identified by the specified gift certificate code.

Parameters:

  • giftCertificateCode - to identify the Gift Certificate.

Returns:

  • the Gift Certificate identified by the specified code or null.

Deprecated:

Use getGiftCertificateByCode(String)
static getGiftCertificateByCode(giftCertificateCode: String): GiftCertificate

Returns the Gift Certificate identified by the specified gift certificate code.

Parameters:

  • giftCertificateCode - to identify the Gift Certificate.

Returns:

  • the Gift Certificate identified by the specified code or null.
static getGiftCertificateByMerchantID(merchantID: String): GiftCertificate

Returns the Gift Certificate identified by the specified merchant ID.

Parameters:

  • merchantID - to identify the Gift Certificate.

Returns:

  • the Gift Certificate identified by the specified merchant ID or null.
static redeemGiftCertificate(paymentInstrument: OrderPaymentInstrument): Status

Redeems an amount from a Gift Certificate. The Gift Certificate ID is specified in the OrderPaymentInstrument and the amount specified in the PaymentTransaction associated with the OrderPaymentInstrument. If the PaymentTransaction.getTransactionID() is not null, the value returned by this method is used as the 'Order Number' for the redemption transaction. The 'Order Number' is visible via the Business Manager.

Parameters:

  • paymentInstrument - the OrderPaymentInstrument containing the ID of the Gift Certificate to redeem, and the amount of the redemption.

Returns:

  • the status of the redemption operation.