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.

The Asset Management Endpoints found on this page are applicable only to White-Label Resellers (Free Edition & Standard Edition) and depend on the reseller’s edition.

Asset Management Endpoints for White-Label Resellers FREE & STANDARD

The following bullet points show the available Asset Management Endpoints for the Free & Standard Edition Resellers.

GET /api/assets - Retrieves information from all the assets
GET /api/assets/{assetId} - Retrieves 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.

The query parameter assetId reflects the specific ID of the asset.

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 `true` when the asset's unit price is defined by the user.
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 `true` when the asset's discount is defined by the user.
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

{
  "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

{
  "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",
}

Managing Assets via API for White-Label Resellers

Asset Management Endpoints for White-Label Resellers FREE & STANDARD

Pricing Info - Response Fields

Administrator Response (only)

Schema

Example

Table of Contents