|
|
|
|
|
|
Parameters |
|
Description |
Passed |
Returned |
Method functionality:
The main purpose of this method is to provide a single-point functionality for PBA online store. Note: 'CreateAccounAndPlaceOrder_API'; 'CreateAccountAndPlaceOrder_API'; 'PlaceOrderForAccount'; methods used in previous PBA versions can still be used. Their definitions coincide with currently used method.
|
Depends on order structure |
12 |
Syntax
ItemResult BM::PlaceOrderAndAuthorize_API(
Int VendorAccountID;
Int ProvisioningItemsCounter;
Str ProvisioningItem;
Int ProvisioningDataSlotCounter;
{
Int ProvisioningItemID_1;
Int ProvisioningParametersCounter;
{
Str ProvisioningParameter1;
...
Str ProvisioningParameterN;
}
...
Int ProvisioningItemID_N;
Int ProvisioningParametersCounter;
{
Str ProvisioningParameter1;
...
Str ProvisioningParameterN;
}
}
Int ContactDataCounter;
{
Str ContactDataSlot_1;
...
Str ContactDataSlot_N;
}
Int PayToolCounter;
{
Str PayToolSlot_1;
...
Str PayToolSlot_N;
}
Int AdditionalContactsDataCounter;
{
Int AdditionalContactID_1.
{
Int NumberOfParametersInContact;
Str ContactInfoSlot1;
...
Str ContactInfoSlotN;
}
...
Int AdditionalContactID_N;
{
Int NumberOfParametersInContact;
Str ContactInfoSlot1;
...
Str ContactInfoSlotN.
}
}
)
returns
Int AccountID - ID of newly created customer's account;
Int OrderID - ID of newly created sales order (do not mix with order number);
Str(64) Login - login to Control Panel for the newly created customer;
Str(40) CreationTimeStr - order creation time;
Int DocID - ID of payment created to pay the order;
Double Total - order total, without taxes and discount amounts;
Double TaxTotal - total of taxes;
Double DiscTotal - total of discount applied to the order;
Double MerchTotal - order total, including taxes and discount amount;
Str(4096) Descr - order description;
Str(10) OrderNbr - order number;
Str(1024) RedirectURL - URL to processing center where the order can be paid (empty for all but external redirect payments).
Special Notes:
Special notes are presented in the following subsections. Information is divided by type of method data slots: provisioning items, provisioning parameters, contact data, pay tool data and additional contacts data. Each section contains examples. Examples can be used to construct method calls for different purposes.
The whole method call examples are presented in the following subsections:
Example 1 - creating account with payment method and placing order on domain registration to existing hosting subscription;
Example 2 - creating account and placing order for hosting services and domain registration;
Example 3 - placing order for existing customer account on hosting services and additional resource. Customer has registered credit card.
The example of method response is presented in the Example 3 subsection as it the same for all requests.