GetBasketPrices_API

Syntax

ListResult BM::GetBasketPrices_API(

  Int VendorAccountID;

  Int ProvisioningItemsCounter;

  Str ProvisioningItem_0;

  …

  Str ProvisioningItem_N;

  Int ProvisioningDataSlotCounter;

  Int ProvisioningItemID_0;

  	Int ProvisioningParametersCounter;

  		Str ProvisioningParameter_0;

  		…

  		Str ProvisioningParameter_N;

  …

  Int ProvisioningItemID_N;

  	Int ProvisioningParametersCounter;

  		Str ProvisioningParameter_0;

  		…

  		Str ProvisioningParameter_N;

  Int ContactDataCounter;

  Str ContactDataSlot_0;

  …

  Str ContactDataSlot_N;

  Str PromoCodeID.

)

returns

  Int LineID – ID of basket line;

  Double Discount – line discount sum;

  Double ExtendedPrice –line total sum;

  Double TotalTax – line tax total (included tax + extra tax). Returned in the LineID=-1;

  Double ExtraTax – extra tax sum (taxes not included into price). Returned in the LineID=-1;

  Double SetupPrice – line setup fee.

Special Notes

• Int VendorAccountID – vendor account ID;
• Int ProvisioningItemsCounter - number of provisioning items in order. One order item is created for each service plan / additional resource ordered.
• Str ProvisioningItem_N – definition of provisioning item #N in specific format. Provisioning Item is submitted as a string of one of the following formats:

  <PlanID>=<PlanPeriodID>=<ProvisioningItemID>=<ParentItemID>

  or

  <ResourceRateID>=<PlanPeriodID>=<ProvisioningItemID>=<ParentItemID>=<Amount>=RESOURCE

  Where:

  • <PlanID> is an ID of ordered service plan;
  • <ResourceRateID> is an ID of service plan resource rate for ordered resource;
  • <PlanPeriodID> is an ID of service plan subscription period;
  • <ProvisioningItemID> is an arbitrary positive unique ID of the provisioning Item inside the order;
  • <ParentItemID> is an identifier of parent provisioning item. Parent provisioning items usually need to be specified for domain provisioning item. ID of hosting provisioning item serves as parent item ID in this case. Pass '-1' for other order item types (hosting service plan, resources);
  • <Amount> is amount of resource ordered (integer);
• Int ProvisioningDataSlotCounter - number of total data slots in provisioning parameters section of order. Takes into account all values passed up to the ContactDataCounter;
• Int ProvisioningItemID_N - ID of provisioning item #N which the following provisioning parameters are associated with.
• Int ProvisioningParametersCounter - number of provisioning parameters associated with current provisioning item;
• Str ProvisioningParameter_N - provisioning parameter #N of order item #N. Provisioning parameter is an info required to deliver a service. For example, it is domain name in case of ordering domain name, or size in case of ordering shoes. Provisioning parameter is submitted as a string of the following format:

  <ParameterName>=<ParameterValue>

  Where:

  • <ParameterName> is a name of the parameter defined under Required Parameters tab of respective service template;
  • <ParameterValue> is a value of the parameter;
• Int ContactDataCounter - number of contact data slots;
• Str ContactDataSlot_N - data slot #N of contact information on customer placing the order. Identifies customer account on behalf of which the order is placed. Contact data are submitted as strings of the following format:

  <ContactDataSlotName>=<ContactDataSlotValue>

  Where:

  • <ContactDataSlotName> is a name of the Contact Data slot;
  • <ContactDataSlotValue> is a value of the Contact Data slot;

  PBA accepts the following list of Contact Data slot names:

  • LoginID – customer's login to CP;
  • AccountID – ID of customer's account;
• Str PromoCodeID - promotion code applied to the order, passed as PromoCodeID=promocode.

Please send us your feedback on this help page