GetPackageAddons

Description

Command to get product addon ledger entries and their filter cycles and currencies.

Attributes

Product
modernbill
subProduct
mbapi
version
0.9
author
Kris Bailey

Example Request

	<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>

		

Example Response

	<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>

		

Request Elements

mbapi
Type
group
Description

MBAPI request document root.

Children
command
Type
string
Description

Required. The string GetPackageAddons.

showXMLHeader
Type
boolean
Description

Whether to show an XML header in the results.

params
Type
group
Description

GetPackageAddons parameters.

Children
packageAddonID
Type
int
Description

Package Addon ID, if you want to get a specific one.

packageAddonDisplayName
Type
string
Description

Package Addon Display Name to search by.

packageAddonPriceLock
Type
int
Description

Package Addon Display Name to search by.

packageAddonActive
Type
int
Description

Package Addon Active.

packageAddonDiscountable
Type
int
Description

Package Addon Discountable.

packageAddonDiscount
Type
double
Description

Package Addon Discount.

packageAddonProductID
Type
int
Description

Package Addon Product ID.

taxZoneGroupID
Type
int
Description

Tax Zone Group ID of this package addon.

couponID
Type
int
Description

Coupon ID of the applied coupon if applicable.

couponNumCycles
Type
int
Description

Coupon Num Cycles, number of cycles a coupon still has to apply.

packageAddonOriginalPrice
Type
double
Description

Package Addon Original Price.

packageAddonOriginalPriceGreaterThan
Type
double
Description

Package Addon Original Price to be greater than.

packageAddonOriginalPriceLessThan
Type
double
Description

Package Addon Original Price to be less than.

packageAddonOriginalPriceGreatest
Type
double
Description

Package Addon Original Price to be less than or equal to.

packageAddonOriginalPriceLeast
Type
double
Description

Package Addon Original Price to be greater than or equal to.

packageAddonPrice
Type
double
Description

Package Addon Price.

packageAddonPriceGreaterThan
Type
double
Description

Package Addon Price to be greater than.

packageAddonPriceLessThan
Type
double
Description

Package Addon Price to be less than.

packageAddonPriceGreatest
Type
double
Description

Package Addon Price to be less than or equal to.

packageAddonPriceLeast
Type
double
Description

Package Addon Price to be greater than or equal to.

packageAddonSetupPrice
Type
double
Description

Package Addon Setup Price.

packageAddonSetupPriceGreaterThan
Type
double
Description

Package Addon Setup Price to be greater than.

packageAddonSetupPriceLessThan
Type
double
Description

Package Addon Setup Price to be less than.

packageAddonSetupPriceGreatest
Type
double
Description

Package Addon Setup Price to be less than or equal to.

packageAddonSetupPriceLeast
Type
double
Description

Package Addon Setup Price to be greater than or equal to.

couponPrice
Type
double
Description

Coupon Price.

couponPriceGreaterThan
Type
double
Description

Coupon Price to be greater than.

couponPriceLessThan
Type
double
Description

Coupon Price to be less than.

couponPriceGreatest
Type
double
Description

Coupon Price to be less than or equal to.

couponPriceLeast
Type
double
Description

Coupon Price to be greater than or equal to.

Response Elements

mbapi
Type
group
Description

MBAPI response document root.

Children
header
Type
group
Description

Contains result meta data: data about the result itself.

Children
remoteSessionID
Type
hex
Description

A session ID that may be used for authentication instead of a remote access hash.

errorCount
Type
int
Description

The number of errors that occured.

errors
Type
group
Description

Contains any errors that occured.

Children
error
Type
group
Description

Contains information relating to a single error. Occurs header errorCount times.

Children
title
Type
string
Description

The title of the error.

message
Type
string
Description

The error message.

numResults
Type
int
Description

The number of results that have been returned. For Get commands.

numAffectedRows
Type
int
Description

The number of rows that have been affected. For Set commands.

results
Type
None
Description
None
Children
packageAddons
Type
None
Description
None
Children
packageAddon
Type
None
Description
None
Children
packageAddonID
Type
int
Description

Package Addon ID, if you want to get a specific one.

packageAddonDisplayName
Type
string
Description

Package Addon Display Name to search by.

packageAddonPriceLock
Type
int
Description

Package Addon Display Name to search by.

packageAddonActive
Type
int
Description

Package Addon Active.

packageAddonProductID
Type
int
Description

Package Addon Product ID.

taxZoneGroupID
Type
int
Description

Tax Zone Group ID of this package addon.

couponID
Type
int
Description

Coupon ID of the applied coupon if applicable.

couponNumCycles
Type
int
Description

Coupon Num Cycles, number of cycles a coupon still has to apply.

packageAddonOriginalPrice
Type
double
Description

Package Addon Original Price.

packageAddonPrice
Type
double
Description

Package Addon Price.

packageAddonSetupPrice
Type
double
Description

Package Addon Setup Price.

couponPrice
Type
double
Description

Coupon Price.