User Tools

Site Tools


ultimate-api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
ultimate-api [2020/07/20 16:57]
flack [Quote API]
ultimate-api [2020/12/07 15:54] (current)
flack
Line 225: Line 225:
 </​code>​ </​code>​
  
-In case of similarity searches the **tan** value contains the similarity value.+In case of similarity searches the **tan** value the response ​contains the similarity value. 
 + 
 +In case of similarity searches you can control the minimum similarity with the **sim_threshold** param. Its default ​ value is 0.7. Its minimum value is also 0.7 unless you are allowed to use a lower value. For example: 
 +<​code>​ 
 +
 +    "​query":​ { 
 +        "​type":​ "​sim",​ 
 +        "​query":​ "​C(N1C(C(OC2CCCN(C3=CC=CC=C3)C2)=O)CN(C)C1=O)(=O)C(=C)CN1CCOCC1",​ 
 +        "​limit":​ 5, 
 +        "​sim_threshold":​ 0.8 
 +    } 
 +
 +</​code>​
  
  
Line 321: Line 333:
 == Example API request: == == Example API request: ==
 <​code>​ <​code>​
-echo '​{"​compounds":​ ["​VKCCTPSYCYARFI-UHFFFAOYSA-N",​ "​DVPXLZBGJCHMEO-UHFFFAOYSA-N",​ "​XKJIOIJSLLCDOZ-UHFFFAOYSA-N",​ "​XVWBPPRZAKJXSY-UHFFFAOYSA-N",​ "​ZNOWNQHKOHUYLP-UHFFFAOYSA-N",​ "​IEJBADVRNXRNLB-UHFFFAOYSA-N",​ "​LZRUMHHZJMDZLR-UHFFFAOYSA-N",​ "​PTKVKZOBUQFOJX-UHFFFAOYSA-N",​ "​LFHNTOJEMXUDKP-UHFFFAOYSA-N",​ "​SICGQCSMIMRHLF-UHFFFAOYSA-N",​ "​YGLRUSPDEQEHKM-UHFFFAOYSA-N"​],​ "​amount":​ 1, "​currency":"​USD",​ individual":​ true}' | http https://​ultimateapp.mcule.com/​api/​v1/​pricing/​ --print HBhb+echo '​{"​compounds":​ ["​VKCCTPSYCYARFI-UHFFFAOYSA-N",​ "​DVPXLZBGJCHMEO-UHFFFAOYSA-N",​ "​XKJIOIJSLLCDOZ-UHFFFAOYSA-N",​ "​XVWBPPRZAKJXSY-UHFFFAOYSA-N",​ "​ZNOWNQHKOHUYLP-UHFFFAOYSA-N",​ "​IEJBADVRNXRNLB-UHFFFAOYSA-N",​ "​LZRUMHHZJMDZLR-UHFFFAOYSA-N",​ "​PTKVKZOBUQFOJX-UHFFFAOYSA-N",​ "​LFHNTOJEMXUDKP-UHFFFAOYSA-N",​ "​SICGQCSMIMRHLF-UHFFFAOYSA-N",​ "​YGLRUSPDEQEHKM-UHFFFAOYSA-N"​],​ "​amount":​ 1, "​currency":"​USD", ​"individual":​ true}' | http https://​ultimateapp.mcule.com/​api/​v1/​pricing/​ --print HBhb
 </​code>​ </​code>​
  
Line 941: Line 953:
   * **avg_product_price_currency**:​ Currency of average product price   * **avg_product_price_currency**:​ Currency of average product price
   * **coverage_percent**:​ How many of the query molecules appear in the quote. E.g. if your query contains 10 molecules and you get a quote for 9, it is 90%.   * **coverage_percent**:​ How many of the query molecules appear in the quote. E.g. if your query contains 10 molecules and you get a quote for 9, it is 90%.
-  * **created**: The creation datetime of the quote.+  * **created_at**: The creation datetime of the quote.
   * **id**: The ID of the Instant Quote.   * **id**: The ID of the Instant Quote.
   * **items**: list of product level data   * **items**: list of product level data
Line 959: Line 971:
   * **reformatting_price**:​ Reformatting price (USD)   * **reformatting_price**:​ Reformatting price (USD)
   * **reformatting_price_currency**:​ Currency of reformatting price   * **reformatting_price_currency**:​ Currency of reformatting price
 +  * **selection_criteria**:​ Selection criteria code of the quote.
 +  * **selection_criteria_display**:​ Human readable selection criteria of the quote.
   * **shipping_price**:​ Shipping & handling cost   * **shipping_price**:​ Shipping & handling cost
   * **shipping_price_currency**:​ Currency of Shipping & handling cost   * **shipping_price_currency**:​ Currency of Shipping & handling cost
   * **state**: State code of the quote.   * **state**: State code of the quote.
   * **state_display**:​ Human readable state of the quote.   * **state_display**:​ Human readable state of the quote.
-  ​* **total_cost**:​ Total cost (USD) +  * **total_discount_price**:​ Total discount price 
-  * **total_cost_without_discount**:​ Total cost without discount (USD) +  * **total_discount_price_currency**: Currency ​of total discount price
-  ​* **total_discount_price**:​ Total discount price (USD) +
-  * **selection_criteria**: Selection criteria code of the quote. +
-  * **selection_criteria_display**:​ Human readable selection criteria of the quote.+
   * **total_price**:​ Total price of quote   * **total_price**:​ Total price of quote
   * **total_price_currency**:​ Currency of the total price   * **total_price_currency**:​ Currency of the total price
ultimate-api.1595257039.txt.gz · Last modified: 2020/07/20 16:57 by flack