Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

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). Each endpoint is explained to help you understand its functionality.

The Asset Management Endpoints listed here are exclusively for White-Label Resellers (Free Edition & Standard Edition) and depend on the reseller’s edition.

Asset Management Endpoints for White-Label Resellers 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.

 Pricing Info Response Fields

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

The query parameter assetId reflects the unique identifier of the asset.

In future releases, more asset endpoints will become available!

Table of Contents


  • No labels