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 revision Previous revision
Next revision
Previous revision
api [2022/02/10 14:07]
flack [Quote order]
api [2022/04/29 17:04] (current)
flack [Quote order]
Line 162: Line 162:
 ===== InChIKey lookup ===== ===== InChIKey lookup =====
 == Endpoint: == == Endpoint: ==
-<code>/lookup/<inchi_key></code>+<code>/lookup/inchikey/<inchi_key></code>
  
 == Example API request: == == Example API request: ==
Line 1066: Line 1066:
   * **higher_amounts**: Set to true if you would like to get a quote for the compounds in the largest possible quantity in case they do not cost more than the specified amount. (default: false)   * **higher_amounts**: Set to true if you would like to get a quote for the compounds in the largest possible quantity in case they do not cost more than the specified amount. (default: false)
   * **item_filters**: Per query item filters. Currently it supports only supplier filtering. See example below.   * **item_filters**: Per query item filters. Currently it supports only supplier filtering. See example below.
-  * **scheme**: If you have access to predefined quote request schemes, you can specify here which one you want to use. A quote query scheme is essentially a template that contains predefined quote query parameters, or even include private parameters that affect quote generation in various ways (e.g.: discounts, predefined custom prices). These parameters can be customized for your use case. The scheme might already contain mandatory fields like delivery_country. In this case you don't have to specify them again, they will be applied from the scheme. Any explicitly specified public parameter during the request will override the one that comes from the specified scheme. +  * **scheme**: If you have access to predefined / pre-negotiated quote request schemes, you can specify here which one you want to use. You have to send the ID of the scheme which will be provided to you after negotiation. A quote query scheme is essentially a template that contains predefined quote query parameters, or even include private parameters that affect quote generation in various ways (e.g.: discounts, predefined custom prices). These parameters can be customized for your use case. The scheme might already contain mandatory fields like delivery_country. In this case you don't have to specify them again, they will be applied from the scheme. Any explicitly specified public parameter during the request will override the one that comes from the specified scheme. 
  
 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.
Line 1882: Line 1882:
 </code> </code>
  
-Please note that in case you submit a file in the API request, you have to use //Content-Type: multipart/form-data//.+Please note that in case you submit a file in the API request, you have to use //Content-Type: multipart/form-data// as you can see at the above request.
  
 If you don't submit a file in the API request, you can use //Content-Type: application/json// : If you don't submit a file in the API request, you can use //Content-Type: application/json// :
Line 1903: Line 1903:
 } }
 </code> </code>
 +
 +== Example response: ===
 +<code>
 +HTTP/1.0 201 CREATED
 +Allow: POST, OPTIONS
 +Content-Type: application/json
 +
 +{
 +    "billing_address": "",
 +    "billing_city": "",
 +    "billing_company_name": "",
 +    "billing_country": "",
 +    "billing_email": "",
 +    "billing_first_name": "",
 +    "billing_last_name": "",
 +    "billing_phone": "",
 +    "billing_post_code": "",
 +    "billing_same": true,
 +    "billing_state": "",
 +    "billing_vat": "",
 +    "created": "2022-04-29T17:02:09.257359",
 +    "id": 3691,
 +    "notes": "",
 +    "po_file_filename": "",
 +    "po_number": "",
 +    "po_option": 20,
 +    "po_option_display": "Order without PO",
 +    "shipping_address": "",
 +    "shipping_city": "",
 +    "shipping_company_name": "",
 +    "shipping_country": "US",
 +    "shipping_email": "",
 +    "shipping_first_name": "John",
 +    "shipping_last_name": "Doe",
 +    "shipping_phone": "",
 +    "shipping_post_code": "",
 +    "shipping_state": "",
 +    "updated": "2022-04-29T17:02:09.257373"
 +}
 +</code>
 +
  
 Mandatory fields: Mandatory fields:
Line 1918: Line 1959:
     * **billing_last_name**: Billing contact last name     * **billing_last_name**: Billing contact last name
     * **billing_phone**: Billing contact phone number     * **billing_phone**: Billing contact phone number
-    * **billing_same**: Whether the billing data is the same is shipping data+    * **billing_same**: Whether the billing data is the same as shipping data
     * **billing_vat**: Billing VAT number     * **billing_vat**: Billing VAT number
     * **shipping_address**: Shipping address     * **shipping_address**: Shipping address
-    * **shipping_city**: shipping city+    * **shipping_city**: Shipping city
     * **shipping_company_name**: Shipping Institution / Company name     * **shipping_company_name**: Shipping Institution / Company name
     * **shipping_country**: Shipping country     * **shipping_country**: Shipping country
api.1644498446.txt.gz ยท Last modified: 2022/02/10 14:07 by flack