Differences

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

--- api [2017/12/05 23:34] – flack
+++ api [2019/08/05 17:47] – flack
@@ Line 40: / Line 40: @@
 Content-Type: application/json
-[
+{
-    {
+    "count": 2,
-        "description": "All purchasable, in stock & virtual compounds",
+    "next": null,
-        "entry_count": 35772718,
+    "previous": null,
-        "files": [
+    "results": [
-            {
+        {
-                "download_url": "https://mcule.s3.amazonaws.com/database/mcule_purchasable_full_170918.sdf.gz",
+            "description": "All purchasable, in stock & virtual compounds",
-                "file_type": "sdf.gz",
+            "entry_count": 35772718,
-                "file_type_display": "2D SDF (sdf.gz)",
+            "files": [
-                "size_mb": 5762
+                {
-            },
+                    "download_url": "https://mcule.s3.amazonaws.com/database/mcule_purchasable_full_170918.sdf.gz",
-            {
+                    "file_type": "sdf.gz",
-                "download_url": "https://mcule.s3.amazonaws.com/database/mcule_purchasable_full_170918.smiles.gz",
+                    "file_type_display": "2D SDF (sdf.gz)",
-                "file_type": "smiles.gz",
+                    "size_mb": 5762
-                "file_type_display": "SMILES (smi.gz)",
+                },
-                "size_mb": 462
+                {
-            }
+                    "download_url": "https://mcule.s3.amazonaws.com/database/mcule_purchasable_full_170918.smiles.gz",
-        ],
+                    "file_type": "smiles.gz",
-        "last_updated": "2017-09-18",
+                    "file_type_display": "SMILES (smi.gz)",
-        "name": "Mcule Purchasable (full)"
+                    "size_mb": 462
-    },
+                }
-    {
+            ],
-        "description": "All purchasable, in stock compounds",
+            "last_updated": "2017-09-18",
-        "entry_count": 5648837,
+            "name": "Mcule Purchasable (full)"
-        "files": [
+        },
-            {
+        {
-                "download_url": "https://mcule.s3.amazonaws.com/database/mcule_purchasable_in_stock_170918.sdf.gz",
+            "description": "All purchasable, in stock compounds",
-                "file_type": "sdf.gz",
+            "entry_count": 5648837,
-                "file_type_display": "2D SDF (sdf.gz)",
+            "files": [
-                "size_mb": 1311
+                {
-            },
+                    "download_url": "https://mcule.s3.amazonaws.com/database/mcule_purchasable_in_stock_170918.sdf.gz",
-            {
+                    "file_type": "sdf.gz",
-                "download_url": "https://mcule.s3.amazonaws.com/database/mcule_purchasable_in_stock_170918.smiles.gz",
+                    "file_type_display": "2D SDF (sdf.gz)",
-                "file_type": "smiles.gz",
+                    "size_mb": 1311
-                "file_type_display": "SMILES (smi.gz)",
+                },
-                "size_mb": 84
+                {
-            }
+                    "download_url": "https://mcule.s3.amazonaws.com/database/mcule_purchasable_in_stock_170918.smiles.gz",
-        ],
+                    "file_type": "smiles.gz",
-        "last_updated": "2017-09-18",
+                    "file_type_display": "SMILES (smi.gz)",
-        "name": "Mcule Purchasable (in stock)"
+                    "size_mb": 84
-    },
+                }
-]
+            ],
+            "last_updated": "2017-09-18",
+            "name": "Mcule Purchasable (in stock)"
+        }
+    ]
+}
 </code>
@@ Line 481: / Line 486: @@
 }
 </code>
+===== Quote Request API =====
+== Endpoint: ==
+<code>/iquote-queries/</code>
+== Example API request: ==
+<code>
+echo '{"customer_first_name": "John", "customer_last_name": "Doe", "delivery_country": "US", "mcule_ids": ["MCULE-2221628462", "MCULE-6824753328", "MCULE-1886826647", "MCULE-4609548851", "MCULE-7223347867"], "min_amount": null, "amount": 1}' | http https://mcule.com/api/v1/iquote-queries/ "Authorization: Token <your_token>" --print HBhb
+</code>
+Mandatory fields:
+  * **mcule_ids**: List of mcule IDs of structures you want get a quote request for
+  * **customer_first_name**: The customer's first name
+  * **customer_last_name**: The customer's last name
+  * **delivery_country**: ISO 3166-1 alpha-2 code of the delivery country
+Optional fields:
+  * **amount**: Preferred amount per molecule (mg); default: 1
+  * **min_amount**: Acceptable minimum amount (mg); default: 1
+== Request: ===
+<code>
+POST /api/v1/iquote-queries/ HTTP/1.1
+Accept: application/json, */*
+Accept-Encoding: gzip, deflate
+Authorization: Token <your_token>
+Content-Type: application/json
+{
+    "amount": 1,
+    "customer_first_name": "John",
+    "customer_last_name": "Doe",
+    "delivery_country": "US",
+    "mcule_ids": [
+        "MCULE-2221628462",
+        "MCULE-6824753328",
+        "MCULE-1886826647",
+        "MCULE-4609548851",
+        "MCULE-7223347867"
+    ],
+    "min_amount": null
+}
+</code>
+== Response: ===
+<code>
+HTTP/1.1 201 CREATED
+Allow: GET, POST, HEAD, OPTIONS
+Content-Type: application/json
+{
+    "amount": 1,
+    "api_url": "https://mcule.com/api/v1/iquote-queries/15029/",
+    "created": "2019-08-05T19:21:55.339011",
+    "customer_email": "",
+    "customer_first_name": "John",
+    "customer_last_name": "Doe",
+    "deliver_multiple_salt_forms": false,
+    "delivery_address": "",
+    "delivery_city": "",
+    "delivery_contact_person_email": "",
+    "delivery_contact_person_name": "",
+    "delivery_contact_person_phone": "",
+    "delivery_country": "US",
+    "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,
+    "keep_original_salt_form": false,
+    "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,
+    "state": 10,
+    "state_display": "Pending",
+    "target_cc": null,
+    "target_volume": null,
+    "user": 11
+}
+</code>
+===== Quote Request Status API =====
+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:
+  * **10 / Pending**: The quote query is queued but the processing has not started yet.
+  * **20 / Running**: The processing of the quote query is in progress.
+  * **30 / Done**: The processing of the quote query is finished. For one quote request query we might generate multiple quotes (this is what we call a group) or it is also possible that we could not generate any quotes for a particular quote request. If there are quotes they will appear under the **group** field where the **quotes** field contains a list of the generated quotes and some basic info about them. You can get detailed data of a particular quote by calling the endpoint specified in the **api_url** field.
+  * **40 / Error**: An error happened during the processing of the quote query.
+Following the above example where the ID of the quote request is //15029// we query the status of the quote request:
+<code>
+http https://mcule.com/api/v1/iquote-queries/15029/ "Authorization: Token <your_token>" --print HBhb
+</code>
+== Request: ===
+<code>
+GET /api/v1/iquote-queries/15029/ HTTP/1.1
+Accept: */*
+Accept-Encoding: gzip, deflate
+Authorization: Token <your_token>
+== Response: ===
+<code>
+HTTP/1.1 200 OK
+Allow: GET, HEAD, OPTIONS
+Connection: keep-alive
+Content-Encoding: gzip
+Content-Type: application/json
+{
+    "amount": 1,
+    "api_url": "https://mcule.com/api/v1/iquote-queries/15029/",
+    "created": "2019-08-05T19:21:55.339011",
+    "customer_email": "",
+    "customer_first_name": "John",
+    "customer_last_name": "Doe",
+    "deliver_multiple_salt_forms": false,
+    "delivery_address": "",
+    "delivery_city": "",
+    "delivery_contact_person_email": "",
+    "delivery_contact_person_name": "",
+    "delivery_contact_person_phone": "",
+    "delivery_country": "US",
+    "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",
+        "id": 11647,
+        "query": 15029,
+        "quotes": [
+            {
+                "active": true,
+                "analytical_services_price": "0.00",
+                "api_url": "https://mcule.com/api/v1/iquotes/15679/",
+                "avg_product_price": 80.75,
+                "coverage_percent": 80,
+                "created": "2019-08-05T19:22:13.099143",
+                "delivery_days": 11,
+                "delivery_price": "194.16",
+                "description": "",
+                "discount": 0,
+                "duplicate_count": 0,
+                "extra_handling_price": "0.00",
+                "group": 11647,
+                "id": 15679,
+                "is_expired": false,
+                "is_saved": false,
+                "missing": [
+                    346209969
+                ],
+                "name": "",
+                "order_data": null,
+                "payment_due_days": 30,
+                "po_number": null,
+                "price": "551.04",
+                "product_discount_price": "0.00",
+                "products_price": "323.00",
+                "reference_id_full": "I-15679",
+                "reformatting_price": "0.00",
+                "shipping_price": "33.88",
+                "site_url": "https://mcule.com/quote/I-15679/",
+                "special_formatting_price": null,
+                "state": 10,
+                "state_display": "Displayed",
+                "stock_with_amount_ratio": 0,
+                "suppliers_count": 2,
+                "total_cost": 551.04,
+                "total_cost_without_discount": 551.04,
+                "total_discount_price": "0.00",
+                "tracking": null,
+                "type": 30,
+                "type_display": "Special offer",
+                "updated": "2019-08-05T19:22:13.099155",
+                "valid_until": "2019-09-04T19:22:13.099"
+            },
+            {
+                "active": true,
+                "analytical_services_price": "0.00",
+                "api_url": "https://mcule.com/api/v1/iquotes/15678/",
+                "avg_product_price": 160.298,
+                "coverage_percent": 100,
+                "created": "2019-08-05T19:22:13.087753",
+                "delivery_days": 11,
+                "delivery_price": "339.47",
+                "description": "",
+                "discount": 0,
+                "duplicate_count": 0,
+                "extra_handling_price": "0.00",
+                "group": 11647,
+                "id": 15678,
+                "is_expired": false,
+                "is_saved": false,
+                "missing": [],
+                "name": "",
+                "order_data": null,
+                "payment_due_days": 30,
+                "po_number": null,
+                "price": "1183.84",
+                "product_discount_price": "0.00",
+                "products_price": "801.49",
+                "reference_id_full": "I-15678",
+                "reformatting_price": "0.00",
+                "shipping_price": "42.88",
+                "site_url": "https://mcule.com/quote/I-15678/",
+                "special_formatting_price": null,
+                "state": 10,
+                "state_display": "Displayed",
+                "stock_with_amount_ratio": 0,
+                "suppliers_count": 3,
+                "total_cost": 1183.84,
+                "total_cost_without_discount": 1183.84,
+                "total_discount_price": "0.00",
+                "tracking": null,
+                "type": 20,
+                "type_display": "Fastest delivery",
+                "updated": "2019-08-05T19:22:13.087765",
+                "valid_until": "2019-09-04T19:22:13.087"
+            },
+            {
+                "active": true,
+                "analytical_services_price": "0.00",
+                "api_url": "https://mcule.com/api/v1/iquotes/15677/",
+                "avg_product_price": 123.29,
+                "coverage_percent": 100,
+                "created": "2019-08-05T19:22:13.069027",
+                "delivery_days": 21,
+                "delivery_price": "311.16",
+                "description": "",
+                "discount": 0,
+                "duplicate_count": 0,
+                "extra_handling_price": "0.00",
+                "group": 11647,
+                "id": 15677,
+                "is_expired": false,
+                "is_saved": false,
+                "missing": [],
+                "name": "",
+                "order_data": null,
+                "payment_due_days": 30,
+                "po_number": null,
+                "price": "967.41",
+                "product_discount_price": "0.00",
+                "products_price": "616.45",
+                "reference_id_full": "I-15677",
+                "reformatting_price": "0.00",
+                "shipping_price": "39.80",
+                "site_url": "https://mcule.com/quote/I-15677/",
+                "special_formatting_price": null,
+                "state": 10,
+                "state_display": "Displayed",
+                "stock_with_amount_ratio": 0,
+                "suppliers_count": 3,
+                "total_cost": 967.41,
+                "total_cost_without_discount": 967.41,
+                "total_discount_price": "0.00",
+                "tracking": null,
+                "type": 10,
+                "type_display": "Best price",
+                "updated": "2019-08-05T19:22:13.069039",
+                "valid_until": "2019-09-04T19:22:13.069"
+            }
+        ],
+        "site_url": "https://mcule.com/quote/group/11647/",
+        "updated": "2019-08-05T19:22:13.063747"
+    },
+    "id": 15029,
+    "keep_original_salt_form": false,
+    "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",
+    "state": 30,
+    "state_display": "Done",
+    "target_cc": null,
+    "target_volume": null,
+    "user": 11
+}
+</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.
+===== Quote API =====
+In order to get the detailed data of an individual quote, you can query the following endpoint.
+<code>
+http https://mcule.com/api/v1/iquotes/15677/ "Authorization: Token <your_token>" --print HBhb
+</code>
+== Request: ===
+<code>
+GET /api/v1/iquotes/15677/ HTTP/1.1
+Accept: */*
+Accept-Encoding: gzip, deflate
+Authorization: Token <your_token>
+</code>
+== Response: ===
+<code>
+HTTP/1.1 200 OK
+Allow: GET, HEAD, OPTIONS
+Content-Encoding: gzip
+Content-Type: application/json
+{
+    "active": true,
+    "analytical_services_price": "0.00",
+    "api_url": "https://mcule.com/api/v1/iquotes/15677/",
+    "avg_product_price": 123.29,
+    "catalog_data": [
+        {
+            "catalog": 6,
+            "delivery_price": "86.95",
+            "delivery_time": 11,
+            "effective_price": "380.17",
+            "id": 90198,
+            "products_count": 3,
+            "products_price": "287.82",
+            "quote": 15677,
+            "reformatting_price": "0.00"
+        },
+        {
+            "catalog": 156,
+            "delivery_price": "107.21",
+            "delivery_time": 10,
+            "effective_price": "144.45",
+            "id": 90197,
+            "products_count": 1,
+            "products_price": "35.18",
+            "quote": 15677,
+            "reformatting_price": "0.00"
+        },
+        {
+            "catalog": 202,
+            "delivery_price": "117.00",
+            "delivery_time": 21,
+            "effective_price": "416.37",
+            "id": 90196,
+            "products_count": 1,
+            "products_price": "293.45",
+            "quote": 15677,
+            "reformatting_price": "0.00"
+        }
+    ],
+    "coverage_percent": 100,
+    "created": "2019-08-05T19:22:13.069027",
+    "delivery_days": 21,
+    "delivery_price": "311.16",
+    "description": "",
+    "discount": 0,
+    "duplicate_count": 0,
+    "extra_handling_price": "0.00",
+    "group": 11647,
+    "id": 15677,
+    "is_expired": false,
+    "is_saved": false,
+    "items": [
+        {
+            "amount": 1,
+            "id": 1740173,
+            "price": "144.45",
+            "product": 505393003,
+            "product_compound_mcule_id": "MCULE-1886826647",
+            "product_delivery_time": 6,
+            "product_external_id": "Q499",
+            "product_mcule_id": "P-505393003",
+            "product_price": "35.18",
+            "product_purity": 98,
+            "quote": 15677,
+            "raw_product_price": "25.00",
+            "structure_origin": 346255984,
+            "structure_origin_mcule_id": "MCULE-1886826647"
+        },
+        {
+            "amount": 1,
+            "id": 1740172,
+            "price": "97.32",
+            "product": 346316287,
+            "product_compound_mcule_id": "MCULE-3906582667",
+            "product_delivery_time": 7,
+            "product_external_id": "Z1450413036",
+            "product_mcule_id": "P-346316287",
+            "product_price": "95.94",
+            "product_purity": 90,
+            "quote": 15677,
+            "raw_product_price": "73.80",
+            "structure_origin": 346316288,
+            "structure_origin_mcule_id": "MCULE-6824753328"
+        },
+        {
+            "amount": 1,
+            "id": 1740171,
+            "price": "97.32",
+            "product": 346567071,
+            "product_compound_mcule_id": "MCULE-2221628462",
+            "product_delivery_time": 7,
+            "product_external_id": "Z1373424921",
+            "product_mcule_id": "P-346567071",
+            "product_price": "95.94",
+            "product_purity": 90,
+            "quote": 15677,
+            "raw_product_price": "73.80",
+            "structure_origin": 346567072,
+            "structure_origin_mcule_id": "MCULE-2221628462"
+        },
+        {
+            "amount": 1,
+            "id": 1740170,
+            "price": "97.32",
+            "product": 346206264,
+            "product_compound_mcule_id": "MCULE-7223347867",
+            "product_delivery_time": 7,
+            "product_external_id": "Z2327039912",
+            "product_mcule_id": "P-346206264",
+            "product_price": "95.94",
+            "product_purity": 90,
+            "quote": 15677,
+            "raw_product_price": "73.80",
+            "structure_origin": 346206265,
+            "structure_origin_mcule_id": "MCULE-7223347867"
+        },
+        {
+            "amount": 1,
+            "id": 1740169,
+            "price": "416.37",
+            "product": 580505383,
+            "product_compound_mcule_id": "MCULE-4609548851",
+            "product_delivery_time": 19,
+            "product_external_id": "X52967",
+            "product_mcule_id": "P-580505383",
+            "product_price": "293.45",
+            "product_purity": null,
+            "quote": 15677,
+            "raw_product_price": "225.73",
+            "structure_origin": 346209969,
+            "structure_origin_mcule_id": "MCULE-4609548851"
+        }
+    ],
+    "missing": [],
+    "name": "",
+    "order_data": null,
+    "payment_due_days": 30,
+    "po_number": null,
+    "price": "967.41",
+    "price_items": [
+        {
+            "attr": "product_discount",
+            "name": "Product discount (0%)",
+            "price": 0.0
+        },
+        {
+            "attr": "delivery_price_final",
+            "name": "Shipping (from 3 suppliers to Mcule)",
+            "price": 311.16
+        },
+        {
+            "attr": "shipping_price_final",
+            "name": "Shipping & package consolidation",
+            "price": 39.8
+        },
+        {
+            "attr": "reformatting_price_final",
+            "name": "Reformatting",
+            "price": 0
+        },
+        {
+            "attr": "analytical_services_price_final",
+            "name": "Analytical services",
+            "price": 0
+        },
+        {
+            "attr": "extra_handling_price_final",
+            "name": "Extra handling",
+            "price": 0
+        },
+        {
+            "attr": "total_discount_price",
+            "name": "Total discount (0%)",
+            "price": 0.0
+        }
+    ],
+    "product_discount_price": "0.00",
+    "products_price": "616.45",
+    "query": {
+        "amount": 1,
+        "api_url": "https://mcule.com/api/v1/iquote-queries/15029/",
+        "created": "2019-08-05T19:21:55.339011",
+        "customer_email": "",
+        "customer_first_name": "John",
+        "customer_last_name": "Doe",
+        "deliver_multiple_salt_forms": false,
+        "delivery_address": "",
+        "delivery_city": "",
+        "delivery_contact_person_email": "",
+        "delivery_contact_person_name": "",
+        "delivery_contact_person_phone": "",
+        "delivery_country": "US",
+        "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,
+        "keep_original_salt_form": false,
+        "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",
+        "state": 30,
+        "state_display": "Done",
+        "target_cc": null,
+        "target_volume": null,
+        "user": 11
+    },
+    "reference_id_full": "I-15677",
+    "reformatting_price": "0.00",
+    "shipping_price": "39.80",
+    "site_url": "https://mcule.com/quote/I-15677/",
+    "special_formatting_price": null,
+    "state": 10,
+    "state_display": "Displayed",
+    "stock_with_amount_ratio": 0,
+    "supplier_data": [
+        {
+            "delivery_price": "86.95",
+            "delivery_time": 10,
+            "effective_price": "380.17",
+            "id": 69668,
+            "products_count": 3,
+            "products_price": "287.82",
+            "quote": 15677,
+            "reformatting_price": "0.00",
+            "supplier": 3,
+            "supplier_po_deadline_days": 19,
+            "supplier_po_handling_fee": "0.00",
+            "supplier_po_products_price": "221.40"
+        },
+        {
+            "delivery_price": "107.21",
+            "delivery_time": 9,
+            "effective_price": "144.45",
+            "id": 69669,
+            "products_count": 1,
+            "products_price": "35.18",
+            "quote": 15677,
+            "reformatting_price": "0.00",
+            "supplier": 37,
+            "supplier_po_deadline_days": 19,
+            "supplier_po_handling_fee": "0.00",
+            "supplier_po_products_price": "25.00"
+        },
+        {
+            "delivery_price": "117.00",
+            "delivery_time": 20,
+            "effective_price": "416.37",
+            "id": 69667,
+            "products_count": 1,
+            "products_price": "293.45",
+            "quote": 15677,
+            "reformatting_price": "0.00",
+            "supplier": 33,
+            "supplier_po_deadline_days": 19,
+            "supplier_po_handling_fee": "0.00",
+            "supplier_po_products_price": "225.73"
+        }
+    ],
+    "suppliers_count": 3,
+    "total_cost": 967.41,
+    "total_cost_without_discount": 967.41,
+    "total_discount_price": "0.00",
+    "tracking": null,
+    "type": 10,
+    "type_display": "Best price",
+    "updated": "2019-08-05T19:22:13.069039",
+    "valid_until": "2019-09-04T19:22:13.069"
+}
+</code>