Command to get product addon ledger entries and their filter cycles and currencies.
<mbapi> <command><!-- string --></command> <showXMLHeader><!-- boolean --></showXMLHeader> <params> <packageAddonID><!-- int --></packageAddonID> <packageAddonDisplayName><!-- string --></packageAddonDisplayName> <packageAddonPriceLock><!-- int --></packageAddonPriceLock> <packageAddonActive><!-- int --></packageAddonActive> <packageAddonDiscountable><!-- int --></packageAddonDiscountable> <packageAddonDiscount><!-- double --></packageAddonDiscount> <packageAddonProductID><!-- int --></packageAddonProductID> <taxZoneGroupID><!-- int --></taxZoneGroupID> <couponID><!-- int --></couponID> <couponNumCycles><!-- int --></couponNumCycles> <packageAddonOriginalPrice><!-- double --></packageAddonOriginalPrice> <packageAddonOriginalPriceGreaterThan><!-- double --></packageAddonOriginalPriceGreaterThan> <packageAddonOriginalPriceLessThan><!-- double --></packageAddonOriginalPriceLessThan> <packageAddonOriginalPriceGreatest><!-- double --></packageAddonOriginalPriceGreatest> <packageAddonOriginalPriceLeast><!-- double --></packageAddonOriginalPriceLeast> <packageAddonPrice><!-- double --></packageAddonPrice> <packageAddonPriceGreaterThan><!-- double --></packageAddonPriceGreaterThan> <packageAddonPriceLessThan><!-- double --></packageAddonPriceLessThan> <packageAddonPriceGreatest><!-- double --></packageAddonPriceGreatest> <packageAddonPriceLeast><!-- double --></packageAddonPriceLeast> <packageAddonSetupPrice><!-- double --></packageAddonSetupPrice> <packageAddonSetupPriceGreaterThan><!-- double --></packageAddonSetupPriceGreaterThan> <packageAddonSetupPriceLessThan><!-- double --></packageAddonSetupPriceLessThan> <packageAddonSetupPriceGreatest><!-- double --></packageAddonSetupPriceGreatest> <packageAddonSetupPriceLeast><!-- double --></packageAddonSetupPriceLeast> <couponPrice><!-- double --></couponPrice> <couponPriceGreaterThan><!-- double --></couponPriceGreaterThan> <couponPriceLessThan><!-- double --></couponPriceLessThan> <couponPriceGreatest><!-- double --></couponPriceGreatest> <couponPriceLeast><!-- double --></couponPriceLeast> </params> </mbapi>
<mbapi> <header> <remoteSessionID><!-- hex --></remoteSessionID> <errorCount><!-- int --></errorCount> <errors> <error> <title><!-- string --></title> <message><!-- string --></message> </error> </errors> <numResults><!-- int --></numResults> <numAffectedRows><!-- int --></numAffectedRows> </header> <results> <packageAddons> <packageAddon> <packageAddonID><!-- int --></packageAddonID> <packageAddonDisplayName><!-- string --></packageAddonDisplayName> <packageAddonPriceLock><!-- int --></packageAddonPriceLock> <packageAddonActive><!-- int --></packageAddonActive> <packageAddonProductID><!-- int --></packageAddonProductID> <taxZoneGroupID><!-- int --></taxZoneGroupID> <couponID><!-- int --></couponID> <couponNumCycles><!-- int --></couponNumCycles> <packageAddonOriginalPrice><!-- double --></packageAddonOriginalPrice> <packageAddonPrice><!-- double --></packageAddonPrice> <packageAddonSetupPrice><!-- double --></packageAddonSetupPrice> <couponPrice><!-- double --></couponPrice> </packageAddon> </packageAddons> </results> </mbapi>
mbapi
MBAPI request document root.
command
Required. The string GetPackageAddons.
showXMLHeader
Whether to show an XML header in the results.
params
GetPackageAddons parameters.
packageAddonID
Package Addon ID, if you want to get a specific one.
packageAddonDisplayName
Package Addon Display Name to search by.
packageAddonPriceLock
Package Addon Display Name to search by.
packageAddonActive
Package Addon Active.
packageAddonDiscountable
Package Addon Discountable.
packageAddonDiscount
Package Addon Discount.
packageAddonProductID
Package Addon Product ID.
taxZoneGroupID
Tax Zone Group ID of this package addon.
couponID
Coupon ID of the applied coupon if applicable.
couponNumCycles
Coupon Num Cycles, number of cycles a coupon still has to apply.
packageAddonOriginalPrice
Package Addon Original Price.
packageAddonOriginalPriceGreaterThan
Package Addon Original Price to be greater than.
packageAddonOriginalPriceLessThan
Package Addon Original Price to be less than.
packageAddonOriginalPriceGreatest
Package Addon Original Price to be less than or equal to.
packageAddonOriginalPriceLeast
Package Addon Original Price to be greater than or equal to.
packageAddonPrice
Package Addon Price.
packageAddonPriceGreaterThan
Package Addon Price to be greater than.
packageAddonPriceLessThan
Package Addon Price to be less than.
packageAddonPriceGreatest
Package Addon Price to be less than or equal to.
packageAddonPriceLeast
Package Addon Price to be greater than or equal to.
packageAddonSetupPrice
Package Addon Setup Price.
packageAddonSetupPriceGreaterThan
Package Addon Setup Price to be greater than.
packageAddonSetupPriceLessThan
Package Addon Setup Price to be less than.
packageAddonSetupPriceGreatest
Package Addon Setup Price to be less than or equal to.
packageAddonSetupPriceLeast
Package Addon Setup Price to be greater than or equal to.
couponPrice
Coupon Price.
couponPriceGreaterThan
Coupon Price to be greater than.
couponPriceLessThan
Coupon Price to be less than.
couponPriceGreatest
Coupon Price to be less than or equal to.
couponPriceLeast
Coupon Price to be greater than or equal to.
mbapi
MBAPI response document root.
header
Contains result meta data: data about the result itself.
remoteSessionID
A session ID that may be used for authentication instead of a remote access hash.
errorCount
The number of errors that occured.
errors
Contains any errors that occured.
error
Contains information relating to a single error. Occurs header errorCount times.
title
The title of the error.
message
The error message.
numResults
The number of results that have been returned. For Get commands.
numAffectedRows
The number of rows that have been affected. For Set commands.
results
packageAddons
packageAddon
packageAddonID
Package Addon ID, if you want to get a specific one.
packageAddonDisplayName
Package Addon Display Name to search by.
packageAddonPriceLock
Package Addon Display Name to search by.
packageAddonActive
Package Addon Active.
packageAddonProductID
Package Addon Product ID.
taxZoneGroupID
Tax Zone Group ID of this package addon.
couponID
Coupon ID of the applied coupon if applicable.
couponNumCycles
Coupon Num Cycles, number of cycles a coupon still has to apply.
packageAddonOriginalPrice
Package Addon Original Price.
packageAddonPrice
Package Addon Price.
packageAddonSetupPrice
Package Addon Setup Price.
couponPrice
Coupon Price.