Versions Compared
| Version | Old Version 2 | New Version 3 |
|---|---|---|
| Changes made by | ||
| Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Excerpt |
|---|
On this page, you can find an introduction to all the Asset Management Endpoints of the API V.3 that are available to White-Label Resellers (Free Edition & Standard Edition). You will also find explanations for each Asset Management Endpoint. |
| Rw ui textbox macro |
| type |
|---|
| Note |
Please Note That the The Asset Management Endpoints Found found on this Page page are Applicable Only applicable only to White-Label Resellers (Free Edition & Standard Edition) and Depend depend on the Edition of the Resellerreseller’s edition. |
Asset Management Endpoints for White-Label Resellers
| Status | ||||
|---|---|---|---|---|
|
In the The following bullet points , you can find show the available Asset Management Endpoints for the Free & Standard Edition Resellers.The following endpoint can be used to retrieve
GET /api/assets - Retrieves information from all the assets
GET /api/assets/{assetId} - Retrieves all the assets.
information from a specific asset
based on the given ID.
GET / api/assets/{assetId}/pricing info - Retrieves the pricing info of a specific asset based on the given ID.
| Info |
|---|
The query parameter assetId reflects the specific ID of the asset. |
| Tip |
|---|
In future releases, more asset endpoints will become available! |
Pricing Info - Response Fields
After sending out a request to get the pricing info, the Administrator Response will include the following information:
Name | Description |
|---|---|
unit.id | The asset's unit ID. |
unit.name | The asset's unit name. |
unitPrice.value | The asset's unit price. |
unitPrice.isUserDefined | Is |
pricelist.id | The asset's pricelist ID. |
pricelist.name | The asset's pricelist name. |
volumeDiscount.id | The asset's volume discount ID. |
volumeDiscount.name | The asset's volume discount name. |
discount.value | The asset's discount. |
discount.type | The asset's discount type. |
discount.isUserDefined | Is |
promotion.id | The asset's promotion ID. |
promotion.name | The asset's promotion name. |
promotion.discount.value | The asset's promotion discount. |
promotion.discount.type | The asset's promotion discount type. |
promotion.endDate | The asset's promotion displayed end date. |
finalUnitPrice | The asset's final unit price. |
Administrator Response (only)
Schema
| Code Block |
|---|
{
"unit": {
"id": "Guid",
"name": "string"
},
"unitPrice": {
"value": "decimal",
"isUserDefined": "boolean"
},
"priceList": {
"id": "int",
"name": "string"
},
"volumeDiscount": {
"id": "int",
"name": "string"
},
"discount": {
"value": "decimal",
"type": "string",
"isUserDefined": "boolean"
},
"promotion": {
"id": "string",
"name": "string",
"discount": {
"value": "decimal",
"type": "string"
},
"endDate": "dateTime"
},
"finalUnitPrice": "decimal",
} |
Example
| Code Block |
|---|
{
"unit": {
"id": "Guid",
"name": "string"
},
"unitPrice": {
"value": "decimal",
"isUserDefined": "boolean"
},
"priceList": {
"id": "int",
"name": "string"
},
"volumeDiscount": {
"id": "int",
"name": "string"
},
"discount": {
"value": "decimal",
"type": "string",
"isUserDefined": "boolean"
},
"promotion": {
"id": "string",
"name": "string",
"discount": {
"value": "decimal",
"type": "string"
},
"endDate": "dateTime"
},
"finalUnitPrice": "decimal",
} |
Table of Contents
| Table of Contents | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|