User Tools

Site Tools


api

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
api [2019/09/04 16:31] flackapi [2019/09/08 09:47] – [Quote Request API] flack
Line 645: Line 645:
   * **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 delivery time is not critical. (default: 21)   * **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 delivery time is not critical. (default: 21)
   * **purity**: Required minimum purity (%). (default: null)   * **purity**: Required minimum purity (%). (default: null)
 +  * **item_filters**: Per query item filters. Currently it supports only supplier filtering. See example below.
 +
 +**item_filters** example:
 +It has to be a data structure where keys are mcule IDs you specified in the **mcule_ids** field. If you specify a key that is not an item in the **mcule_ids** list you should get a validation error (400 Bad Request).
 +Currently only supplier filtering is supported. You can specify a supplier ID list in the **suppliers** field to restrict product selection of a given item to a list of suppliers. If the list contains only one supplier ID, you restrict the product selection to that particular supplier. To get the ID of a supplier you can use the [[api#compound_suppliers_public_api|Compound suppliers Public API endpoint]] or the data is provided to you in another form (e.g.: exported database file that contains the information). If you specify a non-existing supplier ID, you should get a validation error.
 +<code>
 +{
 +  "MCULE-2221628462": {"suppliers": [3]},
 +  "MCULE-6824753328": {"suppliers": [3, 48]}
 +}
 +</code>
 The **amount** or target concentration-volume pair (**target_volume** and **target_cc**) need to be specified. The **amount** or target concentration-volume pair (**target_volume** and **target_cc**) need to be specified.
 + 
  
 Advanced optional fields: Advanced optional fields:
Line 1250: Line 1262:
     * **avg_effective_price**: Average price change upon exclusion of one product (USD).     * **avg_effective_price**: Average price change upon exclusion of one product (USD).
     * **delivery_time**: Delivery time (work. days)     * **delivery_time**: Delivery time (work. days)
-    * **quote**: The ID of the quote this supplier quote data belongs to. +    * **quote**: The ID of the quote this catalog level quote data belongs to. 
   * **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**: The creation datetime of the quote.
api.txt · Last modified: 2023/06/03 07:19 by flack