Loading...
 

APIs

       MARKET POWER

      PRO ENTERPRISE

              (MPPE) 

            API REFERENCE 

 




 

INTRODUCTION

The Market Power Pro Enterprise (MPPE) API allows

MLM clients to process their own web-based application

for e-commerce transactions.

Base on the SOAP (Simple Object Access Protocol) standard.

MPPE API use XML messages to pass request(s) and

response(s) build within MLM Client’s website.


 

AUTHENTICATION

Authentication of client using the API is a hash key

that is passed in the request. The hash key is given to each

MLM client implementing MPPE API. The hash key is unique

per MLM client.

 

 

BUILDING THE REQUEST MESSAGE

Access MPPE API by sending request message(s)

in plain-text XML format. Methods of generating XML

messages vary, but each message must be formatted properly.

Each request begins with an HTTP header and includes the

operation’s corresponding XML element wrapped in a SOAP

envelope and body.

 

HTTP Header

An HTTP header precedes the request message. MPPE API request message use the following Header:

Image  
Length is the message length in bytes and Method is name of the requested MPPE API Method.


SOAP Envelope / Body

The request message is wrapped in a SOAP envelope and body using the following XML structure:

Image  

<Method> is the XML element corresponding to the requested operation.

 

Method Format

The method XML element corresponds to a MPPE API method. The method element is nested in the <soap:Body> element, and includes XML elements for each of the input parameters required by the operation. MPPE API methods use the following XML structure:

Image  

<MethodName> is the name of the MPPE API Method. Input values for each parameter are nested in the XML tag corresponding to the parameter name.

 

Sample Message

The following sample request message uses the GetCountries method:

Image  


 

READING THE RESPONSE MESSAGE

A response message provides the result(s) of the operation requested in the corresponding request message.  Response messages are returned in plain-test XML format. Each response begins with an HTPP header and includes the operation’s corresponding XML element wrapped in a SOAP envelope and body.

 

HTTP Header

An HTTP header precedes the response message. MPPE API response messages use the following HTTP Header:

Image  

Length is the response message length in bytes.

 

SOAP Envelope / Body

The request message is wrapped in a SOAP envelope and body using the following XML structure:

Image  

is the XML element corresponding to the requested method.


Method Response Format

The method XML element corresponds to a MPPE API method. The method element is nested in the <soap:Body> element, and includes element(s) for each of the output parameter(s) given by the method. Response message(s) for MPPE API methods use the following XML structure.

Image  
<MethodNameResponse> is the name of MPPE API Response method.

The XML tag used to deliver the method response includes Response name in the tag name.  For Example, when GetCountries is used in the request message, GetCountriesResponse is used in the response message.
Additionally, response message include the result XML tag, which in turn includes the response parameter elements. The name of the result tag is the operation name followed by Result. For example, the GetContriesResult tag contains the response parameter for the GetCountries operation. Output values for each parameter are nested in the XML tag corresponding to parameter name.


Sample Message

Image  

 

 

API END POINTS

 
OPERATION TYPES OF WSMppeAPI

 

url -> client_website/Modules/MLM/WebServices/MPPE/MPPEWebServices/WSMppeAPI.asmx

 

AddCustomer

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
accountNumberYesStringCustomer account number
customerTypeOptionalIntegerCustomer type in integer format
APIStatusOptionalStringCustomer's API Status
sponsorIdYesGuidCustomer's Sponsor Guid
firstNameYesStringCustomer's First Name
lastNameYesStringCustomer's Last Name
SSNTaxNumberOptionalStringCustomer's SSN Tax Number
BusinessTaxIDOptionalStringCustomer's Business Tax Number
userNickNameYesStringCustomer's Nick Name
passwordYesStringCustomer's Password
emailYesStringCustomer's Email
websiteYesStringCustomer's Website
instantMessengerOptionalStringCustomer's Instant Messenger
countryIdYesGuidCustomer's Country ID in Guid
regionIdYesGuidCustomer's Region ID in Guid
postalCodeYesStringCustomer's Postal Code
phoneOptionalStringCustomer's Phone Number
cellOptionalStringCustomer's cell Number
faxOptionalStringCustomer's Fax Number
salutationOptionalStringCustomer's Salutation
middleNameYesStringCustomer's Middle Name
address1YesStringCustomer's Address 1
address2OptionalStringCustomer's Address 2
businessPhoneOptionalStringCustomer's Business Phone Number
homePhoneOptionalStringCustomer's Home Phone
iModeOptionalStringCustomer's IMode
companyOptionalStringCustomer's Company Name
birthdayYesDateCustomer's Birth Date; data format of mm/dd/yyyy
cityYesStringCustomer's City
ShippingAddress1YesStringCustomer's Shipping Address 1
ShippingAddress2OptionalStringCustomer's Shipping Address 2
ShippingCityYesStringCustomer's Shipping City
ShippingCountryIdYesGuidCustomer's Shipping Country ID
ShippingRegionIdYesGuidCustomer's Shipping Region ID
ShippingPostalCodeOptionalStringCustomer's Shipping Postal Code
BillingAddress1YesStringCustomer's Billing Address 1
BillingAddress2OptionalStringCustomer's Billing Address 2
BillingCityYesStringCustomer's Billing City
BillingCountryIdYesGuidCustomer's Billing Country ID
BillingRegionIdYesGuidCustomer's Billing Region ID
BillingPostalCodeOptionalStringCustomer's Billing Postal Code
yahooIdOptionalStringCustomer's Yahoo Id
MsnIdOptionalStringCustomer's MSN ID
ICQIdOptionalStringCustomer's ICQ ID
AIMIdOptionalStringCustomer's AIM ID
SkypeIdOptionalStringCustomer's Skype ID
FaceBookIdOptionalStringCustomer's Facebook ID
TwitterIdOptionalStringCustomer's Tweeter ID
LinkedInIdOptionalStringCustomer's LinkedIn ID
GooglePlusIdOptionalStringCustomer's Google Plus ID
YouTubeIdOptionalStringCustomer's Youtube ID
RSSFeedIdOptionalStringCustomer's RSS Feed ID
AddInBinaryYesBooleanif customer will be added in binary tree: True or False
AddInMatrixYesBooleanif customer will be added in matrix tree: True or False
AddInUnilevelYesBooleanif customer will be added in unilevel tree: True or False
addressNameOptionalStringCustomer's address name
countyOptionalStringCustomer's County

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process
 
AddCustomerWithEWallet

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
accountNumberYesStringCustomer Account Number
customerTypeYesIntegerCustomer Type in Integer format
APIStatusOptionalStringCustomer's API Status
sponsorIdYesGuidCustomer's Sponsor Guid
firstNameYesStringCustomer's First Name
lastNameYesStringCustomer's Last Name
SSNTaxNumberOptionalStringCustomer's SSN Tax Number
BusinessTaxIDOptionalStringCustomer's Business Tax Number
userNickNameYesStringCustomer's Nick Name
passwordYesStringCustomer's Password
emailYesStringCustomer's Email
websiteYesStringCustomer's Website
instantMessengerOptionalStringCustomer's Instant Messenger
countryIdYesGuidCustomer's Country ID in Guid
regionIdYesGuidCustomer's Region ID in Guid
postalCodeYesStringCustomer's Postal Code
phoneOptionalStringCustomer's Phone Number
cellOptionalStringCustomer's cell Number
faxOptionalStringCustomer's Fax Number
salutationOptionalStringCustomer's Salutation
middleNameOptionalStringCustomer's Middle Name
address1YesStringCustomer's Address 1
address2OptionalStringCustomer's Address 2
businessPhoneOptionalStringCustomer's Business Phone Number
homePhoneOptionalStringCustomer's Home Phone
iModeOptionalStringCustomer's IMode
companyOptionalStringCustomer's Company Name
birthdayYesDateCustomer's Birth Date; data format of mm/dd/yyyy
cityYesStringCustomer's City
ShippingAddress1OptionalStringCustomer's Shipping Address 1
ShippingAddress2OptionalStringCustomer's Shipping Address 2
ShippingCityOptionalStringCustomer's Shipping City
ShippingCountryIdYesGuidCustomer's Shipping Country ID
ShippingRegionIdYesGuidCustomer's Shipping Region ID
ShippingPostalCodeOptionalStringCustomer's Shipping Postal Code
BillingAddress1OptionalStringCustomer's Billing Address 1
BillingAddress2OptionalStringCustomer's Billing Address 2
BillingCityOptionalStringCustomer's Billing City
BillingCountryIdYesGuidCustomer's Billing Country ID
BillingRegionIdYesGuidCustomer's Billing Region ID
BillingPostalCodeOptionalStringCustomer's Billing Postal Code
yahooIdOptionalStringCustomer's Yahoo Id
MsnIdOptionalStringCustomer's MSN ID
ICQIdOptionalStringCustomer's ICQ ID
AIMIdOptionalStringCustomer's AIM ID
SkypeIdOptionalStringCustomer's Skype ID
FaceBookIdOptionalStringCustomer's Facebook ID
TwitterIdOptionalStringCustomer's Tweeter ID
LinkedInIdOptionalStringCustomer's LinkedIn ID
GooglePlusIdOptionalStringCustomer's Google Plus ID
YouTubeIdOptionalStringCustomer's Youtube ID
RSSFeedIdOptionalStringCustomer's RSS Feed ID
AddInBinaryYesBooleanif customer will be added in binary tree:True or False
AddInMatrixYesBooleanif customer will be added in matrix tree: True or False
AddInUnilevelYesBooleanif customer will be added in unilevel tree: True or False
addressNameOptionalStringCustomer's Address Name
countyOptionalStringCustomer's County
eWalletFourDigitPINYesStringCustomer’s four(4) digit PIN code
eWalletSecretQuestionForPINYesStringCustomer’s secret question for the PIN
eWalletSecretAnswerForPINYesStringCustomer’s secret answer for the PIN

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

AddDistributor

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
accountNumberYesStringDistributor's Account Number
sponsorIdYesGuidDistributor's Sponsor Guid
firstNameYesStringDistributor's First Name
lastNameYesStringDistributor's Last Name
SSNTaxNumberYesStringDistributor's SSN Tax Number
SSNTaxOptionOptionalStringSSN Tax Option Code
BusinessTaxIDOptionalStringDistributor's Business Tax Number
userNickNameYesStringDistributor's Nick Name
passwordYesStringDistributor's Password
emailYesStringDistributor's Email
websiteYesStringDistributor's Website
instantMessengerOptionalStringDistributor's Instant Messenger
countryIdYesGuidDistributor's Country ID in Guid
regionIdYesGuidDistributor's Region ID in Guid
postalCodeOptionalStringDistributor's Postal Code
phoneOptionalStringDistributor's Phone Number
cellOptionalStringDistributor's cell Number
faxOptionalStringDistributor's Fax Number
salutationOptionalStringDistributor's Salutation
middleNameOptionalStringDistributor's Middle Name
address1YesStringDistributor's Address 1
address2OptionalStringDistributor's Address 2
businessPhoneOptionalStringDistributor's Business Phone Number
homePhoneOptionalStringDistributor's Home Phone
iModeOptionalStringDistributor's IMode
companyOptionalStringDistributor's Company Name
birthdayYesDateDistributor's Birth Date; data format of mm/dd/yyyy
cityYesStringDistributor's City
ShippingAddress1YesStringDistributor's Shipping Address 1
ShippingAddress2OptionalStringDistributor's Shipping Address 2
ShippingCityYesStringDistributor's Shipping City
ShippingCountryIdYesGuidDistributor's Shipping Country ID
ShippingRegionIdYesGuidDistributor's Shipping Region ID
ShippingPostalCodeOptionalStringDistributor's Shipping Postal Code
BillingAddress1YesStringDistributor's Billing Address 1
BillingAddress2OptionalStringDistributor's Billing Address 2
BillingCityYesStringDistributor's Billing City
BillingCountryIdYesGuidDistributor's Billing Country ID
BillingRegionIdYesGuidDistributor's Billing Region ID
BillingPostalCodeOptionalStringDistributor's Billing Postal Code
yahooIdOptionalStringDistributor's Yahoo Id
MsnIdOptionalStringDistributor's MSN ID
ICQIdOptionalStringDistributor's ICQ ID
AIMIdOptionalStringDistributor's AIM ID
SkypeIdOptionalStringDistributor's Skype ID
FaceBookIdOptionalStringDistributor's Facebook ID
TwitterIdOptionalStringDistributor's Tweeter ID
LinkedInIdOptionalStringDistributor's LinkedIn ID
GooglePlusIdOptionalStringDistributor's Google Plus ID
YouTubeIdOptionalStringDistributor's Youtube ID
RSSFeedIdOptionalStringDistributor's RSS Feed ID
AddInBinaryYesBooleanif Distributor will be added in binary tree: True or False
AddInMatrixYesBooleanif Distributor will be added in matrix tree: True or False
AddInUnilevelYesBooleanif Distributor will be added in unilevel tree: True or False
addressNameOptionalStringDistributor's Address Name
countyOptionalStringDistributor's County
SSNTaxOptionOptionalStringSSN Tax Option Code
CommissionPaymentMethodIdYesIntegerDistributor's Commission Method ID
UserSiteNameOptionalStringDistributor Site name
freeMemberStatusYesBooleanEither 1 or 0, indicate if free member or not
freeMemberReasonOptionalStringReason for being free member
freeMemberNameOptionalStringFree Member Name
freeMemberDateYesDateFree Membership Date; data format of mm/dd/yyyy
roleIdYesIntegerInteger value representing Role Id
binaryPrefferSideYesIntegerProvide value of this when you set true to Add in Binary
matrixPrefferSideYesIntegerProvide value of this when you set true to Add in Matrix
spillingDirectionsYesIntegerProvide value of this when you set true to Add in Unilevel

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process
OutputGuidGuid of the new Distributor

 

AddDistributorWithEWallet

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
userIdYesGuidUser Id in Guid
numberYesStringItem Number
subTotalYesDecimalOrder Sub-Total
shippingTotalYesDecimalOrder's Shipping Total
handlingFeeYesDecimalOrder's Handling Fee
taxTotalYesDecimalOrder's Total Tax
totalYesDecimalOrder's Total
paidSumYesDecimalOrder's Paid Amount
discountSumYesDecimalOrder's Discount Amount
pAndHTotalYesDecimalOrder's Package and Handling Fee
giftCertificateSumYesDecimalGift Certificate Total Used
reedemPayedSumYesDecimalTotal Redeem Amount
OrderNotesYesStringOrder's Notes
matIncomeCenterIdYesIntegerMatrix Income Center Id
salesTaxTransactionIdYesDecimalTransaction Id for Tax
realTimeTaxIntegrationYesBooleanif order used is real time integration, value either 1 or 0
totalWeightofOrderItemsYesDoubleTotal Weight of Order's Items
originationYesStringWhere the package originate
dropShippingFeeYesDecimalAmount to be drop on shipping fee

Response Values

ParameterData TypeDescription
RowcountStringReturns number of rows affected
 
AddOrder

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
userIdYesGuidUser Id in Guid
numberYesStringItem Number
subTotalYesDecimalOrder Sub-Total
shippingTotalYesDecimalOrder's Shipping Total
handlingFeeYesDecimalOrder's Handling Fee
taxTotalYesDecimalOrder's Total Tax
totalYesDecimalOrder's Total
paidSumYesDecimalOrder's Paid Amount
discountSumYesDecimalOrder's Discount Amount
pAndHTotalYesDecimalOrder's Package and Handling Fee
giftCertificateSumYesDecimalGift Certificate Total Used
reedemPayedSumYesDecimalTotal Redeem Amount
OrderNotesYesStringOrder's Notes
matIncomeCenterIdYesIntegerMatrix Income Center Id
salesTaxTransactionIdYesDecimalTransaction Id for Tax
realTimeTaxIntegrationYesBooleanif order used is real time integration, value either 1 or 0
totalWeightofOrderItemsYesDoubleTotal Weight of Order's Items
originationYesStringWhere the package originate
dropShippingFeeYesDecimalAmount to be drop on shipping fee

Response Values

ParameterData TypeDescription
AddOrderResultStringReturns the order number

 

AddOrderPayment

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
OrderIdYesIntegerOrder ID
OrderDateYesDatePayment Date
TotalYesDecimalTotal Payment Amount
UserIdYesGuidUser ID in Guid

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

AddOrderSKU

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
orderIdYesIntegerOrder ID
sKUIdYesGuidSKU ID
quantityYesIntegerQuantity
freeQuantiyYesIntegerNumber of Items for Free
remainsYesIntegerQuantity Remains
freeItemYesBooleanif SKU is free item, value either 1 or 0
priceYesDecimalPrice of SKU
discountSumYesDecimalDiscount of SKU
wholesalePriceYesDecimalWholesale Price of SKU
binComValueYesDecimalBinary Commission Value for SKU
matComValueYesDecimalMatrix Commission Value for SKU
uniComValueYesDecimalUnilevel Commission Value for SKU
binPointsEarnedYesDecimalBinary Points Earned for SKU
matPointsEarnedYesDecimalMatrix Points Earned for SKU
uniPointsEarnedYesDecimalUnilevel Points Earned for SKU
ABPYesDecimalAffilate Base Price

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

AddOrderWithDate

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
userIdYesGuidUser Id in Guid
numberYesStringItem Number
subTotalYesDecimalOrder Sub-Total
shippingTotalYesDecimalOrder's Shipping Total
handlingFeeYesDecimalOrder's Handling Fee
taxTotalYesDecimalOrder's Total Tax
totalYesDecimalOrder's Total
paidSumYesDecimalOrder's Paid Amount
discountSumYesDecimalOrder's Discount Amount
pAndHTotalYesDecimalOrder's Package and Handling Fee
giftCertificateSumYesDecimalGift Certificate Total Used
reedemPayedSumYesDecimalTotal Redeem Amount
OrderNotesYesStringOrder's Notes
OrderDateYesDateOrder Date; data format of yyyy-mm-dd
 
matIncomeCenterIdYesIntegerMatrix Income Center Id
salesTaxTransactionIdYesDecimalTransaction Id for Tax
realTimeTaxIntegrationYesBooleanif order used is real time integration, value either 1 or 0
totalWeightofOrderItemsYesDoubleTotal Weight of Order's Items
originationYesStringWhere the package originate
dropShippingFeeYesDecimalAmount to be drop on shipping fee

Response Values

ParameterData TypeDescription
AddOrderResultStringReturns the order number

 

CheckReplicatedSiteName

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
SiteNameYesStringUser’s site name

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringReturn a message if exist or not exist

 

DeleteUser

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
UserIdYesGuidUser Id in Guid
userTypeYesStringUser type

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

GetAdditionInfoforDistributorByCommonId

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
CommonIdYesLongUser’s common Id

Response Values

ParameterData TypeDescription
IsDeletedBooleanIndicator if distributor is deleted: True or False
CommonIdLongDistributor’s Common Id
SponsorIdGuidDistributor’s Sponsor Id
PrefferSideBinaryStringIf the distributor is in Binary
PrefferSideMatrixStringIf the distributor is in Matrix
MessageStringDistributor’s status: active or deleted

 

GetAdditionInfoforDistributorByGUID

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
UserGuidYesGuidDistributor’s Guid Id

Response Values

ParameterData TypeDescription
IsDeletedBooleanIndicator if distributor is deleted: True or False
CommonIdLongDistributor’s Common Id
SponsorIdGuidDistributor’s Sponsor Id
PrefferSideBinaryStringIf the distributor is in Binary
PrefferSideMatrixStringIf the distributor is in Matrix
MessageStringDistributor’s status: active or deleted

 

GetBillingAddress

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
userIdYesGuidUser Id in Guid

Response Values

ParameterData TypeDescription
IsBillingAddressBooleanIf this is Billing Address: True or False
ItemIdIntegerReference Item Id
CountyStringCounty Name
UserIdGuidUser’s Guid Id
FirstNameStringUser’s First Name
LastNameStringUser’s Last Name
PhoneNumberStringUser’s Phone Number
FaxNumberStringUser’s Fax Number
CompanyStringUser’s Company Name
Address1StringUser’s Address 1
Address2StringUser’s Address 2
AddressNameStringUser’s Address Name
CityStringUser’s City
CountryIdGuidUser’s Country Id in Guid
RegionIdGuidUser’s Region Id in Guid
Postal CodeStringUser's Postal Code
IsPrimaryBooleanIf this is Primary Billing Address: True or False
AddressNameStringUser's Address Name
CountryTextStringUser's Country Name
RegionTextStringUser’s Region Name
RowNumIntegerRecord Row Number
TotalRowsIntegerTotal No. of Addresses
ActualAddressNameStringUser's  Actual Address Name
IsPhoneVisibleBooleanIf Phone Info is Visible: True or False
IsFaxVisibleBooleanIf Fax Information is Visible: True or False
IsCompanyVisibleBooleanIf Company Information is Visible: True or False

 

GetBinarySideList

Description:

Request Parameters

ParameterRequiredData TypeDescription
InvokeN/AN/AInvoke Button

Response Values

ParameterData TypeDescription
Key xsiIntegerKey integer reference
Value xsiStringString value of the key integer
 
GetCommissionPaymentMethods

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashkeyYesGuidSite Guid

Response Values

ParameterData TypeDescription
ItemIdIntegerId reference if the Item
NameStringCommission Payment Method Name
PaymentTypeStringPercentage or DollarAmount or NoCharge
PercentageCommissionDecimalCommission Payment Method’s percentage calculation
DollarAmountDecimalCommission Payment Method’s Dollar Amount
ActiveBooleanIf the Commission Payment is active: True or False
DefaultBooleanIf the Commission Payment is in Default: True or False
DescriptionStringCommission Payment Method’s description
CommissionDescriptionCurrencyStringCommission Payment Method’s currency
MinimumCommissionAmountDecimalMinimum Commission Payment Method’s amount
RowNumIntegerRecord Row Number
TotalRowsIntegerTotal number of Commission Payment

 

GetCountries

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashkeyYesGuidSite Guid

Response Values

ParameterData TypeDescription
IsBeneficaryBooleanIf Countries is Beneficary: True or False
ExcludeRegionForViewBooleanIf Region is Excluded to View: True or False
ExlcludeRegionForRegistrationBooleanIf Region for Registration is Excluded: True or False
ItemIdGuidGuid reference Id of a country
NameStringCountry Name
CodeStringCountry Code
ISOCodeStringCountry ISO Code
RowNumIntegerRecord Row Number
CountryCode3StringCommission Payment Method’s currency
MinimumCommissionAmountDecimalMinimum Commission Payment Method’s amount
RowNumIntegerRecord Row Number
CountryCode3StringCountry Code
TotalRowsIntegerTotal Number of Countries
IsEnableBooleanIs country is Enable, value either true or False
AreaCodeIntegerCountry Area Code
PhoneCodeIntegerCountry's Phone Code
PriorityIntegerPriority number of a country

 

GetCustomerInfoByID

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashkeyYesGuidSite Guid
CommonIDYesIntegerCustomer Common ID

Response Values

ParameterData TypeDescription
IsMobileBooleanIs customer uses mobile version of the site, Value either true or false
CommonIDIntegerCustomer Common Id
SiteNameStringCustomer Site Name
SponsorGuidGuidSponsor ID in Guid
WebSiteStringCustomer Website
ActiveByPlacedOrderBooleanIs customer Active by Placement order, Value either true or false

 

GetOrderSKU

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashkeyYesGuidSite Guid

Response Values

ParameterData TypeDescription
UpgradeSKURankIntegerUpgrade SKU Rank
MinimumOrderQuantityIntegerMinimum Order Quantity
MaximumOrderQuantityIntegerSKU's Maximum Order Quantity
MustBeBinaryActivatedBooleanIf SKU must Be Binary Activated: True or False
OrderSettingNumberStringOrder Setting Number
HealthBuilderActivationPack1BooleanIf Health Builder Activation Pack2: True or False
HealthBuilderActivationPack2BooleanIf Health Builder Activation Pack2: True or False
HealthBuilderActivationUpgradeBooleanIf Health Builder Activation Upgrade: True or False
DistributorSuccessKitBooleanIf Distributor Success Kit: True or False
TrainingFeeBooleanSKU Training Fee: True or False
BackOfficeFeeProductBooleanIf BackOffice Fee Product: True or False
RepurchaseProductBooleanIf SKU is Repurchase Product: True or False
IsCommissionableBooleanIf Commissionable on SKU: True or False
ItemIdGuidSKU Item ID
ProductIdGuidProduct Id
TextOnReceiptPageStringSKU's Text On Receipt Page
ShowOnReceiptPageBooleanIf SKU is Shown on Receipt Page: True or False
SKUStringSingle Keeping Unit
NameStringSKU Name
SKUFullNameStringFull SKU Name
VisibleBooleanshow SKU: True or False
IsSeasonalBooleanIf SKU is Seasonal: True or False
AddDateDateDate when sku added
AllowedOnlyForMotivationRulesBooleanIf Allowed Only For Motivation Rules: True or False
ProductTypeIdStringSKU’s product Type Id
IsBinaryActivatedBooleanIf Binary Activated on SKU: True or False
IsDisplayInActivationRuleBooleanIf Display In Activation Rule: True or False
RowNumIntegerRow number of SKU
TotalRowsIntegerTotal number of SKUs
SalePriceDecimalSKU’s sale price
SRPriceDecimalSKU’s Suggested Retail Price
WholeSalePriceDecimalSKU’s Wholesale Price
PreferredPriceDecimalSKU’s Preferred Price
CountryIdGuidCountry ID
IsAddToCartBooleanIf will be added to Cart: True or False
IsAddToWishListBooleanIf will be Added to Wish List: True or False
IsAutoShipBooleanIf SKU was on Autoship: True or False: True or False
SelfLifeIntegerSKU self-Life
IsDisplayInUpgradeModuleBooleanIf Display In Upgrade Module, Value either true or false
BCVDecimalBCV
UCVDecimalUCV
MCVDecimalMCV
IsNoShippingInvolvedBooleanIf No Shipping Involved on SKU, Value either true or false
PriceDecimalPrice
skuMDCategoryIdGuidSKU’s MD Category Id
ShowSKUToUserByRoleIntegerShow SKU To User By Role
DoNotAllowItemQtyChangeBooleanIf Do Not Allow Item Quantity Change on SKU: True or False
IsAutoshipAvailableBooleanIf Autoship Available on SKU: True or False
IsAvailableForAssociatedSkuBooleanIf Available For Associated Sku on SKU: True or False
HasAssociatedSKUBooleanIf Has Associated SKU: True or False
TurnOffAutoShipConfigurationBooleanTo turn off or on the Autoship configuration: True or False
IsForceAutoshipBooleanIf Force Autoship on SKU: True or False
BuyNowPathStringBuy Now Path
IsCarboniteServiceBooleanIf Carbonite Service on SKU: True or False
RegCodeStringRegistration Code
IsLegtricityBooleanIf Legtricity is on SKU: True or False
ContactedMembershipIdIntegerContacted Membership Id
IsMobileBooleanIf Mobile is on SKU: True or False
SinglePagePurchaseBooleanSet SKU on Single Page Purchase: True or False
IsProductFinanceAvailableBooleanIf Product Finance Available on SKU: True or False
IsAutoshipItemEditBooleanIf Autoship Item was edited on SKU: True or False
IsAutoshipItemDeleteBooleanIf Autoship Item was Deleted on SKU: True or False
IsMyBuilderBooleanIf SKU is my Builder: True or False
DurationIntegerSKU’s duration
DurationTypeStringSKU’s duration Type
CurrentRemainsLongSKU’s current remains
MaximumOrderQuantityTextboxLongMaximum quantity of the SKU’s order
CurrentPendingLongCurrent Pending SKU
EarnableCreditIntegerEarnable Credit on SKU
IsEarnableBooleanIf Earnable on SKU: True or False
IsNonTaxableBooleanIf SKU is non-taxable: True or False
ExculdeFromDistributorViewBooleanIf SKU is Excluded From Distributor View: True or False
IsFlagshipBooleanIf SKU have Flagship: True or False
IsTrialperiodBooleanIf SKU is on trial period: True or False
IsAllowOnlyOneSkuBooleanIf Allow Only One SKU: True or False
TrackingCreditsIntegerSKU’s Tracking Credits
CurrentRemainsFromWareHouseIntegerCurrent SKU Remaining from warehouse
CurrentRemainsToWareHouseIntegerCurrent SKU Remaining to warehouse
IsDisplayMultiTieredFSBBooleanIf Display Multi-Tiered FSB on SKU: True or False
OrderDateDateSKU’s order date
TaxablePercentageDecimalSKU’s Taxable percentage value
IsJumpStartBonusBooleanIf SKU have jump start bonus
IsDiscountableBooleanIf SKU can have discounts
ShoppingDiscountTypeStringShopping discount type name
ShoppingDiscountPercentageDecimalShopping discount percentage value
PriceAfterShoppingDiscountDecimalPrice after shopping discount value
ReduceCVBySameDiscPercentBooleanReduce CV by same discount percentage value
UCVAfterDiscountDecimalUCV after discount value
BCVAfterDiscountDecimalBCV after discount value
MCVAfterDiscountDecimalMCV after discount value
ReducePVBySameDiscPercentBooleanReduce PV by same discount percentage value
TaxCodeStringTax code value
IsMultiPackageBooleanIf SKU is a multi-package: True or False
IsCABSubscriptionSKUBooleanIf SKU is a CAB Subscription: True or False
EnableMaxPurchasesBooleanIf SKU will enable max purchases: True or False
MaxPurchasesLongMax purchases value
EnableHideAfterEnrollmentBooleanIf enable hide after enrolment: True or False
HideAfterEnrollmentFrequencyValueIntegerHide after enrolment frequency value
HideAfterEnrollmentFrequencyTypeIntegerHide after enrolment frequency type name
EnableMaxProductPurchasesBooleanIf enable max product purchases on SKU: True or False
ProductEnableHideAfterEnrollmentBooleanIf product enable hide after enrolment: True or False
chkIsEnableBooleanIf Order SKU item is enable: True or False
btnAddtoCartIsVisibleBooleanIf the add to cart button is visible: True or False
IsPointsAccumulationBonusSKUBooleanIf SKU have point(s) accumulation bonus: True or False
IsProPayBooleanIf SKU is a pro pay: True or False
CarBonusBooleanIf SKU have car bonus: True or False
IsRenewalBooleanIf SKU have renewal: True or False
RenewalDurationIntegerRenewal duration value
RenewalDurationTypeStringRenewal duration type name
WaiveSKUPriceValidationBooleanWaive a SKU price validation: True or False
EnableTTBooleanIf enable TT on SKU
TTDurationIntegerTT duration value
TTDurationTypeStringTT duration type name
DescriptionStringSKU’s description
IsUnAvailableForUnilevelBooleanIf SKU is available for Unilevel: True or False
IsUnAvailableForBinaryBooleanIf SKU is available for Binary: True or False
IsUnAvailableForMatrixBooleanIf SKU is available for Matrix: True or False
IsCoinBooleanIf SKU have coin: True or False
IsSellableBooleanIf SKU is sellable: True or False
CoinValueDecimalCoin value
CoinAccrualStartIntegerCoin accrual start value
CoinAccrualEndIntegerCoin accrual end value
DailyAccrualCoinValueDecimalDaily accrual coin value

 

GetRegions

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashkeyYesGuidSite Guid
countryInfoItemIdYesGuidCountry Guid ID

Response Values

ParameterData TypeDescription
ItemIdGuidRegion's Item Id
CountryIdGuidRegion's Country ID in Guid
NameStringRegion Name
CodeStringRegion Code

 

GetSKUIDBySKU

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashkeyYesGuidSite Guid
SKUYesStringSKU

Response Values

ParameterData TypeDescription
SKU IDStringSKU ID

 

GetShippingAddress

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
userIdYesGuidUser ID in Guid format

Response Values

ParameterData TypeDescription
IsAutoShipAddressBooleanIf shipping address is autoship address: True or False
ItemIdIntegerReference item Id
CountyStringCounty
UserIdGuidUser’s Guid Id
FirstNameStringUser’s First Name
LastNameStringUser’s Last Name
PhoneNumberStringUser’s Phone Number
FaxNumberStringUser’s Fax Number
CompanyStringUser’s Company Name
Address1StringUser’s Address 1
Address2StringUser’s Address 2
AddressNameStringUser’s Address Name
CityStringUser’s City
CountryIdGuidUser’s Country Id in Guid
RegionIdGuidUser’s Region Id in Guid
RegionNameStringRegion name
Postal CodeStringUser's Postal Code
IsPrimaryBooleanIf this is Primary Billing Address: True or False
ActualAddressNameStringActual address name
CountryNameStringCountry name
AddressNameStringAddress name
CountryTextStringCountry text
RegionTextStringUser’s Region Name
RowNumIntegerRecord Row Number
TotalRowsIntegerTotal No. of Addresses
FullAddressStringFull address
IsDistributorAddressBooleanIf shipping address is a distributor address: True or False
IsPhoneVisibleBooleanIf Phone Info is Visible: True or False
IsFaxVisibleBooleanIf Fax Information is Visible: True or False
IsCompanyVisibleBooleanIf Company Information is Visible: True or False

 

GetSiteReplicationInfo

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashkeyYesGuidSite Guid
replicatedSiteNameYesGuidRelicated Site Name

Response Values

ParameterData TypeDescription
IsMobileBooleanIf Site is Mobile, value either true or false
CommonIDIntegerCommon ID
SiteNameStringSite Name
SponsorGuidGuidSpronsor Guid
WebSiteStringWebSite
ActiveByPlacedOrderBooleanIf site is active by placed order: True or False

 

GetSiteReplicationInfoByGUID

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashkeyYesGuidSite Guid
UserGuidYesGuidUser Guid

Response Values

ParameterData TypeDescription
IsMobileBooleanIf Site is Mobile, value either true or false
CommonIDIntegerCommon ID
SiteNameStringSite Name
SponsorGuidGuidSpronsor Guid
WebSiteStringWebSite
ActiveByPlacedOrderBooleanIf site is active by placed order: True or False

 

GetSiteReplicationInfoByID

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashkeyYesGuidSite Guid
replicatedCommonIDYesIntegerCommon Id of the user

Response Values

ParameterData TypeDescription
IsMobileBooleanIf Site is Mobile, value either true or false
CommonIDIntegerCommon ID
SiteNameStringSite Name
SponsorGuidGuidSpronsor Guid
WebSiteStringWebSite
ActiveByPlacedOrderBooleanIf site is active by placed order: True or False

 

GetThreeAndFreeTrackingDetails

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashkeyYesGuidSite Guid
commonIDYesIntegerCommon Id

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process
UserStatusStringUser Status: Active or Deleted
ThisMonthFreeAutoShipOrFreeOrderAvailableBooleanIf free autohip or free order is available this month: True or False
LastMonthQualifiedSalesIntegerCount of qualified sales last month
ThisMonthFreeAutoShiporFreeOrderUsedBooleanIf free autoshop or free order used this month: True or False
NextMonthFreeAutoShipOrFreeOrderAvailableBooleanIf free autoshop or free order available next month: True or False
ThisMonthQualifiedSalesIntegerCount of qualified sales this month
ThisMonthPendingAutoShipsCountIntegerCount of pending autoships this month

 

GetUserIDByAccountNumber

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashkeyYesGuidSite Guid
AccountNumberYesStringUser’s account number

Response Values

ParameterData TypeDescription
UserIDStringUser ID

 

NewAddCustomer

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
accountNumberYesStringDistributor’s Account Number
customerTypeOptionalIntegerCustomer Type in Integer format
APIStatusOptionalStringCustomer's API Status
sponsorIdYesGuidDistributor’s Sponsor Guid
firstNameYesStringCustomer's First Name
lastNameYesStringCustomer's Last Name
SSNTaxNumberOptionalStringCustomer's SSN Tax Number
BusinessTaxIDOptionalStringCustomer's Business Tax Number
userNickNameYesStringCustomer's Nick Name
passwordYesStringCustomer's Password
emailYesStringCustomer's Email
websiteYesStringCustomer's Website
instantMessengerOptionalStringCustomer's Instant Messenger
countryIdYesGuidCustomer's Country ID in Guid
regionIdYesGuidCustomer's Region ID in Guid
postalCodeYesStringCustomer's Postal Code
phoneOptionalStringCustomer's Phone Number
cellOptionalStringCustomer's cell Number
faxOptionalStringCustomer's Fax Number
salutationOptionalStringCustomer's Salutation
middleNameOptionalStringCustomer's Middle Name
address1YesStringCustomer's Address 1
address2OptionalStringCustomer's Address 2
businessPhoneOptionalStringCustomer's Business Phone Number
homePhoneOptionalStringCustomer's Home Phone
iModeOptionalStringCustomer's IMode
companyOptionalStringCustomer's Company Name
birthdayYesDateCustomer's Birth Date; data format of mm/dd/yyyy
cityYesStringCustomer's City
ShippingAddress1OptionalStringCustomer's Shipping Address 1
ShippingAddress2OptionalStringCustomer's Shipping Address 2
ShippingCityYesStringCustomer's Shipping City
ShippingCountryIdYesGuidCustomer's Shipping Country ID
ShippingRegionIdYesGuidCustomer's Shipping Region ID
ShippingPostalCodeOptionalStringCustomer's Shipping Postal Code
BillingAddress1OptionalStringCustomer's Billing Address 1
BillingAddress2OptionalStringCustomer's Billing Address 2
BillingCityYesStringCustomer's Billing City
BillingCountryIdYesGuidCustomer's Billing Country ID
BillingRegionIdYesGuidCustomer's Billing Region ID
BillingPostalCodeOptionalStringCustomer's Billing Postal Code
yahooIdOptionalStringCustomer's Yahoo Id
MsnIdOptionalStringCustomer's MSN ID
ICQIdOptionalStringCustomer's ICQ ID
AIMIdOptionalStringCustomer's AIM ID
SkypeIdOptionalStringCustomer's Skype ID
FaceBookIdOptionalStringCustomer's Facebook ID
TwitterIdOptionalStringCustomer's Tweeter ID
LinkedInIdOptionalStringCustomer's LinkedIn ID
GooglePlusIdOptionalStringCustomer's Google Plus ID
YouTubeIdOptionalStringCustomer's Youtube ID
RSSFeedIdOptionalStringCustomer's RSS Feed ID
PinterestIdOptionalStringCustomer’s Pinteres ID
InstagramIdOptionalStringCustomer’s Instagram ID
AddInBinaryYesBooleanif customer will be added in binary tree: True or False
AddInMatrixYesBooleanif customer will be added in matrix tree: True or False
AddInUnilevelYesBooleanif customer will be added in unilevel tree: True or False
addressNameOptionalStringCustomer's Address Name
countyOptionalStringCustomer's County

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

NewAddCustomerWithEWallet

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
accountNumberYesStringDistributor’s Account Number
customerTypeOptionalIntegerCustomer Type in Integer format
APIStatusOptionalStringCustomer's API Status
sponsorIdYesGuidDistributor’s Sponsor Guid
firstNameYesStringCustomer's First Name
lastNameYesStringCustomer's Last Name
SSNTaxNumberOptionalStringCustomer's SSN Tax Number
BusinessTaxIDOptionalStringCustomer's Business Tax Number
userNickNameYesStringCustomer's Nick Name
passwordYesStringCustomer's Password
emailYesStringCustomer's Email
websiteYesStringCustomer's Website
instantMessengerOptionalStringCustomer's Instant Messenger
countryIdYesGuidCustomer's Country ID in Guid
regionIdYesGuidCustomer's Region ID in Guid
postalCodeYesStringCustomer's Postal Code
phoneOptionalStringCustomer's Phone Number
cellOptionalStringCustomer's cell Number
faxOptionalStringCustomer's Fax Number
salutationOptionalStringCustomer's Salutation
middleNameOptionalStringCustomer's Middle Name
address1YesStringCustomer's Address 1
address2OptionalStringCustomer's Address 2
businessPhoneOptionalStringCustomer's Business Phone Number
homePhoneOptionalStringCustomer's Home Phone
iModeOptionalStringCustomer's IMode
companyOptionalStringCustomer's Company Name
birthdayYesDateCustomer's Birth Date; data format of mm/dd/yyyy
cityYesStringCustomer's City
ShippingAddress1OptionalStringCustomer's Shipping Address 1
ShippingAddress2OptionalStringCustomer's Shipping Address 2
ShippingCityYesStringCustomer's Shipping City
ShippingCountryIdYesGuidCustomer's Shipping Country ID
ShippingRegionIdYesGuidCustomer's Shipping Region ID
ShippingPostalCodeOptionalStringCustomer's Shipping Postal Code
BillingAddress1OptionalStringCustomer's Billing Address 1
BillingAddress2OptionalStringCustomer's Billing Address 2
BillingCityYesStringCustomer's Billing City
BillingCountryIdYesGuidCustomer's Billing Country ID
BillingRegionIdYesGuidCustomer's Billing Region ID
BillingPostalCodeOptionalStringCustomer's Billing Postal Code
yahooIdOptionalStringCustomer's Yahoo Id
MsnIdOptionalStringCustomer's MSN ID
ICQIdOptionalStringCustomer's ICQ ID
AIMIdOptionalStringCustomer's AIM ID
SkypeIdOptionalStringCustomer's Skype ID
FaceBookIdOptionalStringCustomer's Facebook ID
TwitterIdOptionalStringCustomer's Tweeter ID
LinkedInIdOptionalStringCustomer's LinkedIn ID
GooglePlusIdOptionalStringCustomer's Google Plus ID
YouTubeIdOptionalStringCustomer's Youtube ID
RSSFeedIdOptionalStringCustomer's RSS Feed ID
PinterestIdOptionalStringCustomer’s Pinteres ID
InstagramIdOptionalStringCustomer’s Instagram ID
AddInBinaryYesBooleanif customer will be added in binary tree: True or False
AddInMatrixYesBooleanif customer will be added in matrix tree: True or False
AddInUnilevelYesBooleanif customer will be added in unilevel tree: True or False
addressNameOptionalStringCustomer's Address Name
countyOptionalStringCustomer's County
eWalletFourDigitPINYesStringCustomer’s four(4) digit PIN code
eWalletSecretQuestionForPINYesStringCustomer’s secret question for the PIN
eWalletSecretAnswerForPINYesStringCustomer’s secret answer for the PIN

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

NewAddDistributor

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
accountNumberYesStringDistributor’s Account Number
sponsorIdYesGuidDistributor’s Sponsor Guid
firstNameYesStringCustomer's First Name
lastNameYesStringCustomer's Last Name
SSNTaxNumberOptionalStringCustomer's SSN Tax Number
BusinessTaxIDOptionalStringCustomer's Business Tax Number
userNickNameYesStringCustomer's Nick Name
passwordYesStringCustomer's Password
emailYesStringCustomer's Email
websiteYesStringCustomer's Website
instantMessengerOptionalStringCustomer's Instant Messenger
countryIdYesGuidCustomer's Country ID in Guid
regionIdYesGuidCustomer's Region ID in Guid
postalCodeYesStringCustomer's Postal Code
phoneOptionalStringCustomer's Phone Number
cellOptionalStringCustomer's cell Number
faxOptionalStringCustomer's Fax Number
salutationOptionalStringCustomer's Salutation
middleNameOptionalStringCustomer's Middle Name
address1YesStringCustomer's Address 1
address2OptionalStringCustomer's Address 2
businessPhoneOptionalStringCustomer's Business Phone Number
homePhoneOptionalStringCustomer's Home Phone
iModeOptionalStringCustomer's IMode
companyOptionalStringCustomer's Company Name
birthdayYesDateCustomer's Birth Date; data format of mm/dd/yyyy
cityYesStringCustomer's City
ShippingAddress1OptionalStringCustomer's Shipping Address 1
ShippingAddress2OptionalStringCustomer's Shipping Address 2
ShippingCityYesStringCustomer's Shipping City
ShippingCountryIdYesGuidCustomer's Shipping Country ID
ShippingRegionIdYesGuidCustomer's Shipping Region ID
ShippingPostalCodeOptionalStringCustomer's Shipping Postal Code
BillingAddress1OptionalStringCustomer's Billing Address 1
BillingAddress2OptionalStringCustomer's Billing Address 2
BillingCityYesStringCustomer's Billing City
BillingCountryIdYesGuidCustomer's Billing Country ID
BillingRegionIdYesGuidCustomer's Billing Region ID
BillingPostalCodeOptionalStringCustomer's Billing Postal Code
yahooIdOptionalStringCustomer's Yahoo Id
MsnIdOptionalStringCustomer's MSN ID
ICQIdOptionalStringCustomer's ICQ ID
AIMIdOptionalStringCustomer's AIM ID
SkypeIdOptionalStringCustomer's Skype ID
FaceBookIdOptionalStringCustomer's Facebook ID
TwitterIdOptionalStringCustomer's Tweeter ID
LinkedInIdOptionalStringCustomer's LinkedIn ID
GooglePlusIdOptionalStringCustomer's Google Plus ID
YouTubeIdOptionalStringCustomer's Youtube ID
RSSFeedIdOptionalStringCustomer's RSS Feed ID
PinterestIdOptionalStringCustomer’s Pinteres ID
InstagramIdOptionalStringCustomer’s Instagram ID
AddInBinaryYesBooleanif customer will be added in binary tree: True or False
AddInMatrixYesBooleanif customer will be added in matrix tree: True or False
AddInUnilevelYesBooleanif customer will be added in unilevel tree: True or False
addressNameOptionalStringCustomer's Address Name
countyOptionalStringCustomer's County
SSNTaxOptionOptionalStringSSN Tax Option Code
CommissionPaymentMethodIdYesIntegerDistributor's Commission Method ID
UserSiteNameOptionalStringDistributor Site name
freeMemberStatusYesBooleanEither 1 or 0, indicate if free member or not
freeMemberReasonOptionalStringReason for being free member
freeMemberNameOptionalStringFree Member Name
freeMemberDateYesDateFree Membership Date; data format of mm/dd/yyyy
roleIdYesIntegerInteger value representing Role Id
binaryPrefferSideYesIntegerProvide value of this when you set true to Add in Binary
matrixPrefferSideYesIntegerProvide value of this when you set true to Add in Matrix
spillingDirectionsYesIntegerProvide value of this when you set true to Add in Unilevel

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process
OutputGuidGuid of the New Distributor

 

NewAddDistributorWithEWallet

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
accountNumberYesStringDistributor’s Account Number
sponsorIdYesGuidDistributor’s Sponsor Guid
placementIdYesGuidDistributor’s Placement ID
firstNameYesStringCustomer's First Name
lastNameYesStringCustomer's Last Name
SSNTaxNumberOptionalStringCustomer's SSN Tax Number
BusinessTaxIDOptionalStringCustomer's Business Tax Number
userNickNameYesStringCustomer's Nick Name
passwordYesStringCustomer's Password
emailYesStringCustomer's Email
websiteYesStringCustomer's Website
instantMessengerOptionalStringCustomer's Instant Messenger
countryIdYesGuidCustomer's Country ID in Guid
regionIdYesGuidCustomer's Region ID in Guid
postalCodeYesStringCustomer's Postal Code
phoneOptionalStringCustomer's Phone Number
cellOptionalStringCustomer's cell Number
faxOptionalStringCustomer's Fax Number
salutationOptionalStringCustomer's Salutation
middleNameOptionalStringCustomer's Middle Name
address1YesStringCustomer's Address 1
address2OptionalStringCustomer's Address 2
businessPhoneOptionalStringCustomer's Business Phone Number
homePhoneOptionalStringCustomer's Home Phone
iModeOptionalStringCustomer's IMode
companyOptionalStringCustomer's Company Name
birthdayYesDateCustomer's Birth Date; data format of mm/dd/yyyy
cityYesStringCustomer's City
ShippingAddress1OptionalStringCustomer's Shipping Address 1
ShippingAddress2OptionalStringCustomer's Shipping Address 2
ShippingCityYesStringCustomer's Shipping City
ShippingCountryIdYesGuidCustomer's Shipping Country ID
ShippingRegionIdYesGuidCustomer's Shipping Region ID
ShippingPostalCodeOptionalStringCustomer's Shipping Postal Code
BillingAddress1OptionalStringCustomer's Billing Address 1
BillingAddress2OptionalStringCustomer's Billing Address 2
BillingCityYesStringCustomer's Billing City
BillingCountryIdYesGuidCustomer's Billing Country ID
BillingRegionIdYesGuidCustomer's Billing Region ID
BillingPostalCodeOptionalStringCustomer's Billing Postal Code
yahooIdOptionalStringCustomer's Yahoo Id
MsnIdOptionalStringCustomer's MSN ID
ICQIdOptionalStringCustomer's ICQ ID
AIMIdOptionalStringCustomer's AIM ID
SkypeIdOptionalStringCustomer's Skype ID
FaceBookIdOptionalStringCustomer's Facebook ID
TwitterIdOptionalStringCustomer's Tweeter ID
LinkedInIdOptionalStringCustomer's LinkedIn ID
GooglePlusIdOptionalStringCustomer's Google Plus ID
YouTubeIdOptionalStringCustomer's Youtube ID
RSSFeedIdOptionalStringCustomer's RSS Feed ID
PinterestIdOptionalStringCustomer’s Pinteres ID
InstagramIdOptionalStringCustomer’s Instagram ID
AddInBinaryYesBooleanif customer will be added in binary tree: True or False
AddInMatrixYesBooleanif customer will be added in matrix tree: True or False
AddInUnilevelYesBooleanif customer will be added in unilevel tree: True or False
addressNameOptionalStringCustomer's Address Name
countyOptionalStringCustomer's County
SSNTaxOptionOptionalStringSSN Tax Option Code
CommissionPaymentMethodIdYesIntegerDistributor's Commission Method ID
UserSiteNameOptionalStringDistributor Site name
freeMemberStatusYesBooleanEither 1 or 0, indicate if free member or not
freeMemberReasonOptionalStringReason for being free member
freeMemberNameOptionalStringFree Member Name
freeMemberDateYesDateFree Membership Date; data format of mm/dd/yyyy
roleIdYesIntegerInteger value representing Role Id
binaryPrefferSideYesIntegerProvide value of this when you set true to Add in Binary
matrixPrefferSideYesIntegerProvide value of this when you set true to Add in Matrix
spillingDirectionsYesIntegerProvide value of this when you set true to Add in Unilevel
eWalletFourDigitPINYesStringCustomer’s four(4) digit PIN code
eWalletSecretQuestionForPINYesStringCustomer’s secret question for the PIN
eWalletSecretAnswerForPINYesStringCustomer’s secret answer for the PIN

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

NewUpdateCustomer

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
userIdYesGuidDistributor’s User ID
accountNumberYesStringDistributor’s Account Number
sponsorIdYesGuidDistributor’s Sponsor Guid
firstNameYesStringCustomer's First Name
lastNameYesStringCustomer's Last Name
SSNTaxNumberOptionalStringCustomer's SSN Tax Number
BusinessTaxIDOptionalStringCustomer's Business Tax Number
userNickNameYesStringCustomer's Nick Name
passwordYesStringCustomer's Password
emailYesStringCustomer's Email
websiteYesStringCustomer's Website
instantMessengerOptionalStringCustomer's Instant Messenger
countryIdYesGuidCustomer's Country ID in Guid
regionIdYesGuidCustomer's Region ID in Guid
postalCodeYesStringCustomer's Postal Code
phoneOptionalStringCustomer's Phone Number
cellOptionalStringCustomer's cell Number
faxOptionalStringCustomer's Fax Number
salutationOptionalStringCustomer's Salutation
middleNameOptionalStringCustomer's Middle Name
address1YesStringCustomer's Address 1
address2OptionalStringCustomer's Address 2
businessPhoneOptionalStringCustomer's Business Phone Number
homePhoneOptionalStringCustomer's Home Phone
iModeOptionalStringCustomer's IMode
companyOptionalStringCustomer's Company Name
birthdayYesDateCustomer's Birth Date; data format of mm/dd/yyyy
cityYesStringCustomer's City
ShippingAddress1OptionalStringCustomer's Shipping Address 1
ShippingAddress2OptionalStringCustomer's Shipping Address 2
ShippingCityYesStringCustomer's Shipping City
ShippingCountryIdYesGuidCustomer's Shipping Country ID
ShippingRegionIdYesGuidCustomer's Shipping Region ID
ShippingPostalCodeOptionalStringCustomer's Shipping Postal Code
BillingAddress1OptionalStringCustomer's Billing Address 1
BillingAddress2OptionalStringCustomer's Billing Address 2
BillingCityYesStringCustomer's Billing City
BillingCountryIdYesGuidCustomer's Billing Country ID
BillingRegionIdYesGuidCustomer's Billing Region ID
BillingPostalCodeOptionalStringCustomer's Billing Postal Code
yahooIdOptionalStringCustomer's Yahoo Id
MsnIdOptionalStringCustomer's MSN ID
ICQIdOptionalStringCustomer's ICQ ID
AIMIdOptionalStringCustomer's AIM ID
SkypeIdOptionalStringCustomer's Skype ID
FaceBookIdOptionalStringCustomer's Facebook ID
TwitterIdOptionalStringCustomer's Tweeter ID
LinkedInIdOptionalStringCustomer's LinkedIn ID
GooglePlusIdOptionalStringCustomer's Google Plus ID
YouTubeIdOptionalStringCustomer's Youtube ID
RSSFeedIdOptionalStringCustomer's RSS Feed ID
PinterestIdOptionalStringCustomer’s Pinteres ID
InstagramIdOptionalStringCustomer’s Instagram ID
AddInBinaryYesBooleanif customer will be added in binary tree: True or False
AddInMatrixYesBooleanif customer will be added in matrix tree: True or False
AddInUnilevelYesBooleanif customer will be added in unilevel tree: True or False

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

UnDelete

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
UserIDYesGuidDistributor’s User ID

Response Values

ParameterData TypeDescription
UnDeleteBooleanIf undelete is successful, Value either true or false

 

UpdateBillingAddress

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
billingIdYesIntegerBilling ID
userIdYesGuidUser ID
phoneNumberYesStringPhone Number
faxNumberYesStringFax Number
BillingCountryIdYesGuidBilling Country Id
BillingRegionIdYesGuidBilling Region Id
BillingPostalCodeYesStringBilling Postal Code

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

UpdateCustmerAccountNumber

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
userIdYesGuidUser ID
accountNumberYesIntegerAccount Number

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

UpdateCustomer

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
userIdYesGuidDistributor’s User ID
accountNumberYesStringDistributor’s Account Number
sponsorIdYesGuidDistributor’s Sponsor Guid
firstNameYesStringCustomer's First Name
lastNameYesStringCustomer's Last Name
SSNTaxNumberOptionalStringCustomer's SSN Tax Number
BusinessTaxIDOptionalStringCustomer's Business Tax Number
userNickNameYesStringCustomer's Nick Name
passwordYesStringCustomer's Password
emailYesStringCustomer's Email
websiteYesStringCustomer's Website
instantMessengerOptionalStringCustomer's Instant Messenger
countryIdYesGuidCustomer's Country ID in Guid
regionIdYesGuidCustomer's Region ID in Guid
postalCodeYesStringCustomer's Postal Code
phoneOptionalStringCustomer's Phone Number
cellOptionalStringCustomer's cell Number
faxOptionalStringCustomer's Fax Number
salutationOptionalStringCustomer's Salutation
middleNameOptionalStringCustomer's Middle Name
address1YesStringCustomer's Address 1
address2OptionalStringCustomer's Address 2
businessPhoneOptionalStringCustomer's Business Phone Number
homePhoneOptionalStringCustomer's Home Phone
iModeOptionalStringCustomer's IMode
companyOptionalStringCustomer's Company Name
birthdayYesDateCustomer's Birth Date; data format of mm/dd/yyyy
cityYesStringCustomer's City
ShippingAddress1OptionalStringCustomer's Shipping Address 1
ShippingAddress2OptionalStringCustomer's Shipping Address 2
ShippingCityYesStringCustomer's Shipping City
ShippingCountryIdYesGuidCustomer's Shipping Country ID
ShippingRegionIdYesGuidCustomer's Shipping Region ID
ShippingPostalCodeOptionalStringCustomer's Shipping Postal Code
BillingAddress1OptionalStringCustomer's Billing Address 1
BillingAddress2OptionalStringCustomer's Billing Address 2
BillingCityYesStringCustomer's Billing City
BillingCountryIdYesGuidCustomer's Billing Country ID
BillingRegionIdYesGuidCustomer's Billing Region ID
BillingPostalCodeOptionalStringCustomer's Billing Postal Code
yahooIdOptionalStringCustomer's Yahoo Id
MsnIdOptionalStringCustomer's MSN ID
ICQIdOptionalStringCustomer's ICQ ID
AIMIdOptionalStringCustomer's AIM ID
SkypeIdOptionalStringCustomer's Skype ID
FaceBookIdOptionalStringCustomer's Facebook ID
TwitterIdOptionalStringCustomer's Tweeter ID
LinkedInIdOptionalStringCustomer's LinkedIn ID
GooglePlusIdOptionalStringCustomer's Google Plus ID
YouTubeIdOptionalStringCustomer's Youtube ID
RSSFeedIdOptionalStringCustomer's RSS Feed ID
PinterestIdOptionalStringCustomer’s Pinteres ID
InstagramIdOptionalStringCustomer’s Instagram ID
AddInBinaryYesBooleanif customer will be added in binary tree: True or False
AddInMatrixYesBooleanif customer will be added in matrix tree: True or False
AddInUnilevelYesBooleanif customer will be added in unilevel tree: True or False

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

UpdateCustomerAPIStatus

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
accountNumberYesStringCustomer Account Number
APIStatusYesStringAPI Status

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

UpdateOrderAMANumber

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
orderIdYesIntegerOrder ID
AMANumberYesIntegerAMA Number

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

UpdateOrderPaymentStatus

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
orderIdYesIntegerOrder ID
StatusYesIntegerPayment Status

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

UpdateOrderStatus

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
orderIdYesIntegerOrder ID
StatusYesIntegerOrder Status

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

UpdateShippingAddress

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
ShippingIdYesIntegerShipping Id
ShippingAddress1YesStringShipping Address 1
ShippingAddress2YesStringShipping Address 2
ShippingCityYesStringShipping City
ShippingCountryIdYesGuidShipping Country ID
ShippingRegionIdYesGuidShipping Region ID
ShippingPostalCodeYesStringShipping Postal Code
UserIdYesGuidUser ID in Guid
phoneNumberYesStringPhone Number
faxNumberYesStringFax Number
firstNameYesStringFirst Name
lastNameYesStringLast Name
CompanyYesStringCompany
CountyYesStringCounty
addressNameYesStringAddress Name

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

UserListByActiveFlag

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
ActiveFlagYesBooleanActive Flag: True or False

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

ValidateEmail

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
EmailIdYesStringEmail Address

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

ValidateSiteName

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
SiteNameYesStringSite Name

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

ValidateUserName

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
UserNameYesStringUser Name

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process


 

 

OPERATION TYPES OF WSNotification

 

url -> client_website/Modules/MLM/WebServices/MPPE/MPPEWebServices/WSNotification.asmx

 

GetEmailSubscribeUserList

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
UserIdYesGuidUser’s Guid ID
CommonIdYesIntUser’s Common ID
eventTypeYesIntEvent Type
UserStatusTypeYesIntUser Status Type
subscribtionTypeYesIntSubscribtion Type
EnrollmentStartDateYesStringEnrollment Start Date; data format of mm/dd/yyyy
EnrollmentEndDateYesStringEnrollment End Date; data format of mm/dd/yyyy

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process




 

OPERATION TYPES OF WSSalesOrder

 

url -> client_website/Modules/MLM/WebServices/MPPE/MPPEWebServices/WSSalesOrder.asmx

 

SalesOrder

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
StartDateYesDateTimeStart Date of sales order; DateTime format
FinishDateYesDateTimeFinish Date of sales order; DateTime format
StatusYesIntStatus of sales order
CommissionTypeYesIntCommission Type of sales order

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process

 

SalesOrderSKU

Description:

Request Parameters

ParameterRequiredData TypeDescription
hashKeyYesGuidSite Guid
StartDateYesDateTimeStart Date of sales order; DateTime format
FinishDateYesDateTimeFinish Date of sales order; DateTime format
StatusYesIntStatus of sales order
CommissionTypeYesIntCommission Type of sales order
SKUYesIntSKU

Response Values

ParameterData TypeDescription
SuccessBooleanIndicator if API call succeeded returns True or False
MessageStringMessage for the process




 

OPERATION TYPES OF CommentAndSignUpNotifier

 

url -> client_website/WebServices/CommentAndSignUpNotifier.asmx

 

CommentNotifier

Description:

Request Parameters

ParameterRequiredData TypeDescription
nameYesStringName
emailYesStringEmail Address
phoneYesStringPhone Number
typeOfCommentYesStringType of Comment
commentsYesStringComment(s)

Response Values

ParameterData TypeDescription
BooleanBooleanIndicator if API call succeeded returns True or False

 

SignUpNotifier

Description:

Request Parameters

ParameterRequiredData TypeDescription
nameYesStringName
emailYesStringEmail Address
countryYesStringCountry
stateYesStringState
ownsProductYesStringOwn product

Response Values

ParameterData TypeDescription
BooleanBooleanIndicator if API call succeeded returns True or False

 

iGrowContactsContactUs

Description:

Request Parameters

ParameterRequiredData TypeDescription
nameYesStringName
emailYesStringEmail Address
subjectYesStringSubject
csMessageYesStringCS Message

Response Values

ParameterData TypeDescription
BooleanBooleanIndicator if API call succeeded returns True or False



 

Menu