API Technical Transfer Specifications

For changes in the Transfer system as of v1.9.0 of MageRewards, see  Points Transfers in MageRewards v1.9

Basic Transfer Status Values

The transfer status controls the flow & validity of a transfer to ensure every component of the system treats them properly.

const STATUS_CANCELLED        = 1;
const STATUS_PENDING_APPROVAL = 3;
const STATUS_PENDING_EVENT    = 4;
const STATUS_APPROVED         = 5;
const STATUS_PENDING_TIME     = 6;

For a breakdown of each points transfer status and what it means, see Points Transfer Statuses.

Basic Transfer Reason Values

The transfer reason helps identify how the system should approach rendering and indexing the transfer.

   const REASON_CUSTOMER_REDEMPTION   = -1;
   const REASON_CUSTOMER_DISTRIBUTION =  1;
   const REASON_SYSTEM_ADJUSTMENT     =  2;
   const REASON_FROM_CUSTOMER         =  3;
   const REASON_TO_CUSTOMER           =  4;
   const REASON_SYSTEM_REVOKED        =  5;
   const REASON_ADMIN_ADJUSTMENT      =  6;
   const REASON_UNSPECIFIED           =  0;
   // Submodule: MageRewards Referral
   const REASON_REFERRAL_SIGNUP     = 20;
   const REASON_REFERRAL_FIRSTORDER = 21;
   const REASON_REFERRAL_ORDER      = 22;
   const REASON_TYPE_ID             = 23; - Guest Order
   const REASON_TYPE_ID             = 35; - Referral Link Share
   // Submodule: MageRewards Social
   const REASON_FACEBOOK_LIKE = 30;
   const REASON_TYPE_ID       = 34; - Twitter Follow
   const REASON_TYPE_ID       = 36; - Facebook Product Share
   // Submodule: MageRewards Instore *NOTE: THIS MODULE IS NO LONGER BEING DEVELOPED
   const REASON_INSTORE_QUOTE  = 50;
   const REASON_INSTORE_SIGNUP = 51;

Basic Transfer Reference Values

The transfer reference links a transfer to its origin (usually this is a sales order). This is useful for cross-checking that the transfer is valid. Since there are many origins from which a transfer can be created, we use reference  types to associate the reference ID with its appropriate database table. Also, a transfer can have multiple references. If you are developing a module that needs to add a new Transfer Reference type to MageRewards, please let us know what your Reference Type ID is so we can add it to this page to avoid conflicts.


   const REFERENCE_ORDER       = 1;
   const REFERENCE_POLL        = 3;
   const REFERENCE_RATING      = 5;
   const REFERENCE_TRANSFER    = 6;
   const REFERENCE_SIGNUP      = 7;
   const REFERENCE_TO_FRIEND   = 8;
   const REFERENCE_FROM_FRIEND = 9;
   const REFERENCE_TYPE_ID     = 10; - Newsletter Subscribe
   const REFERENCE_TYPE_ID     = 2;  - Review
   // Submodule: MageRewards Referral
   const REFERENCE_REFERRAL       = 20;
   const REFERENCE_REFERRAL_ORDER = 21;
   const REFERENCE_TYPE_ID        = 72; - Referral Link Share
   // Submodule: MageRewards Instore *NOTE: THIS MODULE IS NO LONGER BEING DEVELOPED
   const REFERENCE_INSTORE_QUOTE  = 50;
   const REFERENCE_INSTORE_SIGNUP = 51;
   // Submodule: MageRewards Social
   const REFERENCE_FACEBOOK_LIKE = 60;
   const REFERENCE_TYPE_ID       = 70; - Twitter Tweet
   const REFERENCE_TYPE_ID       = 71; - Pinterest Pin
   const REFERENCE_TYPE_ID       = 73; - Google +
   const REFERENCE_TYPE_ID       = 74; - Facebook Product Share
   const REFERENCE_TYPE_ID       = 80; - Facebook Purchase Share
   const REFERENCE_TYPE_ID       = 83; - Twitter Purchase Tweet
   //Submodule: MageRewards Milestone
   const POINTS_GENERIC_REFERENCE_TYPE_ID = 600; - Generic Milestone
   const POINTS_REFERENCE_TYPE_ID         = 601; - Orders Milestone
   const POINTS_REFERENCE_TYPE_ID         = 602; - Membership Milestone
   const POINTS_REFERENCE_TYPE_ID         = 603; - Inactivity Milestone
   const POINTS_REFERENCE_TYPE_ID         = 604; - Referral Milestone

Still need help? Get Help Get Help