Scrazzl API V2 Documentaion

Product Lookup

GET /v2/products

Allows an API user to search the product database using a variety of queries including:

  1. catalogue ID + vendor name.
  2. Product name + vendor name.
  3. Product name only.

Typical responses include product ID, product name, catalogue ID, vendor name, description, unit, product URL, target, species cross reactivity, host species...etc. A full list of product attributes and associated descriptions available through the API can be viewed here.

Example request:

GET /v2/products HTTP/1.1
Host: api.scrazzl.com
Accept: application/json

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

 {
     "meta":
     {
         "list":
         {
             "total": "106280",
             "offset": "0",
             "limit": "100"
         }
     },
     "list":
     [
         {
             "id": "12345",
             "name": "ABC antibody",
             "catalogueId": "xx12345",
             "vendorName": "XYZ company",
             "desc": "ABC antibody description",
             "unit": "123 µg",
             "link": "https://example.com/v2/tracker/products/123456/platform-name",
             "type": "Antibody",
             "clone": "ABXX-40",
             "domain/region/terminus": "10-5",
             "isotype": "AbC",
             "target": "ABC",
             "target tag/conjugate": "Unconjugated",
             "target/molecule synonym": "AI123456, B cell associated molecule ABC, B cell surface antigen ABC, B cell-associated molecule, B-cell surface antigen ABC, Bp50, CD 40, ABC, ABC, ABC antigen, ABC antigen (TNF receptor superfamily member 5), ABC molecule, ABC molecule, TNF receptor superfamily member 5, ABC protein, ABC type II isoform, ABCL receptor, ABwC, GP39, HIGM1, IGM, IMD3, MGC9013, Nerve growth factor receptor related B lymphocyte activation molecule, OTTHUMP00000031699, OTTHUMP00000031700, p50, T-BAM, TBAM, TNF receptor superfamily member 5, TNFRSF5, TNR5_HUMAN, TRAP, Tumor necrosis factor receptor superfamily, member 5, Tumor necrosis factor receptor superfamily member 5, Tumor necrosis factor receptor superfamily member 5 precursor, Tumor necrosis factor receptor superfamily, member 5, isoform CRA_a",
             "applications": "FC",
             "clonality": "Monoclonal",
             "host species": "species name",
             "species cross reactivity":
             [
                 "species one",
                 "species two"
             ],
             "tag":
             [
             ]
         },
     ]
 }
Query Parameters:
 
  • cid – Product catalogue id
  • vname – Vendor name (Must be url encoded if any special characters included.)
  • pname – Full or partial product name (Must be url encoded if any special characters included.)
  • token – Your API token
  • p – Your API platform
  • fullspec – 0 - Returns basic specifications of the product, 1 - Returns full specifications of the product (Not required. Default is 0.)
  • mdate – Last modified date (ISO 8601 standard, eg :- 2014-02-03T14:26:46Z) - Returns data updated from last modified date to current date. (Not required. By default it returns all data from the date, product is entered.)
  • offset – Starting index of the product listing (Not required. Default is 0.)
  • limit – Number of products to list (Not required. Default is 50.)

Note - Individual query parameters cid, vname, pname or the combinations of cid, pname or cid, vname can be used for Product Search.