Important: This documentation applies to v2 of this package.
For v3 docs see vpic.shaggytech.com

Module

api/actions/GetParts

GetParts NHSTA Api Action.

Module Exports:

Types

View Source api/actions/GetParts.ts, line 2

Classes

GetParts

Type Definitions

object

# GetPartsResponse

Type representing the complete response returned by the GetParts API Action.

Properties:
Name Type Description
Count number

A count of the items returned in the Results array.

Message string

A message describing the Results array.

SearchCriteria string

Search terms (VIN, WMI, manufacturer, etc.) used in the request URL.

Results Array.<GetPartsResults>

The search results returned by the NHSTA API request.

FetchResponse FetchResponse

Fetch API Response properties.

View Source api/actions/GetParts.ts, line 107

object

# GetPartsResults

Type representing the structure of objects found in the 'GetPartsResponse.Results' array.

Properties:
Name Type Description
CoverLetterURL string
LetterDate string
ManufacturerId number
ManufacturerName string
ModelYearFrom string
ModelYearTo string
Name string
Type string
URL string

View Source api/actions/GetParts.ts, line 91