What is the endpoint for [B039] Drug deal information?

The [B039] Drug deal information endpoint is GET https://connect.patsnap.com/synapse/drug-deal.

What data can [B039] Drug deal information return?

[B039] Drug deal information Obtain drug deal information about partner, principle, deal time, drug etc. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for [B039] Drug deal information?

The OpenAPI schema is available at /openapi.json#/paths/~1synapse~1drug-deal/get. You can also browse the full specification at /openapi.json.

[B039] Drug deal information

get

https://connect.patsnap.com/synapse/drug-deal

Try in Sandbox

Obtain drug deal information about partner, principle, deal time, drug etc.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`deal_id` Required	`string`	`284929245a22a8a9e2ed5ee82ae52250`	Drug Deal ID, obtain this through the [B045] drug deal search interface

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`drug`	`array`	`[ { "drug_id": "81364d1ace044fdc8af8f60026eb2c7b", "display_name": [ { "lang": "EN", "name": "Ciltacabtagene autoleucel" }, { "lang": "CN", "name": "西达基奥仑赛" } ] } ]`	Drug, Referencing "CommonDrug"
`drug_id`	`string`	`e82b83b42eba4e5ea3f26f8e06081a5a`	Drug ID
`display_name`	`array`	`[ { "lang": "EN", "name": "Ranibizumab (Genentech)" }, { "lang": "CN", "name": "雷珠单抗" } ]`	Drug Name, Referencing "CommonName"
`lang`	`string`	`EN`	Language
`name`	`string`	`Ranibizumab (Genentech)`	Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
`target`	`array`	`[ { "target_id": "e49efee164e537c2a4ba9cec109e0adb", "short_name": [ { "lang": "EN", "name": "BCMA" } ], "display_name": [ { "lang": "EN", "name": "B-cell maturation protein" }, { "lang": "CN", "name": "B细胞成熟蛋白" } ] } ]`	Target, Referencing "CommonTarget"
`target_id`	`string`	`1c2067e5ab054a8995f73efcfcf56207`	Target ID
`short_name`	`array`	`[ { "lang": "EN", "name": "VEGF" } ]`	Target Short Name, Referencing "CommonName"
`display_name`	`array`	`[ { "lang": "EN", "name": "Vascular endothelial growth factor" }, { "lang": "CN", "name": "血管内皮生长因子" } ]`	Target Full Name, Referencing "CommonName"
`deal_id`	`string`	`284929245a22a8a9e2ed5ee82ae52250`	Drug Deal ID
`partner`	`array`	`[ { "display_name": [ { "lang": "EN", "name": "Janssen Biotech, Inc." }, { "lang": "CN", "name": "森托克奧素生物技術產品有限合夥事業" } ], "organization_id": "ee3f62ab873c539d75e06f49cc09d7fc" } ]`	Partner Organization, Referencing "CommonOrganization"
`display_name`	`array`	`[ { "lang": "EN", "name": "Roche Holding AG" }, { "lang": "CN", "name": "罗氏" } ]`	Organization Name, Referencing "CommonName"
`organization_id`	`string`	`87bfaf037f8e60c9e25595cd98bb27e4`	Organization ID
`deal_time`	`integer<int64>`	`1513814400000`	Drug Deal Time
`deal_type`	`array`	`[ { "display_name": [ { "lang": "EN", "name": "License" }, { "lang": "CN", "name": "许可" } ], "normalized_id": "c6bb6fa84d924b0cabd8f5dd2af17708" } ]`	Deal Type, Referencing "CommonDictionary"
`display_name`	`array`	`[ { "lang": "EN", "name": "Autologous CAR-T" }, { "lang": "CN", "name": "自体CAR-T" } ]`	Dict Name
`normalized_id`	`string`	`2fbfdb3e92d942c48cbb0adb79f23526`	Dict ID
`drug_type`	`array`	`[ { "display_name": [ { "lang": "EN", "name": "Autologous CAR-T" }, { "lang": "CN", "name": "自体CAR-T" } ], "normalized_id": "2fbfdb3e92d942c48cbb0adb79f23526" } ]`	Drug Type, Referencing "CommonDictionary"
`principle`	`array`	`[ { "display_name": [ { "lang": "EN", "name": "Legend Biotech USA, Inc." } ], "organization_id": "336e7d3b6f91616c632bc60c40a434de" }, { "display_name": [ { "lang": "EN", "name": "Nanjing Legend Biotech Co., Ltd." }, { "lang": "CN", "name": "南京传奇生物科技有限公司" } ], "organization_id": "a22fd154855c015ed283545df379f0de" } ]`	Principal Organization, Referencing "CommonOrganization"
`deal_title`	`string`	`Janssen Enters Worldwide Collaboration and License Agreement with Chinese Company Legend Biotech to Develop Investigational CAR-T Anti-Cancer Therapy`	Drug Deal Title
`source_url`	`string`	`https://pipelinereview.com/index.php/2017122266940/More-News/Janssen-Enters-Worldwide-Collaboration-and-License-Agreement-with-Chinese-Company-Legend-Biotech-to-Develop-Investigational-CAR-T-Anti-Cancer-Therapy.html`	News link
`deal_status`	`object`	`{ "display_name": [ { "lang": "EN", "name": "Active" }, { "lang": "CN", "name": "进行中" } ], "normalized_id": "4403ccfb0e0d46b7bc86e3d14b8259e0" }`	Deal Status, Referencing "CommonDictionary"
`deal_total_value`	`object`	`{ "value": "Undisclosed" }`	Total Payment, Referencing "MoneyItem"
`unit`	`string`	`million dollar`	Drug Deal Value Unit, Enum: million dollar. If the value is Undisclosed, return null.
`value`	`string`	`5000`	Drug Deal Value, if not disclosed, then return "Undisclosed"
`territory_excluded`	`array`	`[ { "country_id": "676de5ba-893a-36bb-8683-c93306aaf769", "alpha2_code": "JP", "display_name": [ { "lang": "EN", "name": "Japan" }, { "lang": "CN", "name": "日本" } ] } ]`	Country/Location(Exclude), Referencing "CommonCountry"
`country_id`	`string`	`676de5ba-893a-36bb-8683-c93306aaf769`	Country/Location ID
`alpha2_code`	`string`	`US`	Alpha Code
`display_name`	`array`	`[ { "lang": "EN", "name": "United States" }, { "lang": "CN", "name": "美国" } ]`	Country/Location Name
`territory_included`	`array`	`[ { "country_id": "4cc6684d-f7b4-392b-9dec-6fce3264fac8", "display_name": [ { "lang": "EN", "name": "Global" }, { "lang": "CN", "name": "全球" } ] } ]`	Country/Location(Include), Referencing "CommonCountry"
`deal_upfront_payment`	`object`	`{ "unit": "million dollars", "value": "350.00" }`	Upfront Payment, Referencing "MoneyItem"
`deal_milestone_payment`	`object`	`{ "value": "Undisclosed" }`	Milestone, Referencing "MoneyItem"
`status` Required	`boolean`	`false`	Status
`error_msg`	`string`	`The request parameter format is incorrect！`	Error Message
`error_code` Required	`integer`	`0`	Error Code

Success Response Example

Example of a successful API response

JSON

{
  "data": {
    "drug": [
      {
        "drug_id": "e82b83b42eba4e5ea3f26f8e06081a5a",
        "display_name": [
          {
            "lang": "EN",
            "name": "Ranibizumab (Genentech)"
          }
        ]
      }
    ],
    "target": [
      {
        "target_id": "1c2067e5ab054a8995f73efcfcf56207",
        "short_name": [
          {
            "lang": "EN",
            "name": "Ranibizumab (Genentech)"
          }
        ],
        "display_name": [
          {
            "lang": "EN",
            "name": "Ranibizumab (Genentech)"
          }
        ]
      }
    ],
    "deal_id": "284929245a22a8a9e2ed5ee82ae52250",
    "partner": [
      {
        "display_name": [
          {
            "lang": "EN",
            "name": "Ranibizumab (Genentech)"
          }
        ],
        "organization_id": "87bfaf037f8e60c9e25595cd98bb27e4"
      }
    ],
    "deal_time": 1513814400000,
    "deal_type": [
      {
        "display_name": [
          {
            "lang": "EN",
            "name": "Ranibizumab (Genentech)"
          }
        ],
        "normalized_id": "2fbfdb3e92d942c48cbb0adb79f23526"
      }
    ],
    "drug_type": [
      {
        "display_name": [
          {
            "lang": "EN",
            "name": "Ranibizumab (Genentech)"
          }
        ],
        "normalized_id": "2fbfdb3e92d942c48cbb0adb79f23526"
      }
    ],
    "principle": [
      {
        "display_name": [
          {
            "lang": "EN",
            "name": "Ranibizumab (Genentech)"
          }
        ],
        "organization_id": "87bfaf037f8e60c9e25595cd98bb27e4"
      }
    ],
    "deal_title": "Janssen Enters Worldwide Collaboration and License Agreement with Chinese Company Legend Biotech to Develop Investigational CAR-T Anti-Cancer Therapy",
    "source_url": "https://pipelinereview.com/index.php/2017122266940/More-News/Janssen-Enters-Worldwide-Collaboration-and-License-Agreement-with-Chinese-Company-Legend-Biotech-to-Develop-Investigational-CAR-T-Anti-Cancer-Therapy.html",
    "deal_status": {
      "display_name": [
        {
          "lang": "EN",
          "name": "Ranibizumab (Genentech)"
        }
      ],
      "normalized_id": "2fbfdb3e92d942c48cbb0adb79f23526"
    },
    "deal_total_value": {
      "unit": "million dollar",
      "value": 5000
    },
    "territory_excluded": [
      {
        "country_id": "676de5ba-893a-36bb-8683-c93306aaf769",
        "alpha2_code": "US",
        "display_name": [
          {
            "lang": "EN",
            "name": "Ranibizumab (Genentech)"
          }
        ]
      }
    ],
    "territory_included": [
      {
        "country_id": "676de5ba-893a-36bb-8683-c93306aaf769",
        "alpha2_code": "US",
        "display_name": [
          {
            "lang": "EN",
            "name": "Ranibizumab (Genentech)"
          }
        ]
      }
    ],
    "deal_upfront_payment": {
      "unit": "million dollar",
      "value": 5000
    },
    "deal_milestone_payment": {
      "unit": "million dollar",
      "value": 5000
    }
  },
  "status": true,
  "error_code": 0
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

Error Code	Description
`68300004`	Invalid parameter!
`68300005`	Search api failure!
`68300006`	Analytic basic access error!
`68300007`	Bad request!
`68300008`	Service error, please try again later!
`68300010`	The file does not comply with upload specifications!

Platform Errors

Error Code	Description
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	Quota exceeds the limit!
`67200003`	Access token expired or authentication error!
`67200004`	No permission or API package quota has exceeded the limit!
`67200005`	Insufficient balance, call failed!
`67200006`	This client has expired and call failed!
`67200007`	Exceeded the call limit, call failed!

HTTP Status Codes

Status Code	Description
`0`	Success
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found