MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetProducts

GetProducts

Description

Command to get product data, how other data is related to products, and some data related to products.

Attributes

package
modernbill
subpackage
mbapi
version
0.9
author
Michael Fountain
author
Andy Christ
author
Ben Woolley

Example Request

	<mbapi>
		<command><!-- string --></command>
		<showXMLHeader><!-- boolean --></showXMLHeader>
		<params>
			<productID><!-- int --></productID>
			<productVariantID><!-- int --></productVariantID>
			<packageID><!-- int --></packageID>
			<orderFormID><!-- int --></orderFormID>
			<notifyAdminGroupID><!-- int --></notifyAdminGroupID>
			<parentProductID><!-- int --></parentProductID>
			<getProductAttributeData><!-- boolean --></getProductAttributeData>
			<getAddons><!-- boolean --></getAddons>
			<getProductAttributeIDs><!-- boolean --></getProductAttributeIDs>
			<getProductChildIDs><!-- boolean --></getProductChildIDs>
			<getWebsiteWidgetData><!-- boolean --></getWebsiteWidgetData>
			<getEmailTemplateData><!-- boolean --></getEmailTemplateData>
			<getEmailTemplateIDs><!-- boolean --></getEmailTemplateIDs>
			<getEmailActionGroupData><!-- boolean --></getEmailActionGroupData>
			<getEmailActionGroupIDs><!-- boolean --></getEmailActionGroupIDs>
			<getCouponData><!-- boolean --></getCouponData>
			<getCouponIDs><!-- boolean --></getCouponIDs>
			<getAllOrderFormItemData><!-- boolean --></getAllOrderFormItemData>
			<getOrderFormItemData><!-- boolean --></getOrderFormItemData>
			<getOrderFormItemIDs><!-- boolean --></getOrderFormItemIDs>
			<getOrderFormData><!-- boolean --></getOrderFormData>
			<getOrderFormIDs><!-- boolean --></getOrderFormIDs>
			<getProductAddonGroupData><!-- boolean --></getProductAddonGroupData>
			<getProductAddonGroupIDs><!-- boolean --></getProductAddonGroupIDs>
			<getProductVariantData><!-- boolean --></getProductVariantData>
			<getProductVariantIDs><!-- boolean --></getProductVariantIDs>
			<getProductVariantPriceData><!-- boolean --></getProductVariantPriceData>
			<getproductVariantPriceIDs><!-- boolean --></getproductVariantPriceIDs>
			<getProductGroupData><!-- boolean --></getProductGroupData>
			<getTLDData><!-- boolean --></getTLDData>
			<getTLDIDs><!-- boolean --></getTLDIDs>
			<getCycleData><!-- boolean --></getCycleData>
			<getCycleIDs><!-- boolean --></getCycleIDs>
			<getServerGroupData><!-- boolean --></getServerGroupData>
			<getServerGroupIDs><!-- boolean --></getServerGroupIDs>
			<getTLDGhostData><!-- boolean --></getTLDGhostData>
			<getTLDGhostIDs><!-- boolean --></getTLDGhostIDs>
			<getCycleGhostData><!-- boolean --></getCycleGhostData>
			<getCycleGhostIDs><!-- boolean --></getCycleGhostIDs>
			<getServerGroupGhostData><!-- boolean --></getServerGroupGhostData>
			<getServerGroupGhostIDs><!-- boolean --></getServerGroupGhostIDs>
			<getVendorData><!-- boolean --></getVendorData>
		</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>
			<products>
				<product>
					<productID><!-- int --></productID>
					<productName><!-- string --></productName>
					<productType><!-- int --></productType>
					<productComments><!-- string --></productComments>
					<productActive><!-- boolean --></productActive>
					<productProratable><!-- boolean --></productProratable>
					<productStopNumCycles><!-- int --></productStopNumCycles>
					<productDateCreated><!-- int --></productDateCreated>
					<notifyAdminGroupID><!-- int --></notifyAdminGroupID>
					<productAddons>
						<productAddon>
							<productAddonID><!-- int --></productAddonID>
							<productAddonName><!-- int --></productAddonName>
							<stepID><!-- int --></stepID>
							<serverGroupID><!-- int --></serverGroupID>
							<productAddonActive><!-- boolean --></productAddonActive>
							<productAddonUpgrade><!-- boolean --></productAddonUpgrade>
							<productAddonOrder><!-- int --></productAddonOrder>
						</productAddon>
					</productAddons>
					<productAddons>
						<productAddon>
							<productAddonID><!-- int --></productAddonID>
						</productAddon>
					</productAddons>
					<productAttributes>
						<productAttribute>
							<productAttributeID><!-- int --></productAttributeID>
							<serverGroupID><!-- int --></serverGroupID>
							<productAttributeName><!-- string --></productAttributeName>
							<productAttributeValue><!-- string --></productAttributeValue>
							<productAttributeDateCreated><!-- int --></productAttributeDateCreated>
						</productAttribute>
					</productAttributes>
					<productAttributes>
						<productAttribute>
							<productAttributeID><!-- int --></productAttributeID>
						</productAttribute>
					</productAttributes>
					<productChildren>
						<productChild>
							<productChildID><!-- int --></productChildID>
						</productChild>
					</productChildren>
					<emailTemplates>
						<emailTemplate>
							<emailTplID><!-- int --></emailTplID>
							<emailTplName><!-- string --></emailTplName>
							<emailTplSubject><!-- string --></emailTplSubject>
							<emailTplBody><!-- string --></emailTplBody>
							<emailTplTextBody><!-- string --></emailTplTextBody>
							<localeLanguage><!-- string --></localeLanguage>
							<localeCountryISO2><!-- string --></localeCountryISO2>
							<emailActionGroupID><!-- int --></emailActionGroupID>
							<emailActionGroupName><!-- string --></emailActionGroupName>
						</emailTemplate>
					</emailTemplates>
					<emailTemplates>
						<emailTemplate>
							<emailTplID><!-- int --></emailTplID>
						</emailTemplate>
					</emailTemplates>
					<emailActionGroups>
						<emailActionGroup>
							<emailActionGroupID><!-- int --></emailActionGroupID>
							<emailActionGroupName><!-- string --></emailActionGroupName>
						</emailActionGroup>
					</emailActionGroups>
					<emailActionGroups>
						<emailActionGroup>
							<emailActionGroupID><!-- int --></emailActionGroupID>
						</emailActionGroup>
					</emailActionGroups>
					<coupons>
						<coupon>
							<couponID><!-- int --></couponID>
							<couponCode><!-- string --></couponCode>
							<couponDiscount><!-- float --></couponDiscount>
							<couponType><!-- int --></couponType>
							<couponComments><!-- string --></couponComments>
							<couponActive><!-- boolean --></couponActive>
							<couponDateCreated><!-- int --></couponDateCreated>
							<couponDateStarted><!-- int --></couponDateStarted>
							<couponDateEnded><!-- int --></couponDateEnded>
							<couponCount><!-- int --></couponCount>
							<couponMaxCount><!-- int --></couponMaxCount>
							<couponNewOnly><!-- boolean --></couponNewOnly>
							<couponNumCycles><!-- boolean --></couponNumCycles>
						</coupon>
					</coupons>
					<coupons>
						<coupon>
							<couponID><!-- int --></couponID>
						</coupon>
					</coupons>
					<orderFormItems>
						<orderFormItem>
							<orderFormItemID><!-- int --></orderFormItemID>
							<orderFormID><!-- int --></orderFormID>
							<orderFormItemOrder><!-- int --></orderFormItemOrder>
							<orderFormName><!-- string --></orderFormName>
							<paymentGroupID><!-- int --></paymentGroupID>
							<companyID><!-- int --></companyID>
							<languageID><!-- int --></languageID>
							<countriesID><!-- int --></countriesID>
						</orderFormItem>
					</orderFormItems>
					<orderFormItems>
						<orderFormItem>
							<orderFormItemID><!-- int --></orderFormItemID>
							<orderFormID><!-- int --></orderFormID>
							<orderFormItemOrder><!-- int --></orderFormItemOrder>
						</orderFormItem>
					</orderFormItems>
					<orderFormItems>
						<orderFormItem>
							<orderFormItemID><!-- int --></orderFormItemID>
						</orderFormItem>
					</orderFormItems>
					<orderForms>
						<orderForm>
							<orderFormID><!-- int --></orderFormID>
							<orderFormName><!-- string --></orderFormName>
							<paymentGroupID><!-- int --></paymentGroupID>
							<companyID><!-- int --></companyID>
							<languageID><!-- int --></languageID>
							<countriesID><!-- int --></countriesID>
						</orderForm>
					</orderForms>
					<orderForms>
						<orderForm>
							<orderFormID><!-- int --></orderFormID>
						</orderForm>
					</orderForms>
					<productVariants>
						<productVariant>
							<productVariantID><!-- int --></productVariantID>
							<productID><!-- int --></productID>
							<tldID><!-- int|NULL --></tldID>
						</productVariant>
					</productVariants>
					<productVariants>
						<productVariant>
							<productVariantID><!-- int --></productVariantID>
						</productVariant>
					</productVariants>
					<productVariantPrices>
						<productVariantPrice>
							<productVariantPriceID><!-- int --></productVariantPriceID>
							<productVariantID><!-- int --></productVariantID>
							<productVariantPriceType><!-- int --></productVariantPriceType>
							<cycleID><!-- int --></cycleID>
							<currencyID><!-- string --></currencyID>
							<productVariantPriceAmount><!-- float --></productVariantPriceAmount>
						</productVariantPrice>
					</productVariantPrices>
					<productVariantPrices>
						<productVariantPrice>
							<productVariantPriceID><!-- int --></productVariantPriceID>
						</productVariantPrice>
					</productVariantPrices>
					<TLDs>
						<TLD>
							<tldID><!-- int --></tldID>
							<registrarID><!-- int --></registrarID>
							<tldExtension><!-- string --></tldExtension>
							<tldName><!-- string --></tldName>
							<tldWhoisServer><!-- string --></tldWhoisServer>
							<tldWhoisResp><!-- string --></tldWhoisResp>
							<tldAccepted><!-- boolean --></tldAccepted>
							<tldAutoSearch><!-- boolean --></tldAutoSearch>
							<tldTransferMinimumCycleID><!-- int --></tldTransferMinimumCycleID>
							<tldMinimumCycleID><!-- int --></tldMinimumCycleID>
							<tldMaximumCycleID><!-- int --></tldMaximumCycleID>
							<tldRenewType><!-- int --></tldRenewType>
							<tldIsTransferable><!-- boolean --></tldIsTransferable>
							<tldTransferType><!-- int --></tldTransferType>
							<tldIDNSupport><!-- boolean --></tldIDNSupport>
							<tldIDNType><!-- int --></tldIDNType>
							<tldRemoteLockEnabled><!-- boolean --></tldRemoteLockEnabled>
						</TLD>
					</TLDs>
					<TLDs>
						<TLD>
							<tldID><!-- int --></tldID>
						</TLD>
					</TLDs>
					<cycles>
						<cycle>
							<cycleID><!-- int --></cycleID>
							<cycleDisplayName><!-- string --></cycleDisplayName>
							<cycleNumSeconds><!-- int --></cycleNumSeconds>
							<cycleNumMinutes><!-- int --></cycleNumMinutes>
							<cycleNumHours><!-- int --></cycleNumHours>
							<cycleNumDays><!-- int --></cycleNumDays>
							<cycleNumMonths><!-- int --></cycleNumMonths>
							<cycleNumYears><!-- int --></cycleNumYears>
						</cycle>
					</cycles>
					<cycles>
						<cycle>
							<cycleID><!-- int --></cycleID>
						</cycle>
					</cycles>
					<serverGroups>
						<serverGroup>
							<serverGroupID><!-- int --></serverGroupID>
							<serverGroupName><!-- string --></serverGroupName>
							<serverGroupFillType><!-- int --></serverGroupFillType>
						</serverGroup>
					</serverGroups>
					<serverGroups>
						<serverGroup>
							<serverGroupID><!-- int --></serverGroupID>
						</serverGroup>
					</serverGroups>
					<ghostTLDs>
						<ghostTLD>
							<tldID><!-- int --></tldID>
							<registrarID><!-- int --></registrarID>
							<tldExtension><!-- string --></tldExtension>
							<tldName><!-- string --></tldName>
							<tldWhoisServer><!-- string --></tldWhoisServer>
							<tldWhoisResp><!-- string --></tldWhoisResp>
							<tldAccepted><!-- boolean --></tldAccepted>
							<tldAutoSearch><!-- boolean --></tldAutoSearch>
							<tldTransferMinimumCycleID><!-- int --></tldTransferMinimumCycleID>
							<tldMinimumCycleID><!-- int --></tldMinimumCycleID>
							<tldMaximumCycleID><!-- int --></tldMaximumCycleID>
							<tldRenewType><!-- int --></tldRenewType>
							<tldIsTransferable><!-- boolean --></tldIsTransferable>
							<tldTransferType><!-- int --></tldTransferType>
							<tldIDNSupport><!-- boolean --></tldIDNSupport>
							<tldIDNType><!-- int --></tldIDNType>
							<tldRemoteLockEnabled><!-- boolean --></tldRemoteLockEnabled>
						</ghostTLD>
					</ghostTLDs>
					<ghostTLDs>
						<ghostTLD>
							<tldID><!-- int --></tldID>
						</ghostTLD>
					</ghostTLDs>
					<ghostCycles>
						<ghostCycle>
							<cycleID><!-- int --></cycleID>
							<cycleDisplayName><!-- string --></cycleDisplayName>
							<cycleNumSeconds><!-- int --></cycleNumSeconds>
							<cycleNumMinutes><!-- int --></cycleNumMinutes>
							<cycleNumHours><!-- int --></cycleNumHours>
							<cycleNumDays><!-- int --></cycleNumDays>
							<cycleNumMonths><!-- int --></cycleNumMonths>
							<cycleNumYears><!-- int --></cycleNumYears>
						</ghostCycle>
					</ghostCycles>
					<ghostCycles>
						<ghostCycle>
							<cycleID><!-- int --></cycleID>
						</ghostCycle>
					</ghostCycles>
					<ghostServerGroups>
						<ghostServerGroup>
							<serverGroupID><!-- int --></serverGroupID>
							<serverGroupName><!-- string --></serverGroupName>
							<serverGroupFillType><!-- int --></serverGroupFillType>
						</ghostServerGroup>
					</ghostServerGroups>
					<ghostServerGroups>
						<ghostServerGroup>
							<serverGroupID><!-- int --></serverGroupID>
						</ghostServerGroup>
					</ghostServerGroups>
				</product>
			</products>
		</results>
	</mbapi>

Request Elements

mbapi
Type
group
Description

MBAPI request document root.

Children
command
Type
string
Description

Required. The string GetProducts.

showXMLHeader
Type
boolean
Description

Whether to show an XML header in the results.

params
Type
group
Description

GetProducts parameters.

Children
productID
Type
int
Description

Limit data to products of this ID. This may occur multiple times, or not at all.

productVariantID
Type
int
Description

Limit data to product variants of this ID. This may occur multiple times, or not at all.

packageID
Type
int
Description

Limit data to products associated with this package ID. This may occur multiple times, or not at all.

orderFormID
Type
int
Description

Limit data to products associated with this order form ID. This may occur multiple times, or not at all. This will also limit product variant prices to those with the currency of the order forms specified.

notifyAdminGroupID
Type
int
Description

The admin group ID to CC emails to during product events.

parentProductID
Type
int
Description

Parent Product ID, will return all products who have this id as a parent.

getProductAttributeData
Type
boolean
Description

Get all data for related attributes. Attributes with no serverGroupID are generic attributes.

getAddons
Type
boolean
Description

Get only add-on products.

getProductAttributeIDs
Type
boolean
Description

Get the IDs for related attributes.

getProductChildIDs
Type
boolean
Description

Get all product IDs that are children of this product.

getWebsiteWidgetData
Type
boolean
Description

Get all website widget data for the requested products.

getEmailTemplateData
Type
boolean
Description

Get all data for related email templates.

getEmailTemplateIDs
Type
boolean
Description

Get the IDs for related email templates.

getEmailActionGroupData
Type
boolean
Description

Get all data for related email action groups.

getEmailActionGroupIDs
Type
boolean
Description

Get the IDs for related email action groups.

getCouponData
Type
boolean
Description

Get all data for related coupons.

getCouponIDs
Type
boolean
Description

Get all data for related preapplied coupons.

getAllOrderFormItemData
Type
boolean
Description

Get data for related order form items with in-line order form data.

getOrderFormItemData
Type
boolean
Description

Get data for related order form items.

getOrderFormItemIDs
Type
boolean
Description

Get the IDs for related order form items

getOrderFormData
Type
boolean
Description

Get data for related order forms. That is, order forms with order form items which refer to this product.

getOrderFormIDs
Type
boolean
Description

Get IDs for related order forms.

getProductAddonGroupData
Type
boolean
Description

Get data for related product addon groups.

getProductAddonGroupIDs
Type
boolean
Description

Get IDs for related product addon groups.

getProductVariantData
Type
boolean
Description

Get data for related product variants.

getProductVariantIDs
Type
boolean
Description

Get IDs for related product variants.

getProductVariantPriceData
Type
boolean
Description

Get data for related product variant prices.

getproductVariantPriceIDs
Type
boolean
Description

Get IDs for related product variant prices.

getProductGroupData
Type
boolean
Description

Get all data for the product groups tied to this product.

getTLDData
Type
boolean
Description

Get all data for TLDs relating to this product via product variants. Product variants are the real relations between products and TLDs. When an admin associates a TLD with a product, a "ghost" or "imaginary" relation is created, not a real relation. The system compares getTLDGhostIDs with getTLDIDs to find which product variants are needed to resolve the request of the admin.

getTLDIDs
Type
boolean
Description

Get all TLD IDs that are really related to the product.

getCycleData
Type
boolean
Description

Get all data for cycles relating to this product via product variant prices. Product variant prices are the real relations between products and cycles. When an admin associates a cycle with a product, a "ghost" or "imaginary" relation is created, not a real relation. The system compares getCycleGhostIDs with getCycleIDs to find which product variants are needed to resolve the request of the admin.

getCycleIDs
Type
boolean
Description

Get all cycle IDs that are really related to the product.

getServerGroupData
Type
boolean
Description

Get all data for server groups relating to this product via product attributes. Product attributes are the real relations between products and server groups. When an admin associates a server group with a product, a "ghost" or "imaginary" relation is created, not a real relation. The system compares getServerGroupGhostIDs with getServerGroupIDs to find which product attributes are needed to resolve the request of the admin.

getServerGroupIDs
Type
boolean
Description

Get all server group IDs that are really related to the product.

getTLDGhostData
Type
boolean
Description

Get all data for TLDs imaginarily related to this product. This imaginary relation represents the admin's intent to fully qualify the relation to TLDs via product variants.

getTLDGhostIDs
Type
boolean
Description

Get all TLD IDs that are imaginarily related to the product.

getCycleGhostData
Type
boolean
Description

Get all data for cycles imaginarily related to this product. This imaginary relation represents the admin's intent to fully qualify the relation to Cycles via product variant prices.

getCycleGhostIDs
Type
boolean
Description

Get all cycle IDs that are imaginarily related to the product.

getServerGroupGhostData
Type
boolean
Description

Get all data for server groups imaginarily related to this product. This imaginary relation represents the admin's intent to fully qualify the relation to server groups via product attributes.

getServerGroupGhostIDs
Type
boolean
Description

Get all server group IDs that are imaginarily related to the product.

getVendorData
Type
boolean
Description

Get all vendor related data for this product.

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

Contains any results.

Children
products
Type
group
Description

Contains all product results.

Children
product
Type
group
Description

Contains all results for a single product. Occurs header numResults times.

Children
productID
Type
int
Description

The ID of the product.

productName
Type
string
Description

The product name for the order form. Names need not be unique. Operations are performed on IDs. Names are merely for display.

productType
Type
int
Description

The type of product.

  • 0: Undefined
  • 1: Hosting
  • 2: Non-hosting
  • 3: Domain
  • 4: SSL Cert
  • 5: License
  • 6: Software
  • 7: Usage
  • 8: Contract

productComments
Type
string
Description

Comments on the product. These may appear on order forms, usually depending upon whether an order form template refers to it. A third party order form may do anything it likes with this.

productActive
Type
boolean
Description

Whether the product is active. Inactive products won't show up on order forms, among other obviously appropriate things. Except for the unsurprising ability for an admin to manage an inactive product, they act as if they don't exist.

productProratable
Type
boolean
Description

Whether the product's billing should be prorated. This is usually used for products that are on-going services. A hosting package might be proratable. A magazine subscription, however, would likely not be proratable because it is a tangible item that is either all-or-nothing.

productStopNumCycles
Type
int
Description

The number of cycles for which to bill.

  • 0: Bill forever.
  • 1: Bill one time only.
  • >1: Bill for the specified number of cycles.

The Stop in the name is counter-intuitive. Please ignore it.

productDateCreated
Type
int
Description

The Unix timestamp of when the product was created.

notifyAdminGroupID
Type
int
Description

The admin group ID to CC emails to during product events.

productAddons
Type
group
Description

Contains product add-ons

Children
productAddon
Type
group
Description

Contains a single product add-on. May occur multiple times.

Children
productAddonID
Type
int
Description

The ID of this add-on.

productAddonName
Type
int
Description

The name of this add-on.

stepID
Type
int
Description

If a step ID is associated with this add-on, it occurs here.

serverGroupID
Type
int
Description

If a server group ID is associated with this add-on, it occurs here.

productAddonActive
Type
boolean
Description

Whether the add-on is active.

productAddonUpgrade
Type
boolean
Description

Whether the add-on is upgradable.

productAddonOrder
Type
int
Description

The order in which this add-on displays on the order form.

productAddons
Type
group
Description

Contains product add-on relations.

Children
productAddon
Type
group
Description

Contains a single product add-on relation.

Children
productAddonID
Type
int
Description

ID for the product add-on of this relation.

productAttributes
Type
group
Description

Contains product attributes.

Children
productAttribute
Type
group
Description

Contains a single product attribute.

Children
productAttributeID
Type
int
Description

ID for this product attribute.

serverGroupID
Type
int
Description

If this is a panel attribute, this will occur. ID of the server group which this attribute is for.

productAttributeName
Type
string
Description

Name of this product attribute. If for a server group, the names correspond to the names in the panel attribute map used by panel modules. If not for a server group, this is a generic attribute with names corresponding to whatever uses these generic attributes, since anything with access to MBAPI can use them.

productAttributeValue
Type
string
Description

The string value of the attribute.

productAttributeDateCreated
Type
int
Description

The Unix timestamp of when the attribute was created.

productAttributes
Type
group
Description

Contains product add-on relations.

Children
productAttribute
Type
group
Description

Contains a single product attribute relation.

Children
productAttributeID
Type
int
Description

ID of the product attribute of this relation.

productChildren
Type
group
Description

Contains product child relations.

Children
productChild
Type
group
Description

Contains a single product child relation.

Children
productChildID
Type
int
Description

The ID of a product which is a child product of this product.

emailTemplates
Type
group
Description

Contains email templates.

Children
emailTemplate
Type
group
Description

Contains data for a single email template.

Children
emailTplID
Type
int
Description

The ID of this template.

emailTplName
Type
string
Description

The Name of this template.

emailTplSubject
Type
string
Description

The email subject that will be used for this template.

emailTplBody
Type
string
Description

The full HTML of the email template with variables in the form {VARIABLE}.

emailTplTextBody
Type
string
Description

The full text of the email template with variables in the form {VARIABLE}.

localeLanguage
Type
string
Description

The 2 to 7 character ISO language code for this template.

localeCountryISO2
Type
string
Description

The 2 character ISO country code for this template.

emailActionGroupID
Type
int
Description

The email action group ID for this template. Email action groups are used to group templates that are identical except for varying locale.

emailActionGroupName
Type
string
Description

The email action group name.

emailTemplates
Type
group
Description

Contains email template relations.

Children
emailTemplate
Type
group
Description

Contains a single email template relation.

Children
emailTplID
Type
int
Description

The ID for the email template of this relation.

emailActionGroups
Type
group
Description

Contains email action group data.

Children
emailActionGroup
Type
group
Description

Contains data for a single email action group.

Children
emailActionGroupID
Type
int
Description

The email action group ID for this template. Email action groups are used to group templates that are identical except for varying locale.

emailActionGroupName
Type
string
Description

The email action group name.

emailActionGroups
Type
group
Description

Contains email action group relations.

Children
emailActionGroup
Type
group
Description

Contains a single email action group relation.

Children
emailActionGroupID
Type
int
Description

The ID for the email action group of this relation.

coupons
Type
group
Description

Contains coupon data.

Children
coupon
Type
group
Description

Contains data for a single coupon.

Children
couponID
Type
int
Description

ID of this coupon.

couponCode
Type
string
Description

The user designated code for this coupon. This is the string that a customer enters to redeem the coupon on the order form.

couponDiscount
Type
float
Description

The 2 decimal floating point value of the discount; either a percent or a unit of money, depending on the type.

couponType
Type
int
Description

The type of coupon.

  • 0: Discount is a percent
  • 1: Discount is a unit of money of the currency of the package

couponComments
Type
string
Description

Comments describing the coupon.

couponActive
Type
boolean
Description

Whether the coupon is active.

couponDateCreated
Type
int
Description

Unix timestamp of when the coupon was created.

couponDateStarted
Type
int
Description

Unix timestamp of when the coupon period starts.

couponDateEnded
Type
int
Description

Unix timestamp of when the coupon period ends (expires).

couponCount
Type
int
Description

The number of times this coupon was used.

couponMaxCount
Type
int
Description

The maximum number of times this coupon may be used.

couponNewOnly
Type
boolean
Description

Whether only new clients may use this coupon.

couponNumCycles
Type
boolean
Description

The number of billing cycles to which this coupon's discount will be applied. 0 for forever.

coupons
Type
group
Description

Contains coupon relations.

Children
coupon
Type
group
Description

Contains a single coupon relation.

Children
couponID
Type
int
Description

The ID for the coupon of this relation.

orderFormItems
Type
group
Description

Contains order form items with order form data.

Children
orderFormItem
Type
group
Description

Contains a single order form item along with order form data.

Relating products to order forms involves creating an item for the order form which basically involves just the association to the order form plus the display order.

Children
orderFormItemID
Type
int
Description

ID of this order form item.

orderFormID
Type
int
Description

ID of the order form this item is on.

orderFormItemOrder
Type
int
Description

Order in which this item appears on the order form.

orderFormName
Type
string
Description

Name of the order form this item is on.

paymentGroupID
Type
int
Description

ID of the payment group for this item's order form.

companyID
Type
int
Description

ID of the company this item's order form is for.

languageID
Type
int
Description

ID of the language of this item's order form.

countriesID
Type
int
Description

ID of the country of this item's order form.

orderFormItems
Type
group
Description

Contains order form items.

Children
orderFormItem
Type
group
Description

Contains a single order form item.

Children
orderFormItemID
Type
int
Description

ID of this order form item.

orderFormID
Type
int
Description

ID of the order form this item is on.

orderFormItemOrder
Type
int
Description

Order in which this item appears on the order form.

orderFormItems
Type
group
Description

Contains order form item relations.

Children
orderFormItem
Type
group
Description

Contains a single order form item relation.

Children
orderFormItemID
Type
int
Description

The ID for the order form item of this relation.

orderForms
Type
group
Description

Contains order form data.

Children
orderForm
Type
group
Description

Contains data for a single order form.

Relating products to order forms involves creating an item for the order form which basically involves just the association to the order form plus the display order.

Children
orderFormID
Type
int
Description

ID of this order form.

orderFormName
Type
string
Description

The name of this order form.

paymentGroupID
Type
int
Description

The payment group ID for this order form.

companyID
Type
int
Description

The ID of the company this order form is for.

languageID
Type
int
Description

ID of the language of this order form.

countriesID
Type
int
Description

ID of the country of this order form.

orderForms
Type
group
Description

Contains order form relations.

Children
orderForm
Type
group
Description

Contains a single order form relation.

Children
orderFormID
Type
int
Description

The ID for the order form of this relation.

productVariants
Type
group
Description

Contains product variant data.

Children
productVariant
Type
group
Description

Contains data for a single product variant.

Children
productVariantID
Type
int
Description

ID of this product variant.

productID
Type
int
Description

ID of the product this variant is for.

tldID
Type
int|NULL
Description

ID of the TLD of this product variant. This will be null if the product is not a domain product type.

productVariants
Type
group
Description

Contains product variant relations.

Children
productVariant
Type
group
Description

Contains a single product variant relation.

Children
productVariantID
Type
int
Description

The ID for the product variant of this relation.

productVariantPrices
Type
group
Description

Contains product variant price data. If you specify an orderFormID in params then the prices will be limited to those of the currency of that order form.

Children
productVariantPrice
Type
group
Description

Contains data for a single product variant price.

Children
productVariantPriceID
Type
int
Description

ID of this product variant price.

productVariantID
Type
int
Description

ID of the product variant this price is for.

productVariantPriceType
Type
int
Description

The type of product variant price.

  • 0: General
  • 1: Setup
  • 2: Transfer

Transfer prices are for product variants which have TLDs associated with them.

cycleID
Type
int
Description

The cycle ID of the product variant. This will be null for transfer type prices; in that case, get the cycle via tldTransferMinimumCycleID of the product's TLD.

currencyID
Type
string
Description

The 3 letter currency code for this product variant price.

productVariantPriceAmount
Type
float
Description

2 decimal floating point monetary value of this price in the currency specified for this price.

productVariantPrices
Type
group
Description

Contains product variant price relations.

Children
productVariantPrice
Type
group
Description

Contains a single product variant price relation.

Children
productVariantPriceID
Type
int
Description

The ID for the product variant price of this relation.

TLDs
Type
group
Description

Contains data for TLDs really related to this product via product variants.

Children
TLD
Type
group
Description

Contains data for a single TLD.

Children
tldID
Type
int
Description

ID of this TLD.

registrarID
Type
int
Description

The config group ID of this TLD's regisrar.

tldExtension
Type
string
Description

The extension of this TLD without the leading dot. For example, co.uk or org.

tldName
Type
string
Description

The name of this TLD.

tldWhoisServer
Type
string
Description

The hostname of the whois server for this TLD.

tldWhoisResp
Type
string
Description

The string to search for in the whois response which signifies that a domain is available.

tldAccepted
Type
boolean
Description

Whether orders for this TLD are acceptable. Basically, whether this TLD is active.

tldAutoSearch
Type
boolean
Description

Whether the order form should automatically check this TLD whenever any domain is queried.

tldTransferMinimumCycleID
Type
int
Description

ID for the cycle which represents the minimum duration for a transfer to this TLD.

tldMinimumCycleID
Type
int
Description

The mimimum number of years for which a domain of this TLD may be purchased.

tldMaximumCycleID
Type
int
Description

The maximum number of years for which a domain of this TLD may be purchased.

tldRenewType
Type
int
Description

The type of renewal for this TLD.

  • 0: Disabled
  • 1: Renewed by the registrar
  • 2: Renewed by ModernBill

tldIsTransferable
Type
boolean
Description

Whether this TLD is transferable.

tldTransferType
Type
int
Description

The type of transfer for this TLD.

  • 0: Code
  • 1: Fax
  • 2: Email
  • 3: Mail

tldIDNSupport
Type
boolean
Description

Whether IDN is supported by this TLD's registrar.

tldIDNType
Type
int
Description

The type of IDN supported by this TLD's registrar.

  • 0: Puny Code

tldRemoteLockEnabled
Type
boolean
Description

Allow this TLD to be locked at the registrar.

TLDs
Type
group
Description

Contains real TLD relations.

Children
TLD
Type
group
Description

Contains a single, real TLD relation.

Children
tldID
Type
int
Description

The ID of a TLD really related to this product.

cycles
Type
group
Description

Contains data for cycles really related to the product via product variant prices.

Children
cycle
Type
group
Description

Contains data for a single cycle.

Children
cycleID
Type
int
Description

ID for this cycle.

cycleDisplayName
Type
string
Description

Display name for this cycle.

cycleNumSeconds
Type
int
Description

Number of seconds to add to the duration.

cycleNumMinutes
Type
int
Description

Number of minutes to add to the duration.

cycleNumHours
Type
int
Description

Number of hours to add to the duration.

cycleNumDays
Type
int
Description

Number of days to add to the duration.

cycleNumMonths
Type
int
Description

Number of months to add to the duration.

cycleNumYears
Type
int
Description

Number of years to add to the duration.

cycles
Type
group
Description

Contains real cycle relations.

Children
cycle
Type
group
Description

Contains a single, real cycle relation.

Children
cycleID
Type
int
Description

The ID of a cycle really related to this product.

serverGroups
Type
group
Description

Contains data for server groups really related to the product via the attributes.

Children
serverGroup
Type
group
Description

Contains data for a single server group.

Children
serverGroupID
Type
int
Description

ID for this server group.

serverGroupName
Type
string
Description

Name of this server group

serverGroupFillType
Type
int
Description

How the accounts are to be distributed to servers.

  • 0: Distribute to least full server.
  • 1: Distribute to one server at a time.

serverGroups
Type
group
Description

Contains real server group relations.

Children
serverGroup
Type
group
Description

Contains a single, real server group relation.

Children
serverGroupID
Type
int
Description

The ID of a server group really related to this product.

ghostTLDs
Type
group
Description

Contains data for TLDs imaginarily related to this product.

Children
ghostTLD
Type
group
Description

Contains data for a single, imaginary TLD.

Children
tldID
Type
int
Description

ID of this TLD.

registrarID
Type
int
Description

The config group ID of this TLD's regisrar.

tldExtension
Type
string
Description

The extension of this TLD without the leading dot. For example, co.uk or org.

tldName
Type
string
Description

The name of this TLD.

tldWhoisServer
Type
string
Description

The hostname of the whois server for this TLD.

tldWhoisResp
Type
string
Description

The string to search for in the whois response which signifies that a domain is available.

tldAccepted
Type
boolean
Description

Whether orders for this TLD are acceptable. Basically, whether this TLD is active.

tldAutoSearch
Type
boolean
Description

Whether the order form should automatically check this TLD whenever any domain is queried.

tldTransferMinimumCycleID
Type
int
Description

ID for the cycle which represents the minimum duration for a transfer to this TLD.

tldMinimumCycleID
Type
int
Description

The mimimum number of years for which a domain of this TLD may be purchased.

tldMaximumCycleID
Type
int
Description

The maximum number of years for which a domain of this TLD may be purchased.

tldRenewType
Type
int
Description

The type of renewal for this TLD.

  • 0: Disabled
  • 1: Renewed by the registrar
  • 2: Renewed by ModernBill

tldIsTransferable
Type
boolean
Description

Whether this TLD is transferable.

tldTransferType
Type
int
Description

The type of transfer for this TLD.

  • 0: Code
  • 1: Fax
  • 2: Email
  • 3: Mail

tldIDNSupport
Type
boolean
Description

Whether IDN is supported by this TLD's registrar.

tldIDNType
Type
int
Description

The type of IDN supported by this TLD's registrar.

  • 0: Puny Code

tldRemoteLockEnabled
Type
boolean
Description

Allow this TLD to be locked at the registrar.

ghostTLDs
Type
group
Description

Contains imaginary TLD relations.

Children
ghostTLD
Type
group
Description

Contains a single, imaginary TLD relation.

Children
tldID
Type
int
Description

The ID of a TLD imaginarily related to this product.

ghostCycles
Type
group
Description

Contains data for cycles imaginarily related to the product.

Children
ghostCycle
Type
group
Description

Contains data for a single, imaginary cycle.

Children
cycleID
Type
int
Description

ID for this cycle.

cycleDisplayName
Type
string
Description

Display name for this cycle.

cycleNumSeconds
Type
int
Description

Number of seconds to add to the duration.

cycleNumMinutes
Type
int
Description

Number of minutes to add to the duration.

cycleNumHours
Type
int
Description

Number of hours to add to the duration.

cycleNumDays
Type
int
Description

Number of days to add to the duration.

cycleNumMonths
Type
int
Description

Number of months to add to the duration.

cycleNumYears
Type
int
Description

Number of years to add to the duration.

ghostCycles
Type
group
Description

Contains imaginary cycle relations.

Children
ghostCycle
Type
group
Description

Contains a single, imaginary cycle relation.

Children
cycleID
Type
int
Description

The ID of a cycle imaginarily related to this product.

ghostServerGroups
Type
group
Description

Contains data for server groups imaginarily related to the product via the attributes.

Children
ghostServerGroup
Type
group
Description

Contains data for a single, imaginary server group.

Children
serverGroupID
Type
int
Description

ID for this server group.

serverGroupName
Type
string
Description

Name of this server group

serverGroupFillType
Type
int
Description

How the accounts are to be distributed to servers.

  • 0: Distribute to least full server.
  • 1: Distribute to one server at a time.

ghostServerGroups
Type
group
Description

Contains imaginary server group relations.

Children
ghostServerGroup
Type
group
Description

Contains a single, imaginary server group relation.

Children
serverGroupID
Type
int
Description

The ID of a server group imaginarily related to this product.