Differences

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

--- api [2019/08/05 17:53] – flack
+++ api [2019/08/22 11:15] – flack
@@ Line 501: / Line 501: @@
 Mandatory fields:
-  * **mcule_ids**: List of mcule IDs of structures you want get a quote request for
+  * **mcule_ids**: List of mcule IDs of structures you want get a quote request for.
-  * **customer_first_name**: The customer's first name
+  * **customer_first_name**: The customer's first name.
-  * **customer_last_name**: The customer's last name
+  * **customer_last_name**: The customer's last name.
-  * **delivery_country**: ISO 3166-1 alpha-2 code of the delivery country
+  * **delivery_country**: ISO 3166-1 alpha-2 code of the delivery country.
 Optional fields:
-  * **amount**: Preferred amount per molecule (mg); default: 1
+  * **amount**: Preferred amount per molecule (mg). (default: 1)
-  * **min_amount**: Acceptable minimum amount (mg); default: 1
+  * **min_amount**: Acceptable minimum amount (mg). (default: 1)
+  * **target_volume**: The target volume (in ml), in case of solution based amount.
+  * **target_cc**: Target concentration (mM), in case of solution based amount.
+  * **extra_amount**: In case of solution based amount calculation, the extra amount can be specified here.
+  * **customer_email**: The customer's email address
+  * **delivery_time**: Delivery time limit (working days). Door-to-door delivery time. Only offer molecules that are available within the specified number of working days. You can specify null if you don't really care about delivery time. (default: 21)
+  * **purity**: Required minimum purity (%). (default: null)
+The **amount** or target concentration-volume pair (**target_volume** and **target_cc**) need to be specified.
+Advanced optional fields:
+  * **keep_original_salt_form**: If false (by default), allow Mcule to deliver an alternative salt form if the original is not available. (default: false)
+  * **keep_original_tautomer_form**: If false (by default), allow Mcule to deliver compounds drawn in alternative tautomer forms. Alternative tautomer forms are perceived by the system based on [[http://en.wikipedia.org/wiki/International_Chemical_Identifier|IUPAC InChI identifiers]]. (default: false)
+  * **keep_original_stereo_form**: If false (by default), allow Mcule to deliver compounds drawn in alternative stereochemical forms. (default: false)
+  * **deliver_multiple_salt_forms**: Deliver multiple salt forms or tautomers of the same compound. If alternative salt or tautomer forms are allowed to be selected, you can decide whether we should deliver you one or more of such equivalent structures. Equivalency is defined by the above options. (default: true)
 == Request: ===
@@ Line 556: / Line 571: @@
     "delivery_post_code": "",
     "delivery_time": 21,
-    "dmso_concentration": 20.0,
-    "dmso_max_volume": "0.85",
-    "dmso_min_purity": "99.5",
-    "empty_plate_columns": true,
     "end_date": null,
     "extra_amount": null,
-    "format": 0,
     "group": null,
     "id": 15029,
@@ Line 568: / Line 578: @@
     "keep_original_stereo_form": false,
     "keep_original_tautomer_form": false,
-    "max_combinations": 10000,
-    "max_time": 42,
     "min_amount": null,
-    "min_combinations": 137,
     "notes": "",
-    "original": null,
-    "package_consolidation": true,
-    "plate_source": null,
-    "plate_type": "",
-    "priority_cutoff": null,
     "promo_code": "",
     "purity": null,
-    "quote_staff_options": false,
-    "recalc_type": null,
-    "recalc_value": null,
     "site_url": "https://mcule.com/quote/query/15029/",
     "start_date": null,
@@ Line 598: / Line 597: @@
 Available soon...
-Since generating a quote request can take some time it is an asynchronous process. You can query the status of a quote request by calling the detail API endpoint of the quote request. It is returned in the **api_url** field when you create the quote request. You can also use the **id** field to construct the API call. YOu can check the **state** field of the response whether the async quote request processing is finished.
+Since generating a quote request can take some time it is an asynchronous process. You can query the status of a quote request by calling the detail API endpoint of the quote request. It is returned in the **api_url** field when you create the quote request. You can also use the **id** field to construct the API call. You can check the **state** field of the response whether the async quote request processing is finished.
 States:
@@ Line 618: / Line 617: @@
 Accept-Encoding: gzip, deflate
 Authorization: Token <your_token>
+</code>
 == Response: ===
@@ Line 643: / Line 643: @@
     "delivery_post_code": "",
     "delivery_time": 21,
-    "dmso_concentration": 20.0,
-    "dmso_max_volume": "0.85",
-    "dmso_min_purity": "99.5",
-    "empty_plate_columns": true,
     "end_date": "2019-08-05T19:22:13.109267",
     "extra_amount": null,
-    "format": 0,
     "group": {
         "created": "2019-08-05T19:22:13.063732",
@@ Line 794: / Line 789: @@
     "keep_original_stereo_form": false,
     "keep_original_tautomer_form": false,
-    "max_combinations": 10000,
-    "max_time": 42,
     "min_amount": null,
-    "min_combinations": 137,
     "notes": "",
-    "original": null,
-    "package_consolidation": true,
-    "plate_source": null,
-    "plate_type": "",
-    "priority_cutoff": null,
     "promo_code": "",
     "purity": null,
-    "quote_staff_options": false,
-    "recalc_type": null,
-    "recalc_value": null,
     "site_url": "https://mcule.com/quote/query/15029/",
     "start_date": "2019-08-05T19:21:55.430800",
@@ Line 819: / Line 803: @@
 </code>
-As you can see from the result we could generate 3 different quotes for the query. A "Best price" quote, a "Fastest delivery" quote and a "Special offer" quote.
+Check for the **group** field. If it is not null, we could generate some quotes for your quote query. As you can see from the above result, we could generate 3 different quotes for the quote query. A "Best price" quote, a "Fastest delivery" quote and a "Special offer" quote.
 ===== Quote API  =====
@@ Line 1041: / Line 1025: @@
         "delivery_post_code": "",
         "delivery_time": 21,
-        "dmso_concentration": 20.0,
-        "dmso_max_volume": "0.85",
-        "dmso_min_purity": "99.5",
-        "empty_plate_columns": true,
         "end_date": "2019-08-05T19:22:13.109267",
         "extra_amount": null,
-        "format": 0,
         "group": 11647,
         "id": 15029,
@@ Line 1053: / Line 1032: @@
         "keep_original_stereo_form": false,
         "keep_original_tautomer_form": false,
-        "max_combinations": 10000,
-        "max_time": 42,
         "min_amount": null,
-        "min_combinations": 137,
         "notes": "",
-        "original": null,
-        "package_consolidation": true,
-        "plate_source": null,
-        "plate_type": "",
-        "priority_cutoff": null,
         "promo_code": "",
         "purity": null,
-        "quote_staff_options": false,
-        "recalc_type": null,
-        "recalc_value": null,
         "site_url": "https://mcule.com/quote/query/15029/",
         "start_date": "2019-08-05T19:21:55.430800",