Command to get product data, how other data is related to products, and some data related to products.
<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>
<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>
mbapi
MBAPI request document root.
command
Required. The string GetProducts.
showXMLHeader
Whether to show an XML header in the results.
params
GetProducts parameters.
productID
Limit data to products of this ID. This may occur multiple times, or not at all.
productVariantID
Limit data to product variants of this ID. This may occur multiple times, or not at all.
packageID
Limit data to products associated with this package ID. This may occur multiple times, or not at all.
orderFormID
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
The admin group ID to CC emails to during product events.
parentProductID
Parent Product ID, will return all products who have this id as a parent.
getProductAttributeData
Get all data for related attributes. Attributes with no serverGroupID are generic attributes.
getAddons
Get only add-on products.
getProductAttributeIDs
Get the IDs for related attributes.
getProductChildIDs
Get all product IDs that are children of this product.
getWebsiteWidgetData
Get all website widget data for the requested products.
getEmailTemplateData
Get all data for related email templates.
getEmailTemplateIDs
Get the IDs for related email templates.
getEmailActionGroupData
Get all data for related email action groups.
getEmailActionGroupIDs
Get the IDs for related email action groups.
getCouponData
Get all data for related coupons.
getCouponIDs
Get all data for related preapplied coupons.
getAllOrderFormItemData
Get data for related order form items with in-line order form data.
getOrderFormItemData
Get data for related order form items.
getOrderFormItemIDs
Get the IDs for related order form items
getOrderFormData
Get data for related order forms. That is, order forms with order form items which refer to this product.
getOrderFormIDs
Get IDs for related order forms.
getProductAddonGroupData
Get data for related product addon groups.
getProductAddonGroupIDs
Get IDs for related product addon groups.
getProductVariantData
Get data for related product variants.
getProductVariantIDs
Get IDs for related product variants.
getProductVariantPriceData
Get data for related product variant prices.
getproductVariantPriceIDs
Get IDs for related product variant prices.
getProductGroupData
Get all data for the product groups tied to this product.
getTLDData
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
Get all TLD IDs that are really related to the product.
getCycleData
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
Get all cycle IDs that are really related to the product.
getServerGroupData
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
Get all server group IDs that are really related to the product.
getTLDGhostData
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
Get all TLD IDs that are imaginarily related to the product.
getCycleGhostData
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
Get all cycle IDs that are imaginarily related to the product.
getServerGroupGhostData
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
Get all server group IDs that are imaginarily related to the product.
getVendorData
Get all vendor related data for this product.
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
Contains any results.
products
Contains all product results.
product
Contains all results for a single product. Occurs header numResults times.
productID
The ID of the product.
productName
The product name for the order form. Names need not be unique. Operations are performed on IDs. Names are merely for display.
productType
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
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
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
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
The number of cycles for which to bill.
0: Bill forever. 1: Bill one time only. The Stop in the name is counter-intuitive. Please ignore it.
productDateCreated
The Unix timestamp of when the product was created.
notifyAdminGroupID
The admin group ID to CC emails to during product events.
productAddons
Contains product add-ons
productAddon
Contains a single product add-on. May occur multiple times.
productAddonID
The ID of this add-on.
productAddonName
The name of this add-on.
stepID
If a step ID is associated with this add-on, it occurs here.
serverGroupID
If a server group ID is associated with this add-on, it occurs here.
productAddonActive
Whether the add-on is active.
productAddonUpgrade
Whether the add-on is upgradable.
productAddonOrder
The order in which this add-on displays on the order form.
productAddons
Contains product add-on relations.
productAddon
Contains a single product add-on relation.
productAddonID
ID for the product add-on of this relation.
productAttributes
Contains product attributes.
productAttribute
Contains a single product attribute.
productAttributeID
ID for this product attribute.
serverGroupID
If this is a panel attribute, this will occur. ID of the server group which this attribute is for.
productAttributeName
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
The string value of the attribute.
productAttributeDateCreated
The Unix timestamp of when the attribute was created.
productAttributes
Contains product add-on relations.
productAttribute
Contains a single product attribute relation.
productAttributeID
ID of the product attribute of this relation.
productChildren
Contains product child relations.
productChild
Contains a single product child relation.
productChildID
The ID of a product which is a child product of this product.
emailTemplates
Contains email templates.
emailTemplate
Contains data for a single email template.
emailTplID
The ID of this template.
emailTplName
The Name of this template.
emailTplSubject
The email subject that will be used for this template.
emailTplBody
The full HTML of the email template with variables in the form {VARIABLE}.
emailTplTextBody
The full text of the email template with variables in the form {VARIABLE}.
localeLanguage
The 2 to 7 character ISO language code for this template.
localeCountryISO2
The 2 character ISO country code for this template.
emailActionGroupID
The email action group ID for this template. Email action groups are used to group templates that are identical except for varying locale.
emailActionGroupName
The email action group name.
emailTemplates
Contains email template relations.
emailTemplate
Contains a single email template relation.
emailTplID
The ID for the email template of this relation.
emailActionGroups
Contains email action group data.
emailActionGroup
Contains data for a single email action group.
emailActionGroupID
The email action group ID for this template. Email action groups are used to group templates that are identical except for varying locale.
emailActionGroupName
The email action group name.
emailActionGroups
Contains email action group relations.
emailActionGroup
Contains a single email action group relation.
emailActionGroupID
The ID for the email action group of this relation.
coupons
Contains coupon data.
coupon
Contains data for a single coupon.
couponID
ID of this coupon.
couponCode
The user designated code for this coupon. This is the string that a customer enters to redeem the coupon on the order form.
couponDiscount
The 2 decimal floating point value of the discount; either a percent or a unit of money, depending on the type.
couponType
The type of coupon.
0: Discount is a percent 1: Discount is a unit of money of the currency of the package couponComments
Comments describing the coupon.
couponActive
Whether the coupon is active.
couponDateCreated
Unix timestamp of when the coupon was created.
couponDateStarted
Unix timestamp of when the coupon period starts.
couponDateEnded
Unix timestamp of when the coupon period ends (expires).
couponCount
The number of times this coupon was used.
couponMaxCount
The maximum number of times this coupon may be used.
couponNewOnly
Whether only new clients may use this coupon.
couponNumCycles
The number of billing cycles to which this coupon's discount will be applied. 0 for forever.
coupons
Contains coupon relations.
coupon
Contains a single coupon relation.
couponID
The ID for the coupon of this relation.