Versions Compared

Version Old Version 3 New Version 4
Changes made by

Niki Rousaki

Niki Rousaki

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

Note

The Asset Management Endpoints found on this page are applicable only to 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
Status
colourBlue
titleFREE & STANDARD

The following bullet points show Below are the available Asset Management Endpoints for the 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.

Info

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

Tip

In future releases, more asset endpoints will become available!

Pricing Info -
Expand
titlePricing Info Response Fields

After

sending out

submitting a request to

get the

retrieve pricing

info

information, the

Administrator Response

response will include the following

information when the asset's

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

Is true when the asset's

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

Is true

Indicates whether the discount is

defined by the user

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

asset's

final unit price

.

Administrator Response (only)

Schema

of the asset after all discounts and promotions.

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

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", }
 Info
The query parameter assetId reflects the unique identifier of the asset.
 Tip
In future releases, more asset endpoints will become available!
Table of Contents
 Table of Contents
maxLevel6
minLevel1
include
outlinefalse
indent
excludeTable of Contents
stylenone
typelist
printabletrue
class