Asset Management Endpoints for White-Label Resellers

Status
colour Blue title FREE & STANDARD

Below are the available Asset Management Endpoints for Free and 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.

After submitting a request to retrieve pricing information, the response will include the following details:

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

Indicates whether the unit price is defined by the user (true or false).

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

Indicates whether the discount is user-defined (true or false).

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 final unit price of the asset after all discounts and promotions.

The response is returned in JSON format and follows the schema below:

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