Should the product support addons, an addon can be created. Note that the product identifier is necessary to initiate this process to create the addon under the right product.
NOTE! Creating products addons can be done through the Cloudmore user interface or API. This guide will focus on API usage.
API Details
| SellerServiceProductAddons | |||
| Operation | Swagger Description | Method | API |
| Create an Addon | Creates new product addon for Seller service | POST | /api/sellers/{sellerId}/services/{serviceId}/products/{productId}/addons |
| Retrieve an Addons | Returns seller service product addon | GET | /api/sellers/{sellerId}/services/{serviceId}/products/{productId}/addons/{id} |
| Retrieve All Addons | Returns all seller service product addons | GET | /api/sellers/{sellerId}/services/{serviceId}/products/{productId}/addons |
| Update an Addon | Updates Seller service product addon | PUT | /api/sellers/{sellerId}/services/{serviceId}/products/{productId}/addons/{id} |
| Delete an Addon | Deletes Seller service product addon | DELETE | /api/sellers/{sellerId}/services/{serviceId}/products/{productId}/addons/{id} |
| Other | |||
| Retrieve Products | Returns all seller service products | GET | /api/sellers/{sellerId}/services/{serviceId}/products |
API Calls
Retrieve a Product
| Retrieve a Product | |
|---|---|
| End Point | /api/sellers/{sellerId}/services/{serviceId}/products |
| HTTP Method | GET |
| Request Body | [ { "id": "b5861376-08af-48c5-acbf-ef935b0d9c74", "name": "Google Workspace (pay as you go)", "description": "Add and delete users at any time. You will be billed at the end of the month for the actual number of accounts in service during the month.", "itemCode": "payg" } ] |
| Successful Example Response | 201 |
| Error Example Response | 404 |
Create Addon
| Creates new product addon for Seller service. | |
|---|---|
| End Point | /api/sellers/{sellerId}/services/{serviceId}/products/{productId}/addons |
| HTTP Method | POST |
| Request Body | { "name": "Google Workspace Business Standard", "itemCode": "SkYiNEdAxQfMSL", "enableGrouping": true, "groupName": "payg", "price": 10, "cost": 5, "recommendedPrice": 15, "pricePer": "Metered", "hideFromSubscriptionView": false, "hideFromPriceList": false } |
| Successful Example Response | 201 |
| Error Example Response | 400{ "Name": [ "The Name field is required." ], "ItemCode": [ "The ItemCode field is required." ] } |
Field Definitions
| Field | Description |
| name* | The name of the addon. |
| itemCode* | A unique code for the addon. Also known as SKU (Stock Keeping Unit). |
| enableGrouping | Does the addon allow grouping of addons. |
| groupName | If grouping is enabled the name of the group name should be specified. |
| price | The price for broker. |
| cost | The cost for the seller. |
| recommendedPrice | The price, which is suggested for brokers to use when they sell to organizations. |
| pricePer | For what the price is charged for – Subscription – Quantity – Selected – Metered For products with a type of ProductBased the following options are available – Subscription – Quantity – Selected For products with a type of Metered the following options are available – Metered |
| hideFromSubscriptionView | Defines if the addon is displayed or hidden from subscription view. |
| hideFromPriceList | Defines if addon is displayed or hidden from price list. |