Downloads

Platform API v2.0.0

Tiered Usage

Request calls made to all Download endpoints will count towards your API tiered usage allowance. For more info please see Usage Allowance.

• GET Download
  • Query Parameters
  • Request Process
  • Responses
• POST Download
• GET Cached Export

GET Download

/download

Download supplier part compliance declaration data in IPC 1752 industry standard XML or BOMcheck detailed CSV file formats (more info in XML Files).

Query Parameters

format

• Type: String
• Required: Yes
• Description: Specifies the file format of the requested download.
• Valid Values:
  • "1752A" = IPC XML file
  • "1752B" = IPC XML file
  • "CSV" = BOMcheck detailed CSV file
• Example: /download?format=1752B

formatClass

• Type: String
• Required: No
• Default: "C"
• Description: Optional parameter specifying the IPC class of the requested download (Class C or Class D). If the requested format is CSV the class parameter will be ignored.
• Valid Values:
  • "C" = Class C RCD
  • "D" = Class D FMD
  • "checkDthenC" = Class D if available, Class C as fallback
• Example: /download?format=1752B&formatClass=D

supplier

• Type: String
• Required: Yes, parameter must be present with a valid value unless partNumbers parameter is present with a valid value.
• Description: Unique nine-digit DUNS number identifying the target supplier. DUNs number must match exactly a supplier DUNs number available in BOMcheck, fuzzy search matching is not supported over API.
• Example: /download?supplier=123456789

partNumbers

• Type: Array of strings
• Required: Yes, parameter must be present with a valid value unless supplier parameter is present with a valid value.
• Description: Allows for download of compliance data for target part numbers. Part numbers must match exactly part numbers available in BOMcheck, fuzzy search matching is not supported over API.
• Example: /download?partNumbers[]=ABC123&partNumbers[]=DEF456

startDate

• Type: ISO8601 formatted date string as YYYY-MM-DD
• Required: No
• Description: Optional parameter allows download of compliance data with an Approval Dates after the given start date.
• Example: /download?partNumbers[]=ABC123&startDate=2020-01-01

Request Process

Responses

Download Response (200 OK)

Successful requests will returns a ZIP archive (Content-Type: application/zip) containing one or many IPC XML files matching the specified request criteria. Files will conform to the following IPC XML examples:

Example XMLs

• Example 1752A Class C (RCD)
• Example 1752A Class D (FMD)
• Example 1752B Class C (RCD)
• Example 1752B Class D (FMD)
• Example BOMcheck Detailed CSV

Please also see HTTP Responses.

POST Download

In Development

Please note, the POST Download endpoint is currently in development.

GET Cached Export

Under Consideration

Please note, the GET Cached Export endpoint is currently under consideration.