DCi Data API

Lookup API

Description

The Lookup API is designed to be a full part lookup centered around a vehicle, although a vehicle is not required

It is designed to allow a hierarchy approach to finding part information. However, no order is required as long as you have the appropriate data for your selected query parameters of a call

It can be used to look up automotive parts by vehicle, catalog (brand), category and/or keyword search.

We suggest getting the vehicle information from the user to begin in order to get them to parts that fit their vehicle more quickly. This, however, is not necessary when doing keyword searches.

Keyword searches can be made through GetPartList for getting users to a specific part they are looking for. This works best for finding a particular part by Part Number

Users can select a vehicle through the vehicle endpoints. This information can be passed into the part queries.


Parts

Parts endpoints are the main functionality of the API. This gets users from the top-level categories down to a part in the following order:

  1. Get Categories
  2. Get Part Types
  3. Get Product Lines
  4. Get Part List
  5. Get Part Information

Vehicle

Vehicle endpoints allow for selecting a vehicle on which to filter parts. These should be called in the following order:

  1. Get Years
  2. Get Makes
  3. Get Models
  4. Get Submodels
  5. Get Engines
  6. Get VQs

Helpers

Helper endpoints are for querying additional information you may want for display purposes

  • Get Catalog Parts
  • Get Catalogs
  • Get Manufacturer Information
  • Get Hierarchy
  • Verify Fitment
  • Get Pricing
  • Get Pricing List

Get Categories

Get categories based on filters, grouped by super category

Endpoint

/API/Lookup/GetCategories


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

linecode

The three character DCi code for a catalog (brand)

Example: ACL

Source: A valid value from Get Catalogs field Catalog.Linecode

aaia

The four character AAIA code for a catalog (brand)

Example: BDDP

Source: A valid value from Get Catalogs field Catalog.AAIA

supercategory

the Id of a super category

Example: 3

Source: A valid value from Get Categories field API.Category.GroupID

vehicleinfo

A pipe-delimited string of vehicle information

Format: year|make|model|submodel|engine|fuel|aspiration

Example: 2018|Ford|Pickup F-150|King Ranch|V6 3.5L |FI|T

Source: year: A valid value from Get Years field API.Year
make: A valid value from Get Makes field API.Make
model: A valid value from Get Models field API.Model
submodel: A valid value from Get Submodels field API.Submodel
engine: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Engine
fuel: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Fuel
aspiration: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Aspiration
format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "Category": [
            {
                "GroupName": "Performance/Engine/Drivetrain",
                "GroupID": "3",
                "ImageURL": "https://api.v12.estore.catalograck.com/Services/ImageResize.ashx?imageloc=ABC|2007bk.jpg&maxDim=230",
                "Items": [
                    {
                        "Id": "62",
                        "Value": "Air/Fuel Delivery",
                        "ImageURL": "https://api.v12.estore.catalograck.com/Services/ImageResize.ashx?imageloc=ABC|150115.jpg&maxDim=230"
                    },
                    ...
                    {
                        "Id": "115",
                        "Value": "Sensor",
                        "ImageURL": "https://api.v12.estore.catalograck.com/Services/ImageResize.ashx?imageloc=ABC|74777.jpg&maxDim=230"
                    }
                ]
            },
            ...
            {
                "GroupName": "Suspension/Steering/Brakes",
                "GroupID": "1",
                "ImageURL": "https://api.v12.estore.catalograck.com/Services/ImageResize.ashx?imageloc=ABC|33001.jpg&maxDim=230",
                "Items": [
                    {
                        "Id": "25",
                        "Value": "Brakes",
                        "ImageURL": "https://api.v12.estore.catalograck.com/Services/ImageResize.ashx?imageloc=ABC|33001.jpg&maxDim=230"
                    }
                    ...
                ]
            }
        ],
        "Status": {
            "Message": "The call (api.v12.estore.catalograck.com) returned successfully with years.",
            "DataFound": true,
            "TimeStamp": "05/03/2021 11:24:54",
            "InternalError": false
        }
    }
}

Response Fields

API.Category

array [object]

a list of categories, grouped by super category. If there are no categories to return for a super category, the super category will be omitted from the results

API.Category.GroupID

string

Id for the super category

API.Category.GroupName

string

Name of the super category

API.Category.ImageURL

string

A link to an image to display for the super category. maxDim can be changed to resize the image in pixels with the longer dimension being that size

API.Category.Items

object

A list of all categories matching the query for the containing super category

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether or not there was an internal error while processing the request

Try it with your Data

Enter your authentication key at the top to try

Get Part Types

Gets part types for specified query

Endpoint

/API/Lookup/GetPartTypes


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

vehicleinfo

A pipe-delimited string of vehicle information

Format: year|make|model|submodel|engine|fuel|aspiration

Example: 2018|Ford|Pickup F-150|King Ranch|V6 3.5L |FI|T

Source: year: A valid value from Get Years field API.Year
make: A valid value from Get Makes field API.Make
model: A valid value from Get Models field API.Model
submodel: A valid value from Get Submodels field API.Submodel
engine: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Engine
fuel: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Fuel
aspiration: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Aspiration
categoryid

The ID of a category

Example: 62

Source: A valid value from Get Categories field API.Category.Items.Id

linecode

The three character DCi code for a catalog (brand)

Example: ACL

Source: A valid value from Get Catalogs field Catalog.Linecode

aaia

The four character AAIA code for a catalog (brand)

Example: BDDP

Source: A valid value from Get Catalogs field Catalog.AAIA

format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "PartType": [
            {
                "Id": "8679",
                "Value": "Electric Seat Heater",
                "ImageURL": "https://api.v12.estore.catalograck.com/Services/ImageResize.ashx?imageloc=ABC|13150_01.jpg&maxDim=230"
            },
            ...
            {
                "Id": "10252",
                "Value": "Vinyl And Fabric Color",
                "ImageURL": "https://api.v12.estore.catalograck.com/Services/ImageResize.ashx?imageloc=ABC|SP941_040510.jpg&maxDim=230"
            }
        ],
        "Status": {
            "Message": "The call (api.v12.estore.catalograck.com) returned successfully with years.",
            "DataFound": true,
            "TimeStamp": "05/03/2021 11:24:54",
            "InternalError": false
        }
    }
}

Response Fields

API.PartType

array [object]

A list of all Part Types for the query

API.PartType.Id

string

The Id of the part type

API.PartType.Value

string

The Name of the part type

API.PartType.Value

string

The URL For a picture to represent the part type

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether or not there was an internal error while processing the request

Try it with your Data

Enter your authentication key at the top to try

Get Product Lines

Gets all product lines for the specified query. Filters are also provided to give users the ability to narrow their search. These are typically used to build a filter menu. Brand and Category filters return as one group each. Vehicle Qualifiers (VQ), and Part Qualifiers (PQ) have filter groups, such as Color (PQ), Material (PQ), Number of Doors (VQ), Wheel Size (VQ). Each one returns its own filter group

Endpoint

/API/Lookup/GetProductLines


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

parttype
required

The part type Id and optionally the part type name, pipe-delimited

Format: id|name

Example: 3135|Tonneau Cover

Source: id: A valid value from Get Part Types field API.PartType.Id
name: A valid value from Get Part Types field API.PartType.Value
brand

A catalog (brand) Id. Optionally the catalog name appended, pipe-delimited

Format: id|name

Example: 540|ACCESS Cover

Source: id: A valid value from Get Catalogs field Catalog.ID
name: A valid value from Get Catalogs field Catalog.Name
vehicleinfo

A pipe-delimited string of vehicle information

Format: year|make|model|submodel|engine|fuel|aspiration

Example: 2018|Ford|Pickup F-150|King Ranch|V6 3.5L |FI|T

Source: year: A valid value from Get Years field API.Year
make: A valid value from Get Makes field API.Make
model: A valid value from Get Models field API.Model
submodel: A valid value from Get Submodels field API.Submodel
engine: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Engine
fuel: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Fuel
aspiration: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Aspiration
univ

A one character identifier used to filter parts by whether or not they are universal fit or vehicle-specific

Default Value: A

Valid Values: A (All), V (Vehicle-Specific), U (Universal)

vqs

A list of Vehicle Qualifiers (options) to refine query results, comma-separated with individual parts of each vq being pipe-delimited

Format: id|category|name,id|category|name

Example: 2002|Axle|Front 8.8 in. Reverse,2131|BED STYLE|67.1 in./5 ft. 7.1 in. Bed

Source: id|category|name: A valid value from Get VQs field API.VQGroups.VQs.QualifiedId
id: A valid value from Get Part List field API.PartList.Filters.Filter.Id when API.PartList.Filters.Type = VQ
category: A valid value from Get Part List field API.PartList.Filters.Type when API.PartList.Filters.Type = VQ
name: A valid value from Get Part List field API.PartList.Filters.Filter.Name when API.PartList.Filters.Type = VQ
pqs

A list of Part Qualifiers (options) to refine query results, comma-separated with individual parts of each pq being pipe-delimited

Format: id|category|name,id|category|name

Example: 30423|Actual Color|Abalone White,32730|Full Bed Access|No

Source: id: A valid value from Get Part List field API.PartList.Filters.Filter.Id when API.PartList.Filters.Type = PQ
category: A valid value from Get Part List field API.PartList.Filters.Type when API.PartList.Filters.Type = PQ
name: A valid value from Get Part List field API.PartList.Filters.Filter.Name when API.PartList.Filters.Type = PQ
requirepqsvqs

Whether or not to use PQs and VQs parameter values passed in. If false, then it will not factor in any PQs or VQs passed in

Default Value: false

Valid Values: true, false

pageNumber

The page number for results.

Default Value: 1

itemsPerPage

The number of items returned per page. For non-paginated queries, is used to build links for other queries

Default Value: 50

imgsize

The number of pixels in length of the longer dimension of a photo. This sets the maxDim on image links for the query

Default Value: 230

format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "ProductLines": {
            "TotalProductLines": 7,
            "ProductLines": [
                {
                    "Brand": "ABC Manufacturing",
                    "ProductLineID": 19455,
                    "Description": "Roll-Up Cover",
                    "PartCount": 130,
                    "ImageUrl": "https://api.v12.estore.catalograck.com/Services/ImageResize.ashx?imageloc=ABC|PartImage1.jpg&maxDim=230",
                    "FeaturesAndBenefits": "Low Profile Design,Compliments Look Of Your Truck,Fully Operational In Extreme Weather Conditions,Installs In Minutes With 8 Reliable Clamps,Cover Rolls Open In Seconds,Enhances The Look Of Your Truck,Includes Auto Latch II Locking System,5 Year Warranty",
                    "minPrice": 472.44,
                    "maxPrice": 509.44,
                    "ProductLineUrl": "https://api.v12.estore.catalograck.com/API/Lookup/GetPartList?authkey=00000000-0000-0000-0000-000000000000&parttype=3135&brand=540|ABC Manufacturing&productline=19455|Roll-Up Cover&requirepqvqs=False&format=json"
                },
                ...
                {
                    "Brand": "ABC Manufacturing",
                    "ProductLineID": 25032,
                    "Description": "Invisible Roll-Up Cover",
                    "PartCount": 130,
                    "ImageUrl": "https://api.v12.estore.catalograck.com/Services/ImageResize.ashx?imageloc=ABC|PartImage2.jpg&maxDim=230",
                    "FeaturesAndBenefits": "Cover Sits Only 1/2 in. Above Truck Bed,Enhances The Look Of Your Truck,Installs In Minutes With 6 Reliable Clamps,Includes Locking System And Slide Lock,Sealing System Keeps Out Rain Dirt And Snow,3 Year Warranty",
                    "minPrice": 418.44,
                    "maxPrice": 457.44,
                    "ProductLineUrl": "https://api.v12.estore.catalograck.com/API/Lookup/GetPartList?authkey=00000000-0000-0000-0000-000000000000&parttype=3135&brand=540|ABC Manufacturing&productline=25032|Roll-Up Cover&requirepqvqs=False&format=json"
                }
            ],
            "Filters": [
                {
                    "Group": "Rails To Install",
                    "Type": "PQ",
                    "Filter": [
                        {
                            "Id": 0,
                            "Name": "No",
                            "URL": "https://api.v12.estore.catalograck.com/API/Lookup/GetProductLines?authkey=00000000-0000-0000-0000-000000000000&parttype=3135&brand=540|ABC Manufacturing&pqs=,32732|Rails To Install|No&requirepqvqs=True&format=json"
                        },
                        ...
                        {
                            "Id": 0,
                            "Name": "Yes",
                            "URL": "https://api.v12.estore.catalograck.com/API/Lookup/GetProductLines?authkey=00000000-0000-0000-0000-000000000000&parttype=3135&brand=540|ABC Manufacturing&pqs=,32731|Rails To Install|Yes&requirepqvqs=True&format=json"
                        }
                    ]
                },
                ...
                {
                    "Group": "Sits on Truck Rails ",
                    "Type": "PQ",
                    "Filter": [
                        {
                            "Id": 0,
                            "Name": "Yes",
                            "URL": "https://api.v12.estore.catalograck.com/API/Lookup/GetProductLines?authkey=00000000-0000-0000-0000-000000000000&parttype=3135&brand=540|ABC Manufacturing&pqs=,32727|Sits on Truck Rails |Yes&requirepqvqs=True&format=json"
                        },
                        ...
                        {
                            "Id": 0,
                            "Name": "No",
                            "URL": "https://api.v12.estore.catalograck.com/API/Lookup/GetProductLines?authkey=00000000-0000-0000-0000-000000000000&parttype=3135&brand=540|ABC Manufacturing&pqs=,32746|Sits on Truck Rails |No&requirepqvqs=True&format=json"
                        }
                    ]
                }
            ]
        },
        "Status": {
            "Message": "The call (api.v12.estore.catalograck.com) returned successfully with years.",
            "DataFound": true,
            "TimeStamp": "05/03/2021 11:24:54",
            "InternalError": false
        }
    }
}

Response Fields

API.ProductLines

object

The container for product lines and total count

API.ProductLines.TotalProductLines

integer

The total number of product lines across all pages

API.ProductLines.ProductLines

array [object]

A list of product lines

API.ProductLines.ProductLines.Brand

string

The name of the catalog (brand)

API.ProductLines.ProductLines.ProductLineID

string

The Id of the Product Line

API.ProductLines.ProductLines.Description

string

The description of the Product Line

API.ProductLines.ProductLines.PartCount

string

The total number of parts in the Product Line

API.ProductLines.ProductLines.ImageUrl

string

A Url to an image to represent the product line

API.ProductLines.ProductLines.FeaturesAndBenefits

string

A list of product features, comma-delimited

API.ProductLines.ProductLines.minPrice

string

The lowest-priced part in the product line

API.ProductLines.ProductLines.maxPrice

string

The highest-priced part in the product line

API.ProductLines.ProductLines.ProductLineUrl

string

A Url to query GetProductLines for the product line

API.ProductLines.Filters

array [object]

A list of all filters that can be applied to refine the search

API.ProductLines.Filters.Group

string

The category for the filter. Primarily for PQ and VQ Filters. This matches the Type field for Brand and Category

API.ProductLines.Filters.Type

string

The group of filter types this belongs to: Brand, Category, VQ, PQ

API.ProductLines.Filters.Filter

array [object]

A list of possible filters for the given group and type

API.ProductLines.Filters.Filter.Id

integer

The id for this filter

API.ProductLines.Filters.Filter.Name

string

The filtering value

API.ProductLines.Filters.Filter.URL

string

The url to filter the current query by the filter value

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether or not there was an internal error while processing the request

Try it with your Data

Enter your authentication key at the top to try

Get Part List

Gets a list of parts for the specified query. Filters are also provided to give users the ability to narrow their search. These are typically used to build a filter menu. Brand, Category, and ProductLine filters all return as one group each. Vehicle Qualifiers (VQ), and Part Qualifiers (PQ) have filter groups, such as Color (PQ), Material (PQ), Number of Doors (VQ), Wheel Size (VQ) Each one returns its own filter group

Endpoint

/API/Lookup/GetPartList


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

keyword

Searches for parts by keyword. Commonly used to find parts by part number or UPC/GTIN

Example: "EX4110-T" or "743047910023"

Source: Free form text for searching

parttype

The part type Id and optionally the part type name, pipe-delimited

Format: id|name

Example: 3135|Tonneau Cover

Source: id: A valid value from Get Part Types field API.PartType.Id
name: A valid value from Get Part Types field API.PartType.Value
category

The category id and optionally the category name, pipe-delimited

Format: id|name

Example: 43|Tonneau Cover

Source: id: A valid value from Get Categories field API.Category.Items.Id
name: A valid value from Get Categories field API.Category.Items.Value
vehicleinfo

A pipe-delimited string of vehicle information

Format: year|make|model|submodel|engine|fuel|aspiration

Example: 2018|Ford|Pickup F-150|King Ranch|V6 3.5L |FI|T

Source: year: A valid value from Get Years field API.Year
make: A valid value from Get Makes field API.Make
model: A valid value from Get Models field API.Model
submodel: A valid value from Get Submodels field API.Submodel
engine: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Engine
fuel: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Fuel
aspiration: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Aspiration
brand

A catalog (brand) Id. Optionally the catalog name appended, pipe-delimited

Format: id|name

Example: 540|ACCESS Cover

Source: id: A valid value from Get Catalogs field Catalog.ID
name: A valid value from Get Catalogs field Catalog.Name
pqs

A list of Part Qualifiers (options) to refine query results, comma-separated with individual parts of each pq being pipe-delimited

Format: id|category|name,id|category|name

Example: 30423|Actual Color|Abalone White,32730|Full Bed Access|No

Source: id: A valid value from Get Part List field API.PartList.Filters.Filter.Id when API.PartList.Filters.Type = PQ
category: A valid value from Get Part List field API.PartList.Filters.Type when API.PartList.Filters.Type = PQ
name: A valid value from Get Part List field API.PartList.Filters.Filter.Name when API.PartList.Filters.Type = PQ
vqs

A list of Vehicle Qualifiers (options) to refine query results, comma-separated with individual parts of each vq being pipe-delimited

Format: id|category|name,id|category|name

Example: 2002|Axle|Front 8.8 in. Reverse,2131|BED STYLE|67.1 in./5 ft. 7.1 in. Bed

Source: id|category|name: A valid value from Get VQs field API.VQGroups.VQs.QualifiedId
id: A valid value from Get Part List field API.PartList.Filters.Filter.Id when API.PartList.Filters.Type = VQ
category: A valid value from Get Part List field API.PartList.Filters.Type when API.PartList.Filters.Type = VQ
name: A valid value from Get Part List field API.PartList.Filters.Filter.Name when API.PartList.Filters.Type = VQ
requirepqsvqs

Whether or not to use PQs and VQs parameter values passed in. If false, then it will not factor in any PQs or VQs passed in

Default Value: false

Valid Values: true, false

univ

A one character identifier used to filter parts by whether or not they are universal fit or vehicle-specific

Default Value: A

Valid Values: A (All), V (Vehicle-Specific), U (Universal)

itemsPerPage

The number of items returned per page. For non-paginated queries, is used to build links for other queries

Default Value: 50

pageNumber

The page number for results.

Default Value: 1

productline

The product line Id and optionally the product line name, pipe-delimited

Format: id|name

Example: 19455|Roll-Up Cover

Source: id: A valid value from Get Product Lines field API.ProductLines.ProductLines.ProductLineID
name: A valid value from Get Product Lines field API.ProductLines.ProductLines.Description
imgsize

The number of pixels in length of the longer dimension of a photo. This sets the maxDim on image links for the query

Default Value: 72

rtype

Used along with exppartid parameter to get all parts for the R Type provided

Valid Values: REC (Recommended), REQ (Required), REP (Replacement)

exppartid

Used along with rtype to get all related parts to this part

Example: 6771913

Source: A valid value from Get Part Information field API.PartInformation.Exppartid

format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "PartList": {
            "TotalItems": 130,
            "PartItems": [
                {
                    "BrandImageUrl": "https://api.v12.estore.catalograck.com/Services/ImageResize.ashx?imageloc=ABC|Brand_logo.jpg&maxDim=72",
                    "Catalog": "Generic Brand",
                    "Description": "Bed Cover",
                    "LineCode": "ABC",
                    "PartCustomContent": null,
                    "PartImageUrl": "https://api.v12.estore.catalograck.com/Services/ImageResize.ashx?imageloc=ABC|PartImage.jpg&maxDim=72",
                    "PartNumber": "101223",
                    "PartType": "Tonneau Cover",
                    "ProductDescriptionCustomContent": "Some Custom Content",
                    "VSpec": "Vehicle Specific",
                    "GTIN": "00834532006083",
                    "ProductLine": "Bed Cover Product Line",
                    "Price": 0
                },
                ...
                {
                    "BrandImageUrl": "https://api.v12.estore.catalograck.com/Services/ImageResize.ashx?imageloc=ABC|Brand_logo.jpg&maxDim=72",
                    "Catalog": "Generic Brand",
                    "Description": "Bed Cover",
                    "LineCode": "ABC",
                    "PartCustomContent": null,
                    "PartImageUrl": "https://api.v12.estore.catalograck.com/Services/ImageResize.ashx?imageloc=ABC|PartImage2.jpg&maxDim=72",
                    "PartNumber": "A2C44-5",
                    "PartType": "Tonneau Cover",
                    "ProductDescriptionCustomContent": "Some Custom Content",
                    "VSpec": "Vehicle Specific",
                    "ProductLine": "Roll-Up Cover",
                    "GTIN": "00813072027000",
                    "Price": 0
                }
            ],
            "Filters": [
                {
                    "Group": "Color",
                    "Type": "PQ",
                    "Filter": [
                        {
                            "Id": 1,
                            "Name": "Black",
                            "URL": "https://api.v12.estore.catalograck.com/API/Lookup/GetPartList?authkey=00000000-0000-0000-0000-000000000000&parttype=3135|Tonneau Cover&pqs=4915|Color|Black&requirepqvqs=True&format=json"
                        },
                        {
                            "Id": 34,
                            "Name": "White",
                            "URL": "https://api.v12.estore.catalograck.com/API/Lookup/GetPartList?authkey=00000000-0000-0000-0000-000000000000&parttype=3135|Tonneau Cover&pqs=5868|Color|White&requirepqvqs=True&format=json"
                        }
                    ]
                }
            ]
        },
        "Status": {
            "Message": "The call (api.v12.estore.catalograck.com) returned successfully with part list.",
            "DataFound": true,
            "TimeStamp": "05/03/2021 12:07:10",
            "InternalError": false
        }
    }
}

Response Fields

API.PartList

object

The container for the part list and total count

API.PartList.TotalItems

string

The total number of parts for the query before pagination

API.PartList.PartItems

array [object]

The part object for all parts on the current page

API.PartList.PartItems.BrandImageUrl

string

The url to the brand logo for the part

API.PartList.PartItems.Catalog

string

The catalog (brand) name of the part

API.PartList.PartItems.Description

string

A part-level description of the part

API.PartList.PartItems.Linecode

string

The 3 character DCi identifier of the catalog for the part

API.PartList.PartItems.PartCustomContent

string

Custom information set for this part for the account specified by the authkey

API.PartList.PartItems.PartImageUrl

string

The main image for the part

API.PartList.PartItems.PartNumber

string

The part identifier assigned by the manufacturer

API.PartList.PartItems.PartType

string

The name of the part type that the part belongs to

API.PartList.PartItems.ProductDescriptionCustomContent

string

Custom information set for this the product line that includes this part for the account specified by the authkey

API.PartList.PartItems.VSpec

string

Whether a part it vehicle specific or universal. Value is either "Vehicle Specific" or "Non Spec"

API.PartList.PartItems.ProductLine

string

The description of the product line containing this part

API.PartList.PartItems.GTIN

string

The GTIN for the part. If the two leading numbers are 0, then this is also a UPC code. If first leading number is 0, then it is also an EAN code

API.PartList.PartItems.Price

string

This value is always 0 and is not used

API.PartList.Filters

array [object]

A list of all filters that can be applied to refine the search

API.PartList.Filters.Group

string

The category for the filter. Primarily for PQ and VQ Filters. This matches the Type field for Brand, Category and ProductLine

API.PartList.Filters.Type

string

The group of filter types this belongs to: Brand, Category, ProductLine, VQ, PQ

API.PartList.Filters.Filter.Id

integer

The id for this filter

API.PartList.Filters.Filter.Name

string

The filtering value

API.PartList.Filters.Filter.URL

string

The url to filter the current query by the filter value

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether or not there was an internal error while processing the request

Try it with your Data

Enter your authentication key at the top to try

Get Part Information

Gets the full information for a part

Endpoint

/API/Lookup/GetPartInformation


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

partnumber
required

the part identifier assigned by the manufacturer

Example: EX4110-T

Source: A valid value from Get Catalog Parts field API.Part
A valid value from Get Part List field API.PartList.PartItems.PartNumber
linecode

The three character DCi code for a catalog (brand)

Example: ACL

Source: A valid value from Get Catalogs field Catalog.Linecode

aaia

The four character AAIA code for a catalog (brand)

Example: BDDP

Source: A valid value from Get Catalogs field Catalog.AAIA

vehicleinfo

A pipe-delimited string of vehicle information

Format: year|make|model|submodel|engine|fuel|aspiration

Example: 2018|Ford|Pickup F-150|King Ranch|V6 3.5L |FI|T

Source: year: A valid value from Get Years field API.Year
make: A valid value from Get Makes field API.Make
model: A valid value from Get Models field API.Model
submodel: A valid value from Get Submodels field API.Submodel
engine: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Engine
fuel: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Fuel
aspiration: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Aspiration
format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "PartInformation": {
            "Audio": [
                "https://api.v12.estore.catalograck.com/ImgVD/ABC/audio.mp3"
            ],
            "BuyersGuide": "https://api.v12.estore.catalograck.com/Services/BuyersGuideImage.ashx?partnumber=200-RT&linecode=ABC&authkey=00000000-0000-0000-0000-000000000000",
            "Category": "Tools and Equipment",
            "Dimensions": {
                "Depth": 0.8,
                "DimUOM": "IN",
                "Height": 6.7,
                "Weight": 0.35,
                "Weightuom": "LB",
                "Width": 3.9,
                "IsFreight": false
            },
            "Exppartid": 6771913,
            "FeaturesAndBenefits": "All-Copper Contact",
            "ImportantInformation": [
                "Made On Or Before 5/31/2005"
            ],
            "InstallationGuideUrl": [
                {
                    "Text":"Installation Guide",
                    "Url":"https://api.v12.estore.catalograck.com/ImgVD/ABC/guide.pdf"
                }
            ],
            "LargeImageUrl": "https://api.v12.estore.catalograck.com/Services/ImageResize.ashx?iABC|PartImage.jpg&maxDim=1500",
            "Manufacturer": "Brand",
            "MarketingCopy": "Properly index your spark plugs with these index washers.",
            "MsdsUrls": [
                {
                    "Text":"MSD",
                    "Url":"https://api.v12.estore.catalograck.com/ImgVD/ABC/MSD.pdf"
                }
            ],
            "PrimaryImageUrl": "https://api.v12.estore.catalograck.com/Services/ImageResize.ashx?imageloc=ABC|PartImage.jpg&maxDim=230",
            "PrimaryImageUrlTitle": "PartImage.jpg",
            "ProductAttributes": "WARNING CA Proposition 65: Yes|WARNING CA Proposition 65 Message: WARNING: Cancer and Reproductive Harm - www.P65Warnings.ca.gov",
            "ProductLineBase": "Spark Plug Indexer",
            "RRRLinks": [{
                    "RType": "Recommended",
                    "Links": [
                        {
                            "Text": "Distributor Rotor - (Vehicle Specific)",
                            "Url": "https://api.v12.estore.catalograck.com/API/Lookup/GetPartList?authkey=00000000-0000-0000-0000-000000000000&format=json&RType=REC&univ=V&exppartid=142263&parttype=3751"
                        }
                    ]
                }
            ],
            "SecondaryImageUrls": [
                {
                    "Text": "PartImage2.jpg",
                    "Url": "https://api.v12.estore.catalograck.com/Services/ImageResize.ashx?imageloc=ABC|PartImage2.jpg&maxDim=230"
                }
            ],
            "SuperCategory": "Specialty Merchandise",
            "VehicleSpecificInformation": "Works for all spark plugs",
            "Video":[
                {
                    "Text":"overview.mp4",
                    "Url":"https://api.v12.estore.catalograck.com/ImgVD/ABC/overview.mp4"
                }
            ],
            "WarrantyUrls": [
                {
                    "Text":"Warranty.pdf",
                    "Url":"https://api.v12.estore.catalograck.com/ImgVD/ABC/Warranty.pdf"
                }
            ],
            "BrandImageUrl": "https://api.v12.estore.catalograck.com/Services/ImageResize.ashx?imageloc=ABC|Brand_logo.jpg&maxDim=230",
            "Catalog": "ABC Manufacturing",
            "Description": "Spark Plug Indexer; Motorcycle Spark Plug Copper Index Washers; 30 Pack;",
            "LineCode": "ABC",
            "PartCustomContent": "Custom Content for part",
            "PartImageUrl": null,
            "PartNumber": "200-RT",
            "PartType": "Spark Plug Index Tool",
            "ProductDescriptionCustomContent": "Custom content for product line",
            "VSpec": "Non Spec",
            "ProductLine": "Spark Plug Indexer",
            "GTIN": "00743047910023",
            "Price": 0
        },
        "Status": {
            "Message": "The call (api.v12.estore.catalograck.com) returned successfully with part information.",
            "DataFound": true,
            "TimeStamp": "04/28/2021 12:14:34",
            "InternalError": false
        }
    }
}

Response Fields

API.PartInformation

object

The object containing part information

API.PartInformation.Audio

array [string]

A list of URLs for audio files associated with this part

API.PartInformation.BuyersGuide

string

The URL for the Buyers Guide Image (all vehicles that the part fits)

API.PartInformation.Category

string

The name of containing category

API.PartInformation.Dimensions

object

The size and weight of the package in which it is shipped

API.PartInformation.Dimensions.Depth

decimal

The depth of the package

API.PartInformation.Dimensions.DimUOM

string

The unit of measure of the three size dimensions (Height, Width, Depth)

API.PartInformation.Dimensions.Height

decimal

The height of the package

API.PartInformation.Dimensions.Weight

decimal

The weight of the package

API.PartInformation.Dimensions.Weightuom

string

The unit of measure of the weight

API.PartInformation.Dimensions.Width

string

The width of the package

API.PartInformation.Dimensions.IsFreight

boolean

Whether or not the package ships by freight shipping. Determined by Weight > 90 lbs or any dimension > 96 IN or (largest dim + next dim * 2 + smallest dim * 2) > 120 in

API.PartInformation.Exppartid

integer

DCi's unique id for the part

API.PartInformation.FeaturesAndBenefits

string

A comma-delimited list of features and benefits of the part

API.PartInformation.ImportantInformation

array [string]

Additional import information about the part that does not fit into standard categories

API.PartInformation.InstallationGuideUrl

array [object]

The url to installation media if it exists, otherwise null

API.PartInformation.InstallationGuideUrl.Text

string

The type of document. Always a value of "Installation Instructions"

API.PartInformation.InstallationGuideUrl.Url

string

The URL to the document

API.PartInformation.LargeImageUrl

string

The url to the primary image for the part with the largest dimensions provided without upscaling the image

API.PartInformation.Manufacturer

string

The name of the catalog (brand) of the part

API.PartInformation.MarketingCopy

string

Marketing copy (text information) provided by the manufacturer

API.PartInformation.MsdsUrls

array [object]

A list of links to MSD (Material Safety Data) media. null if none for the part

API.PartInformation.PrimaryImageUrl

string

The primary image for the part, sized to the imgsize parameter

API.PartInformation.PrimaryImageUrlTitle

string

The name of the primary image

API.PartInformation.ProductAttributes

string

A list of product attributes, pipe-delimited

API.PartInformation.ProductLineBase

string

The name of the containing product line

API.PartInformation.RRRLinks

array [object]

A list of link to Recommended, Replacement and Required parts. Recommended parts are parts that are often installed together with this part. Replacement parts are parts that supersede this part. Required Parts are other parts required for installing this part

API.PartInformation.RRRLinks.RType

array [object]

The type of relationship. Valid values: Recommended, Replacement, Required

API.PartInformation.RRRLinks.Links

array [object]

A list of parts that fit the RType for this part

API.PartInformation.RRRLinks.Links.Text

array [object]

A description of the related parts

API.PartInformation.RRRLinks.Links.Url

array [object]

The Url to view the parts

API.PartInformation.SecondaryImageUrls

array [object]

A list of additional images for this part

API.PartInformation.SecondaryImageUrls.Text

string

The name of the image

API.PartInformation.SecondaryImageUrls.Url

string

The Url to the image

API.PartInformation.SuperCategory

string

The name of the containing super category

API.PartInformation.VehicleSpecificInformation

string

Information for the part specific to the vehicle provided. For instance, for brake pads, if they fit the front or rear of the vehicle

API.PartInformation.Video

array [object]

A list of videos for this part

API.PartInformation.Video.Text

string

A description of the video

API.PartInformation.Video.Url

string

The Url to the video

API.PartInformation.WarrantyUrls

array [object]

A list of warranty documents for this part

API.PartInformation.WarrantyUrls.Text

array [object]

The name of the warranty file

API.PartInformation.WarrantyUrls.Url

array [object]

The link to the file

API.PartInformation.BrandImageUrl

string

The URL for the logo of the catalog (brand) containing this part

API.PartInformation.Catalog

string

The name of the catalog (brand) containing this part

API.PartInformation.Description

string

The description of the part

API.PartInformation.GTIN

string

The GTIN for the part. If the two leading numbers are 0, then this is also a UPC code. If first leading number is 0, then it is also an EAN code

API.PartInformation.LineCode

string

The linecode for the catalog (brand) containing this part

API.PartInformation.PartCustomContent

string

Custom information set for this part for the account specified by the authkey

API.PartInformation.PartImageUrl

string

(Deprecated) The main image for this part

API.PartInformation.PartNumber

string

The Part Number for this part

API.PartInformation.PartType

string

The description of the Part Type containing this part

API.PartInformation.ProductDescriptionCustomContent

string

Custom information set for this the product line that includes this part for the account specified by the authkey

API.PartInformation.VehicleSpecificInformation

string

Information for the part specific to the vehicle provided. For instance, for brake pads, if they fit the front or rear of the vehicle

API.PartInformation.ProductLine

string

The description of the Product Line containing this part

API.PartInformation.Price

decimal

This field is not used. Always returns 0

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether or not there was an internal error while processing the request

Try it with your Data

Enter your authentication key at the top to try

Get Years

Returns all vehicle model years relevant to the parts selected for your account

Endpoint

/API/Lookup/GetYears


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "Year": [
            "2022",
            ...
            "1901"
        ],
        "Status": {
            "Message": "The call (api.v12.estore.catalograck.com) returned successfully with years.",
            "DataFound": true,
            "TimeStamp": "05/03/2021 11:24:54",
            "InternalError": false
        }
    }
}

Response Fields

API.Year

array [string]

All valid model years

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether or not there was an internal error while processing the request

Try it with your Data

Enter your authentication key at the top to try

Get Makes

Returns all vehicle makes for the provided year

Endpoint

/API/Lookup/GetMakes


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

year
required

The model year of a vehicle

Example: 2018

Source: A valid value from Get Years field API.Year

format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "Make": [
            "Acura",
            ...
            "Volvo"
        ],
        "Status": {
            "Message": "The call (api.v12.estore.catalograck.com) returned successfully with years.",
            "DataFound": true,
            "TimeStamp": "05/03/2021 11:24:54",
            "InternalError": false
        }
    }
}

Response Fields

API.Make

array [string]

All vehicle makes for the provided query

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether or not there was an internal error while processing the request

Try it with your Data

Enter your authentication key at the top to try

Get Models

Gets all models for the year and make provided

Endpoint

/API/Lookup/GetModels


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

year
required

The model year of a vehicle

Example: 2018

Source: A valid value from Get Years field API.Year

make
required

The make of a vehicle

Example: Ford

Source: A valid value from Get Makes field API.Make

format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "Model": [
            "Courier",
            ...
            "Transit Connect"
        ],
        "Status": {
            "Message": "The call (api.v12.estore.catalograck.com) returned successfully with years.",
            "DataFound": true,
            "TimeStamp": "05/03/2021 11:24:54",
            "InternalError": false
        }
    }
}

Response Fields

API.Model

array [string]

All vehicle models for the provided query

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether or not there was an internal error while processing the request

Try it with your Data

Enter your authentication key at the top to try

Get Submodels

Gets all valid submodels for the provided year, make and model

Endpoint

/API/Lookup/GetSubModels


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

year
required

The model year of a vehicle

Example: 2018

Source: A valid value from Get Years field API.Year

make
required

The make of a vehicle

Example: Ford

Source: A valid value from Get Makes field API.Make

model
required

The model of a vehicle

Example: F-150

Source: A valid value from Get Models field API.Model

format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "Submodel": [
            "King Ranch",
            ...
            "XLT"
        ],
        "Status": {
            "Message": "The call (api.v12.estore.catalograck.com) returned successfully with years.",
            "DataFound": true,
            "TimeStamp": "05/03/2021 11:24:54",
            "InternalError": false
        }
    }
}

Response Fields

API.Submodel

array [string]

All vehicle submodels for the query

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether or not there was an internal error while processing the request

Try it with your Data

Enter your authentication key at the top to try

Get Engines

Gets all engines for provided query

Endpoint

/API/Lookup/GetEngines


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

year
required

The model year of a vehicle

Example: 2018

Source: A valid value from Get Years field API.Year

make
required

The make of a vehicle

Example: Ford

Source: A valid value from Get Makes field API.Make

model
required

The model of a vehicle

Example: F-150

Source: A valid value from Get Models field API.Model

submodel
required

The submodel (trim) of a vehicle

Example: King Ranch

Source: A valid value from Get Submodels field API.Submodel

format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "Engine": [
            "V6 3.0L 183-CID FI T Power-Stroke ",
            ...
            "V8 5.0L 302-CID FI N "
        ],
        "Status": {
            "Message": "The call (api.v12.estore.catalograck.com) returned successfully with years.",
            "DataFound": true,
            "TimeStamp": "05/03/2021 11:24:54",
            "InternalError": false
        }
    }
}

Response Fields

API.Engine

array [string]

All engines for the query. If no engines specified, returns "All" as the only item

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether or not there was an internal error while processing the request

Try it with your Data

Enter your authentication key at the top to try

Get Catalogs

Gets basic identifying information for catalogs (brands)

Endpoint

/API/Lookup/GetCatalogs


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

parttypeid

The Id of a part type

Example: 3135

Source: A valid value from Get Part Types field API.PartType.Id

categoryid

The ID of a category

Example: 62

Source: A valid value from Get Categories field API.Category.Items.Id

vehicleinfo

A pipe-delimited string of vehicle information

Format: year|make|model|submodel|engine|fuel|aspiration

Example: 2018|Ford|Pickup F-150|King Ranch|V6 3.5L |FI|T

Source: year: A valid value from Get Years field API.Year
make: A valid value from Get Makes field API.Make
model: A valid value from Get Models field API.Model
submodel: A valid value from Get Submodels field API.Submodel
engine: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Engine
fuel: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Fuel
aspiration: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Aspiration
format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "Catalog": [
            {
                "Name": "ABC Manufacturing",
                "Linecode": "ABC",
                "AAIA": "ZABC",
                "ID": "543"
            },
            ...
            {
                "Name": "XYZ Company",
                "Linecode": "XYZ",
                "AAIA": "AXYZ",
                "ID": "3522"
            }
        ],
        "Status": {
            "Message": "The call (api.v12.estore.catalograck.com) returned successfully with years.",
            "DataFound": true,
            "TimeStamp": "05/03/2021 11:24:54",
            "InternalError": false
        }
    }
}

Response Fields

API.Catalog

array [object]

A list of all catalogs (brands) for the query

Catalog.Name

string

The catalog (brand) name from the manufacturer

Catalog.Linecode

string

DCi code for the catalog (brand)

Catalog.AAIA

string

The AAIA code for the catalog (brand)

Catalog.ID

string

The DCi ID for the catalog (brand)

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether or not there was an internal error while processing the request

Try it with your Data

Enter your authentication key at the top to try

Get Catalog Parts

Gets a list of all part numbers for a catalog (brand)

Endpoint

/API/Lookup/GetCatalogParts


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

linecode

The three character DCi code for a catalog (brand)

Example: ACL

Source: A valid value from Get Catalogs field Catalog.Linecode

aaia

The four character AAIA code for a catalog (brand)

Example: BDDP

Source: A valid value from Get Catalogs field Catalog.AAIA

format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "Part": [
            "0416S-4",
            ...
            "Y2418P"
        ],
        "Status": {
            "Message": "The call (api.v12.estore.catalograck.com) returned successfully with years.",
            "DataFound": true,
            "TimeStamp": "05/03/2021 11:24:54",
            "InternalError": false
        }
    }
}

Response Fields

API.Part

array [string]

All part numbers for the catalog

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether or not there was an internal error while processing the request

Try it with your Data

Enter your authentication key at the top to try

Get Manufacturer Information

Returns Expanded information about catalogs (brands)

Endpoint

/API/Lookup/GetManufacturerInformation


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "Manufacturer": [
            {
                "Name": "ABC Manufacturing",
                "About": "ABC Manufacturing, LLC was established in 1901 but our family has been in the business virtually from the beginning. Grandpa Joe, started auto sound work back in the early 1930's and we continued to expand with new family members joining into the 1950's with factory training from Ford, GM and Chrysler. As technology grew, we realized that the internet was the place to be and in the late 1990's, started buying and selling radios online. We were amazed by what we saw; extremely high prices from specialists and junkyards with huge amounts of negative feedback and obvious quality issues. With a clear opportunity for improvement, we started offering clean, fully functioning, professionally remanufactured radios at a low price with a warranty. Our cores are purchased from a range of sources; everything from OEM closeout to core suppliers to customer core returns and more. We then fully remanufacture them from the chassis up, many with upgrades such as Bluetooth, aux input, RCA outputs for aftermarket amps, custom colors and more so you can have that original, factory look with modern functionality. Many radio parts and components which are no longer available such as knobs, mounts and display lenses are manufactured in-house to a higher standard and durability than the originals. Perhaps most importantly, our customer service is second to none so you can rest assured that we'll be here via phone or email if you have any questions or concerns before, during or after installation. We now have the largest inventory coverage of factory car audio in the USA so be sure to get in touch for your radio needs. ABC Manufacturing is first among OEM radio suppliers!",
                "PartTypes": "Audio Amplifier, CD Changer, CD Changer Cartridge, CD Player, Cassette Player, DVD Player, HD Radio Tuner, HVAC Control Module, HVAC Control Panel, Radio, Radio Bezel, Radio Cover, Radio Module Interface, Radio Receiver Box, Touch Screen Infotainment Display",
                "ImgUrl": "https://imagesrv.v12.estore.catalograck.com/ImgVD/ABC\\ABC_logo.jpg",
                "LineCode": "ABC",
                "AAIA": "ZABC"
            }
        ],
        "Status": {
            "Message": "The call (api.v12.estore.catalograck.com) returned successfully with manufacturer information.",
            "DataFound": true,
            "TimeStamp": "04/23/2021 11:34:08",
            "InternalError": false
        }
    }
}

Response Fields

API.Manufacturer

array [object]

A list of all Catalogs (brands) with expanded information

API.Manufacturer.Name

string

The name of the Catalog (brand)

API.Manufacturer.About

string

A paragraph of information about the Catalog (brand)

API.Manufacturer.PartTypes

string

A comma-delimited string of all Part Types (by name) that the catalog manufacturers

API.Manufacturer.ImgUrl

string

The link to the Catalog's (brand) logo

API.Manufacturer.LineCode

string

DCi code for the catalog (brand)

API.Manufacturer.AAIA

string

The AAIA code for the catalog (brand)

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether or not there was an internal error while processing the request

Try it with your Data

Enter your authentication key at the top to try

Get Hierarchy

Gets each step in the parts hierarchy for navigating to a less specific level. This is in the form of Super Category, Category, Part Type, Product Line, Part List, Part Number.

Endpoint

/API/Lookup/GetHierarchy


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

supercategory

the Id of a super category

Example: 3

Source: A valid value from Get Categories field API.Category.GroupID

category

The category id and optionally the category name, pipe-delimited

Format: id|name

Example: 43|Tonneau Cover

Source: id: A valid value from Get Categories field API.Category.Items.Id
name: A valid value from Get Categories field API.Category.Items.Value
parttype

The part type Id and optionally the part type name, pipe-delimited

Format: id|name

Example: 3135|Tonneau Cover

Source: id: A valid value from Get Part Types field API.PartType.Id
name: A valid value from Get Part Types field API.PartType.Value
prodDescr

The Product Line Id and optionally the Product Line name, pipe-delimited

Format: id|name

Example: 19455|Roll-Up Cover

Source: id: A valid value from Get Product Lines field API.ProductLines.ProductLines.ProductLineID
name: A valid value from Get Product Lines field API.ProductLines.ProductLines.Description
aaia

The four character AAIA code for a catalog (brand)

Example: BDDP

Source: A valid value from Get Catalogs field Catalog.AAIA

linecode

The three character DCi code for a catalog (brand)

Example: ACL

Source: A valid value from Get Catalogs field Catalog.Linecode

partnumber

the part identifier assigned by the manufacturer

Example: EX4110-T

Source: A valid value from Get Catalog Parts field API.Part
A valid value from Get Part List field API.PartList.PartItems.PartNumber
univ

A one character identifier used to filter parts by whether or not they are universal fit or vehicle-specific

Default Value: A

Valid Values: A (All), V (Vehicle-Specific), U (Universal)

vehicleinfo

A pipe-delimited string of vehicle information

Format: year|make|model|submodel|engine|fuel|aspiration

Example: 2018|Ford|Pickup F-150|King Ranch|V6 3.5L |FI|T

Source: year: A valid value from Get Years field API.Year
make: A valid value from Get Makes field API.Make
model: A valid value from Get Models field API.Model
submodel: A valid value from Get Submodels field API.Submodel
engine: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Engine
fuel: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Fuel
aspiration: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Aspiration
pqs

A list of Part Qualifiers (options) to refine query results, comma-separated with individual parts of each pq being pipe-delimited

Format: id|category|name,id|category|name

Example: 30423|Actual Color|Abalone White,32730|Full Bed Access|No

Source: id: A valid value from Get Part List field API.PartList.Filters.Filter.Id when API.PartList.Filters.Type = PQ
category: A valid value from Get Part List field API.PartList.Filters.Type when API.PartList.Filters.Type = PQ
name: A valid value from Get Part List field API.PartList.Filters.Filter.Name when API.PartList.Filters.Type = PQ
vqs

A list of Vehicle Qualifiers (options) to refine query results, comma-separated with individual parts of each vq being pipe-delimited

Format: id|category|name,id|category|name

Example: 2002|Axle|Front 8.8 in. Reverse,2131|BED STYLE|67.1 in./5 ft. 7.1 in. Bed

Source: id|category|name: A valid value from Get VQs field API.VQGroups.VQs.QualifiedId
id: A valid value from Get Part List field API.PartList.Filters.Filter.Id when API.PartList.Filters.Type = VQ
category: A valid value from Get Part List field API.PartList.Filters.Type when API.PartList.Filters.Type = VQ
name: A valid value from Get Part List field API.PartList.Filters.Filter.Name when API.PartList.Filters.Type = VQ
imgsize

The number of pixels in length of the longer dimension of a photo. This sets the maxDim on image links for the query

Default Value: 72

itemsPerPage

The number of items returned per page. For non-paginated queries, is used to build links for other queries

Default Value: 50

format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "Hierarchy": {
            "Levels": [
                {
                    "Text": "Exterior Accessories",
                    "Url": "https://api.v12.estore.catalograck.com/API/Lookup/GetCategories?authkey=00000000-0000-0000-0000-000000000000&supercategory=2|Exterior Accessories&format=json"
                },
                {
                    "Text": "Tonneau Cover",
                    "Url": "https://api.v12.estore.catalograck.com/API/Lookup/GetPartTypes?authkey=00000000-0000-0000-0000-000000000000&categoryid=43&format=json"
                },
                {
                    "Text": "Tonneau Cover",
                    "Url": "https://api.v12.estore.catalograck.com/API/Lookup/GetProductLines?authkey=00000000-0000-0000-0000-000000000000&parttype=3135|Tonneau Cover&brand=540|ABC Manufacturing&format=json"
                },
                {
                    "Text": "Invisible Roll-Up Cover",
                    "Url": "https://api.v12.estore.catalograck.com/API/Lookup/GetPartList?authkey=00000000-0000-0000-0000-000000000000&productline=19455|Invisible Roll-Up Cover&brand=540|ABC Manufacturing&format=json"
                },
                {
                    "Text": "ABC Manufacturing - A1234BC",
                    "Url": "https://api.v12.estore.catalograck.com/API/Lookup/GetPartInformation?authkey=00000000-0000-0000-0000-000000000000&partnumber=A1234BC&linecode=ABC&format=json"
                }
            ]
        },
        "Status": {
            "Message": "The call (api.v12.estore.catalograck.com) returned successfully with hierarchy levels.",
            "DataFound": true,
            "TimeStamp": "04/26/2021 10:52:16",
            "InternalError": false
        }
    }
}

Response Fields

API.Hierarchy

object

Contains a list of levels of the hierarchy down to the level of the level passed into the request, based on parameter used

API.Hierarchy.Levels

array [object]

A list of levels to the hierarchy by array position: 0 - Super Category, 1 - Category, 2 - Part Type, 3 - Product Line, 4 - Part Information

API.Hierarchy.Levels.Text

string

The description of the identifier for that level

API.Hierarchy.Levels.Url

string

The Url to get items within the level. For instance the part type level (2) will take you to all product lines in that part type. The Part Information level (4) will take you to the part information

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether or not there was an internal error while processing the request

Try it with your Data

Enter your authentication key at the top to try

Verify Fitment

Verifies if a part fits the given vehicle. If there is not enough information to verify, it will return additional options to specify required information

Endpoint

/API/Lookup/VerifyFitment


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

vehicleinfo
required

A pipe-delimited string of vehicle information

Format: year|make|model|submodel|engine|fuel|aspiration (NOTE: leave off any trailing pipes for levels not provided)

Example: 2017|Honda|Odyssey

Source: year: A valid value from Get Years field API.Year
make: A valid value from Get Makes field API.Make
model: A valid value from Get Models field API.Model
submodel: A valid value from Get Submodels field API.Submodel
engine: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Engine
fuel: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Fuel
aspiration: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Aspiration
partnumber
required

the part identifier assigned by the manufacturer

Example: EX4110-T

Source: A valid value from Get Catalog Parts field API.Part
A valid value from Get Part List field API.PartList.PartItems.PartNumber
aaia

The four character AAIA code for a catalog (brand)

Example: BDDP

Source: A valid value from Get Catalogs field Catalog.AAIA

linecode

The three character DCi code for a catalog (brand)

Example: ACL

Source: A valid value from Get Catalogs field Catalog.Linecode

vqs

A list of Vehicle Qualifier Ids, pipe-delimited

Format: id|id|..|id

Example: 2002|2131

Source: id: A valid value from Get VQs field API.VQGroups.VQs.Id
id: A valid value from Get Part List field API.PartList.Filters.Filter.Id when API.PartList.Filters.Type = VQ
relevantonly

When returning additional required fields, sets whether or not it returns only options that will fit the vehicle to the part

Default Value: 0

Valid Values: 0 (false), 1 (true)

format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "VerifyFitment": {
            "PartNumber": "A1234BC",
            "LineCode": "ABC",
            "AAIA": null,
            "DoesFit": false,
            "VerifyComplete": false,
            "RequiredOptions": [
                {
                    "Segment": "Submodel",
                    "Text": "EX",
                    "ID": "EX",
                    "VerifyURL": "https://api.v12.estore.catalograck.com/API/Lookup/VerifyFitment/?authkey=00000000-0000-0000-0000-000000000000&vehicleinfo=2017|Honda|Odyssey|EX&partnumber=A1234BC&aaia=&linecode=ABC&vqs=&prefixed=False&format=json"
                },
                ...
                {
                    "Segment": "Submodel",
                    "Text": "Touring Elite",
                    "ID": "Touring Elite",
                    "VerifyURL": "https://api.v12.estore.catalograck.com/API/Lookup/VerifyFitment/?authkey=00000000-0000-0000-0000-000000000000&vehicleinfo=2017|Honda|Odyssey|Touring Elite&partnumber=A1234BC&aaia=&linecode=ABC&vqs=&prefixed=False&format=json"
                }
            ]
        },
        "Status": {
            "Message": "The call (api.v12.estore.catalograck.com) returned successfully with years.",
            "DataFound": true,
            "TimeStamp": "05/03/2021 11:24:54",
            "InternalError": false
        }
    }
}

Response Fields

API.VerifyFitment

object

Object containing fitment information

API.VerifyFitment.AAIA

string

The AAIA code provided

API.VerifyFitment.AADoesFitIA

boolean

true or false if all vehicle information required is provided. Otherwise null

API.VerifyFitment.LineCode

string

The linecode provided

API.VerifyFitment.PartNumber

string

The part number provided

API.VerifyFitment.RequiredOptions

array [object]

A list of options to complete the required information to check for fitment

API.VerifyFitment.RequiredOptions.Segment

string

The level of information of the required option. Possible Values: Year, Make, Model, Submodel, Engine, Fuel, Aspiration

API.VerifyFitment.RequiredOptions.ID

string

Also the Value of the option

API.VerifyFitment.RequiredOptions.Text

string

The Value of the option

API.VerifyFitment.RequiredOptions.VerifyURL

string

The Url for selecting the option to verify the at that level

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether or not there was an internal error while processing the request

Try it with your Data

Enter your authentication key at the top to try

Get Pricing

Returns pricing, shipping and availability information for a part.

Endpoint

/API/Lookup/GetPricing


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

partnumber
required

the part identifier assigned by the manufacturer

Example: EX4110-T

Source: A valid value from Get Catalog Parts field API.Part
A valid value from Get Part List field API.PartList.PartItems.PartNumber
linecode

The three character DCi code for a catalog (brand)

Example: ACL

Source: A valid value from Get Catalogs field Catalog.Linecode

aaia

The four character AAIA code for a catalog (brand)

Example: BDDP

Source: A valid value from Get Catalogs field Catalog.AAIA

format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "Pricing": {
            "PartNumber": "1002E",
            "Linecode": "ABC",
            "AAIA": "WXYZ",
            "Jobber": 48.16,
            "MAP": 43.34,
            "Unilateral": 0,
            "Retail": 48.16,
            "Sell": 43.34,
            "List": 43.73,
            "Currency": "USD",
            "Cost": 48.16,
            "Availability": "C",
            "Height": 6.7,
            "Width": 3.9,
            "Depth": 0.8,
            "Weight": 0.35,
            "WeightUOM": "LB"
        },
        "Status": {
            "Message": "The call (api.v12.estore.catalograck.com) returned successfully with years.",
            "DataFound": true,
            "TimeStamp": "05/03/2021 11:24:54",
            "InternalError": false
        }
    }
}

Response Fields

API.Pricing

object

Object containing pricing, shipping and availability information

API.Pricing.PartNumber

object

The Part Number of the queried part

API.Pricing.Linecode

string

The DCi three character code for the catalog containing the queried part

API.Pricing.AAIA

string

The AAIA four character code for the catalog containing the queried part

API.Pricing.Jobber

decimal

The Jobber price for the part as set by the manufacturer

API.Pricing.MAP

decimal

The Minimum Advertised Price (MAP) price for the part as set by the manufacturer

API.Pricing.Unilateral

decimal

The Unilateral price for the part as set by the manufacturer

API.Pricing.Retail

decimal

The Retail price for the part as set by the manufacturer

API.Pricing.Sell

decimal

The Sell price for the part as set for the account, identified by the authkey parameter

API.Pricing.List

decimal

The List price for the part as set for the account, identified by the authkey parameter

API.Pricing.Currency

string

The three character currency code for all prices

API.Pricing.Cost

decimal

The Cost price for the part as set by the manufacturer

API.Pricing.Availability

string

The one character availability code of the part. Valid Values: A (Available), C (Contact for availability), R (By Request), B (Back Order)

API.Pricing.Height

decimal

The height of the package in inches

API.Pricing.Width

decimal

The width of the package in inches

API.Pricing.Depth

decimal

The depth of the package in inches

API.Pricing.Weight

decimal

The weight of the package

API.Pricing.WeightUOM

string

the unit of measurement of the weight

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether or not there was an internal error while processing the request

Try it with your Data

Enter your authentication key at the top to try

Get Pricing List

Returns pricing, shipping and availability information for a list of part.

Endpoint

/API/Lookup/GetPricingList


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

partnumber
required

a List of the part identifiers assigned by the manufacturer, pipe-delimited. The items in either linecode or aaia must be in the same order as the part numbers

Format: PartNumber 1|PartNumber 2|[...]|PartNumber N

Example: PACVB-2002BK|969552|958292

Source: A valid value from Get Catalog Parts field API.Part
A valid value from Get Part List field API.PartList.PartItems.PartNumber
linecode

A list of three character DCi code for a catalog (brand). These must be in the same order as the partnumber parameter

Format: linecode 1|linecode 2|[...]|linecode N

Example: DMP|LUN|LUN

Source: A valid value from Get Catalogs field Catalog.Linecode

aaia

A list of four character AAIA code for a catalog (brand). These must be in the same order as the partnumber parameter

Format: AAIA 1|AAIA 2|[...]|AAIA N

Example: HVVF|BFKJ|BFKJ

Source: A valid value from Get Catalogs field Catalog.AAIA

format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "Pricing": [
            {
                "PartNumber": "A1234BC",
                "Linecode": "ABC",
                "AAIA": "WXYZ",
                "Jobber": 583.3,
                "MAP": 359,
                "Unilateral": 0,
                "Retail": 689.99,
                "Sell": 359.00,
                "List": 448.75,
                "Currency": "USD",
                "Cost": 583.30,
                "Availability": "A",
                "Height": 5,
                "Width": 30,
                "Depth": 74,
                "Weight": 27,
                "WeightUOM": "LB"
            },
            ...
            {
                "PartNumber": "100121",
                "Linecode": "DEF",
                "AAIA": "HIJK",
                "Jobber": 20,
                "MAP": 0,
                "Unilateral": 0,
                "Retail": 20,
                "Sell": 26.44,
                "List": 26.44,
                "Currency": "USD",
                "Cost": 20.00,
                "Availability": "C",
                "Height": 6.85,
                "Width": 4.13,
                "Depth": 4.13,
                "Weight": 0.44,
                "WeightUOM": "LB"
            }
        ],
        "Status": {
            "Message": "The call (api.v12.estore.catalograck.com) returned successfully with years.",
            "DataFound": true,
            "TimeStamp": "05/03/2021 11:24:54",
            "InternalError": false
        }
    }
}

Response Fields

API.Pricing

array [object]

A list of objects containing pricing, shipping and availability information

API.Pricing.PartNumber

object

The Part Number of the queried part

API.Pricing.Linecode

string

The DCi three character code for the catalog containing the queried part

API.Pricing.AAIA

string

The AAIA four character code for the catalog containing the queried part

API.Pricing.Jobber

decimal

The Jobber price for the part as set by the manufacturer

API.Pricing.MAP

decimal

The Minimum Advertised Price (MAP) price for the part as set by the manufacturer

API.Pricing.Unilateral

decimal

The Unilateral price for the part as set by the manufacturer

API.Pricing.Retail

decimal

The Retail price for the part as set by the manufacturer

API.Pricing.Sell

decimal

The Sell price for the part as set for the account, identified by the authkey parameter

API.Pricing.List

decimal

The List price for the part as set for the account, identified by the authkey parameter

API.Pricing.Currency

string

The three character currency code for all prices

API.Pricing.Cost

decimal

The Cost price for the part as set by the manufacturer

API.Pricing.Availability

string

The one character availability code of the part. Valid Values: A (Available), C (Contact for availability), R (By Request), B (Back Order)

API.Pricing.Height

decimal

The height of the package in inches

API.Pricing.Width

decimal

The width of the package in inches

API.Pricing.Depth

decimal

The depth of the package in inches

API.Pricing.Weight

decimal

The weight of the package

API.Pricing.WeightUOM

string

the unit of measurement of the weight

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether or not there was an internal error while processing the request

Try it with your Data

Enter your authentication key at the top to try

Get VQs

Returns Vehicle Qualifier Options for the provided vehicle. If any VQs are provided, the containing VQ Group will be filtered out of results

Endpoint

/API/Lookup/GetVQs


Parameters

authkey
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

vehicleinfo
required

A pipe-delimited string of vehicle information

Format: year|make|model|submodel|engine|fuel|aspiration (NOTE: leave off any trailing pipes for levels not provided)

Example: 2017|Honda|Odyssey

Source: year: A valid value from Get Years field API.Year
make: A valid value from Get Makes field API.Make
model: A valid value from Get Models field API.Model
submodel: A valid value from Get Submodels field API.Submodel
engine: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Engine
fuel: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Fuel
aspiration: A valid value from Verify Fitment field API.VerifyFitment.RequiredOptions.ID when API.VerifyFitment.RequiredOptions.Segment = Aspiration
aaia

The four character AAIA code for a catalog (brand)

Example: BDDP

Source: A valid value from Get Catalogs field Catalog.AAIA

linecode

The three character DCi code for a catalog (brand)

Example: ACL

Source: A valid value from Get Catalogs field Catalog.Linecode

parttype

The part type Id and optionally the part type name, pipe-delimited

Format: id|name

Example: 3135|Tonneau Cover

Source: id: A valid value from Get Part Types field API.PartType.Id
name: A valid value from Get Part Types field API.PartType.Value
productline

The product line Id and optionally the product line name, pipe-delimited

Format: id|name

Example: 19455|Roll-Up Cover

Source: id: A valid value from Get Product Lines field API.ProductLines.ProductLines.ProductLineID
name: A valid value from Get Product Lines field API.ProductLines.ProductLines.Description
vqs

A list of Vehicle Qualifiers (options) to refine query results, comma-separated with individual parts of each vq being pipe-delimited

Format: id|category|name,id|category|name

Example: 2002|Axle|Front 8.8 in. Reverse,2131|BED STYLE|67.1 in./5 ft. 7.1 in. Bed

Source: id|category|name: A valid value from Get VQs field API.VQGroups.VQs.QualifiedId
id: A valid value from Get Part List field API.PartList.Filters.Filter.Id when API.PartList.Filters.Type = VQ
category: A valid value from Get Part List field API.PartList.Filters.Type when API.PartList.Filters.Type = VQ
name: A valid value from Get Part List field API.PartList.Filters.Filter.Name when API.PartList.Filters.Type = VQ
format

The format in which the response will be returned

Default Value: JSON

Valid Values: JSON, XML


Example Response

{
    "API": {
        "VQGroups": [
            {
                "Id": 173,
                "Name": "Axle",
                "VQs": [
                    {
                        "Id": 2002,
                        "Name": "Front 8.8 in. Reverse",
                        "QualifiedId": "2002|Front 8.8 in. Reverse|Axle"
                    },
                    {
                        "Id": 2020,
                        "Name": "Rear 10.5 in. (14 Bolt)",
                        "QualifiedId": "2020|Rear 10.5 in. (14 Bolt)|Axle"
                    }
                ]
            },
            {
                "Id": 194,
                "Name": "BED STYLE",
                "VQs": [
                    {
                        "Id": 2131,
                        "Name": "67.1 in./5 ft. 7.1 in. Bed",
                        "QualifiedId": "2131|67.1 in./5 ft. 7.1 in. Bed|BED STYLE"
                    },
                    {
                        "Id": 2130,
                        "Name": "78.9 in./6 ft. 6.9 in. Bed",
                        "QualifiedId": "2130|78.9 in./6 ft. 6.9 in. Bed|BED STYLE"
                    }
                ]
            }
        ],
        "Status": {
            "Message": "The call (localhost:63251) returned successfully with VQ groups.",
            "DataFound": true,
            "TimeStamp": "05/03/2021 11:24:54",
            "InternalError": false
        }
    }
}

Response Fields

API.VQGroups

array [object]

A list of objects representing VQ groups and their options

API.VQGroups.Id

integer

The Id of the Vehicle Qualifier group

API.VQGroups.Name

string

The Name of the Vehicle Qualifier group

API.VQGroups.VQs

array [object]

All of the options for the VQ Group

API.VQGroups.VQs.Id

integer

The Id for the VQ Option

API.VQGroups.VQs.Name

string

The Name for the VQ Option

API.VQGroups.VQs.QualifiedId

string

The Qualified Id of the VQ option. This can be passed directly into VQ Parameters in other calls

Try it with your Data

Enter your authentication key at the top to try

Copyright © 2024 DCi CatalogRack. All Rights Reserved.
Covered by one or more claims of U.S. Patent No. 5,367,627. DCi is a registered trademark of Direct Communications Inc.