Synchronization of service plan fees is the next step after the fees were updated at the highest level of the sales channel hierarchy.
In this document:
There are at least two cases when the synchronization of the delegated service plans is required:
The synchronize
REST operation is similar to the corresponding synchronize operation in the BSS control panel:
A explained in the Customization for Sales Channels document, a typical process of creating resellers consists of the following steps:
In the OSS PCP, create a branding service template containing reseller specific resources:
Navigate to Products > Service Templates and click Add New Service Template.
In the Name field, enter a name, for example, “L1 Reseller Resources”, and then click Next.
Select at least the following resources usually necessary to a reseller:
Click Next.
Do not change the limits in this demo and click Next.
In the final step, click Finish.
You have a new branding ST in OSS.
In the BSS PCP, create a new ST that (along with the SP considered later) that will allow the provider to create resellers and then to delegate service plans to resellers.
Navigate to Products > Service Plans and on the Service Template tab, click Add New Service Template.
Select the Resellers Management gate and then click Next.
Fill out the form with ST properties:
Click Save.
You have a new L1 reseller ST for managing resellers through the BSS reseller gateway.
In the BSS PCP, create a new SP needed to create reseller subscriptions that define the reseller status. A reseller is active until their reseller subscription is active.
Open the L1 reseller ST you have created in the previous section.
On the Plans tab, click Add New Service Plan.
Fill in the necessary properties:
Click Next.
In the list of subscription periods, select 1 Year and click Next.
In the next screen, click Finish.
To activate the new SP, first create a sales category for it:
Navigate to Products > Service Plans and on the Sales Categories tab, click Add Sales Category.
Fill out the open form:
Click Save.
Open the newly created sales category and on the Service Plans tab, bind it to the new L1 reseller SP.
You have a new L1 reseller SP to be used to assign the reseller status to accounts by subscribing those accounts to the SP.
In this step, you will create a new account and subscribe it to the L1 reseller SP to assign the reseller status to the account.
Now you have a new active reseller. Find out the respective APS resource by sending a request similar to the following:
GET /aps/2/resources/0ab950d1-abc9-4433-a87d-8ba009bf4bce/accounts
The response will contain the list of all L1 resellers. The aps.id
property is the APS ID of
the APS resource, for example:
HTTP/1.1 200 OK
[
{
"aps": {
"type": "http://parallels.com/aps/types/pa/account/1.3",
"id": "c5859e80-2db0-492a-af9f-425e1eccc5be",
"status": "aps:ready",
"revision": 3,
"modified": "2017-08-11T07:14:45Z"
},
...
},
...
]
Now you have a new active reseller and you know the APS ID of the respective APS resource.
Use the L1 reseller ST to delegate service plans to resellers.
You have delegated SPs that you will make available to resellers in the next step.
Since the SPs were delegated after the creation of the resellers, the latter cannot see those SPs yet. Verify if the list of plans is empty for the reseller by navigating in BSS RCP to Products > Service Plans.
You can synchronize the delegated SPs with resellers by the respective REST request. In the following synchronize REST request, use vendor APS ID:
POST /aps/2/services/sku-manager/vendor/0ab950d1-abc9-4433-a87d-8ba009bf4bce/synchronize
In case of success, the response will be:
HTTP/1.1 204 No Content
Verify that this time the list of plans is not empty for the reseller by navigating in BSS RCP to Products > Service Plans.
Any time the management system needs to update the fees throughout the sales channels, it can first
update the prices at the highest level using the updateRates
operation and then sync the fees by
calling the synchronize
operation.
Update the prices as explained in the Update Specified Fees section:
PUT /aps/2/services/sku-manager/vendor/0ab950d1-abc9-4433-a87d-8ba009bf4bce/rates
[ {<SKU-1>}, ... {<SKU-N>} ]
Sync the updates with resellers as explained in the Synchronize Delegated Plans with Resellers section:
POST /aps/2/services/sku-manager/vendor/0ab950d1-abc9-4433-a87d-8ba009bf4bce/synchronize
On completion of the last operation, the updated fees will be synced throughout the sales channels of the specified vendor.
This step demonstrated a typical scenario of creating sales channels, propagating the delegated service plans and updating the fees throughout the sales channels of the specified vendor.