Mobile API Documentation

Price Report Calculator API

Overview: Price of specific price from IDEX Online Price Report

Input Parameters

Parameter Description
session_code String, as received from login API.
shape_type_id Integer, 1 = Rounds, 2 = Fancies.
carat_weight Decimal, must be between 0.18 and 5.99 carats.
color_id Integer
clarity_id Integer

Sample Request

HTTP JSON
Endpoint: https://mobapi.idexonline.com/pricereport/api/v2.0/pricereportcalculator
{
  "session_code": "MOB_20240523065727_1u1FnnB6vyD5MI6adfUa8b",
  "shape_type_id": 1,
  "carat_weight": 1.23,
  "color_id": 3,
  "clarity_id": 6
}


Sample Response

JSON Data with HTTP Code 200
If all goes well, the response will be an HTTP 200 code and the response_code in the JSON will be 0.
{
  "result_info": {
	"response_code": 0,
	"response_description": ""
  },
  "results": {
	"price_report_item": {
	  "shape_type": "Rounds",
	  "carat_weight_group_id": 10,
	  "min_weight": 1,
	  "max_weight": 1.24,
	  "color": "F",
	  "clarity": "VVS2",
	  "price": 8400,
	  "specific_weight": 1.23,
	  "specific_price_per_carat": 8400,
	  "specific_price_total": 10332
	}
  }
}
		

Calculate discount from your price

& vice versa
The Price Report Price you got from the JSON above. E.g. 8400. This is price per carat, and so is 'your price'

To calculate discount from your price:
(Your price - price list) / price list
Example: your price is 7500 ($/ct), price list is 8400 ($/ct): discount is -10.7%.

To calculate price from discount:
price list - ((discount / 100) * price list)
Example: your discount is -20, price list is 8400 ($/ct), your price is: 6720 ($/ct)


Test the API


Generate JSON Request



POST






© IDEX Online 2024   -   www.idexonline.com