What is the endpoint for [P031]Customs record?

The [P031]Customs record endpoint is GET https://connect.patsnap.com/advanced-patent-data/customs-data.

Where can I find the OpenAPI schema for [P031]Customs record?

The OpenAPI schema is available at /openapi.json#/paths/~1advanced-patent-data~1customs-data/get. You can also browse the full specification at /openapi.json.

[P031]Customs record

Q: What data can [P031]Customs record return?

[P031]Customs record Receive customs data by patent_id or patent_number. This includes record number, record status, start date, end date, approval/opinion, product, and contact. See the Response Schema and Success Response Example on this page for the full structure.

get

https://connect.patsnap.com/advanced-patent-data/customs-data

Try in Sandbox

Receive customs data by patent_id or patent_number. This includes record number, record status, start date, end date, approval/opinion, product, and contact.

The API supports batch requests with a maximum of 100 patents, and more patent id or patent number are separated with English comma. Batch requests are deducted from traffic/costs, and will be deducted multiple times based on the number of successful results returned.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`patent_id`	`string`	`9ffcdcd7-e6f1-4e22-9c93-e3c3eafe0cad`	patent_id
`patent_number`	`string`	`JP4627367B2`	patent_number

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`array`	-	response data
`pn`	`string`	`US11205304B2`	patent number
`patent_id`	`string`	`718ead9c-4f3c-4674-8f5a-24e126827269`	patent id
`patent_customs_record_data`	`array`	`Please check the form: PatentCustomsRecordData`	customs data
`contact`	`string`	`原田雅章知財事務所`	Contact
`country`	`string`	`JP`	Authority code
`product`	`string`	`電荷制御剤`	product
`end_date`	`integer<int64>`	`20201119`	Record end date
`start_date`	`integer<int64>`	`20150902`	Record start date
`record_number`	`string`	`P4627367-20150902-20201119`	Record number
`record_status`	`string`	`生效`	Record status
`approval_opinion`	`string`	`已审批、核准`	Approval opinion
`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": [
    {
      "pn": "US11205304B2",
      "patent_id": "718ead9c-4f3c-4674-8f5a-24e126827269",
      "patent_customs_record_data": [
        {
          "contact": "原田雅章知財事務所",
          "country": "JP",
          "product": "電荷制御剤",
          "end_date": 20201119,
          "start_date": 20150902,
          "record_number": "P4627367-20150902-20201119",
          "record_status": "生效",
          "approval_opinion": "已审批、核准"
        }
      ]
    }
  ],
  "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!

HTTP Status Codes

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