Home

SEMA Data API


Introduction

The SEMA Data API is an evolving data entrypoint for suppliers and receivers of data alike. The overarching goal is to provide performant, best-in-breed webservices tailored to our members' needs.

Please review our terms of service.


Getting Started

Starting April 8th, 2024 a SEMA Data Subscription is required to use the SEMA API and Plugin APIs. The Data Subscription can be added to your account here.

A rate limit has been implemented based on the number of calls per minute. Your rate is tracked and returned to you in the HTTP response header "x-rate-limit-remaining", counting down from your allowed amount and resetting each minute.

If you are unfamiliar with the Auto Care PIES standard, please refer to the following spreadsheet for information on the available fields when accessing product data.

The first step in accessing the API is getting a security token. This token can be reused for subsequent API calls. Provide your PIMS (or SEMA Search) username and password 

HTTP GET: https://apps.semadata.org/sdapi/v2/token/get?userName=YOUR_USERNAME&password=YOUR_PASSWORD

Note: The SDC API response format is JSON by default. We encourage all of our partners to use this extremely lean format as less data will be transferred by comparison to XML.

To request XML data delivery, please specify "Accept: text/xml" in your request header.
For further reading on the benefits of JSON, click here.


On valid authentication, the token response will reply with a success property true and your token, or false, with a reason on why the authentication failed. Example success response:

JSON response
                    {
                    "success": true,
                    "message": "",
                    "token": "abcd12345"
                    }
XML response
<tokenresponse>
  <success>true</success>
  <message />
  <token>abcd12345</token>
</tokenresponse>


Products

Products

Returns all the part numbers for a Brand AAIA ID

HTTP GET: https://apps.semadata.org/sdapi/v2/products?token={TOKEN}&brandaaiaid={AAIA BRAND ID}

Required parameters

Parameter
Usage
Purpose
Token

Token=a123b456c
Verifies user authentication and data authorization
BrandAAIAID
BrandAAIAID=ABCD
Filters the results by an AAIA Brand ID
JSON response
{
  "PartNumbers": [
    "RC-3690",
    "RC-3690DK",
    "RC-4160DK",
    "RC-4381",
    "RC-4570",
    "RC-4580",
    "RC-4630DK",
    "RC-4700DL",
    "RC-4760",
    "RC-4780",
    "RC-4780DK",
    "RC-4840",
    "RC-4900",
    "77-9043KP",
    "BM-1324"
  ],
  "Success": true,
  "Message": ""
}
XML response
<ProductResponse>
  <Success>true</<Success>
    <Message />
    <PartNumbers>
      <string>RC-3690</string>
      <string>RC-3690DK</string>
      <string>RC-4160DK</string>
      <string>RC-4381</<string>
      <string>RC-4570</string>
      <string>RC-4580</string>
      <string>RC-4630DK</string>
      <string>RC-4700DL</string>
      <string>RC-4760</string>
      <string>RC-4780</string>
      <string>RC-4780DK</string>
      <string>RC-4840</<string>
      <string>RC-4900</string>
      <string>77-9043KP</<string>
      <string>BM-1324</string>
    </PartNumbers>
</ProductResponse>

Attributes

PIES defined and custom attributes assigned to a product

HTTP GET: https://apps.semadata.org/sdapi/v2/products/attribute?token={TOKEN}&brandaaiaid={AAIA BRAND ID}&partnumber={PART NUMBER}

Required parameters

Parameter
Usage
Purpose
Token

Token=a123b456c
Verifies user authentication and data authorization
BrandAAIAID
BrandAAIAID=ABCD
Filters the results by an AAIA Brand ID
PartNumber
PartNumber=xyz-123
Filters the results by a part number

Optional parameters

Parameter
Usage
Purpose
AttributeCodes

AttributeCodes=Weight
&AttributeCodes=Warranty
Filters the results by specific attribute codes
JSON response
{
  "Attributes": [
    {
      "Code": "Weight",
      "IsPADBAttribute": false,
      "UoM": "",
      "Value": "0 lb (0 kg)"
    },
    {
      "Code": "Warranty",
      "IsPADBAttribute": false,
      "UoM": "",
      "Value": "1 Year Limited"
    }
  ],
  "Success": true,
  "Message": ""
}
XML response
<ProductAttributeResponse>
  <Success>true</Success>
  <Message />
  <Attributes>
    <Attribute>
      <Code>Weight</<Code>
      <IsPADBAttribute>false</<IsPADBAttribute>
      <UoM />
      <Value>0 lb (0 kg)</<Value>
    </<Attribute>
    <Attribute>
      <Code>Warranty</Code>
      <IsPADBAttribute>false</<IsPADBAttribute>
      <UoM />
      <Value>1 Year Limited</Value>
    </Attribute>
  </Attributes>
</ProductAttributeResponse>

Descriptions

Descriptions assigned to a product

HTTP GET: https://apps.semadata.org/sdapi/v2/products/description?token={TOKEN}&brandaaiaid={AAIA BRAND ID}&partnumber={PART NUMBER}

Required parameters

Parameter
Usage
Purpose
Token

Token=a123b456c
Verifies user authentication and data authorization
BrandAAIAID
BrandAAIAID=ABCD
Filters the results by an AAIA Brand ID
PartNumber
PartNumber=xyz-123
Filters the results by a part number

Optional parameters

Parameter
Usage
Purpose
DescriptionCodes

DescriptionCodes=FAB
&DescriptionCodes=DEF
Filters the results by specific description codes
JSON response
{
  "Descriptions": [
    {
      "Code": "DEF",
      "Values": [
        "Air Filter Wrap"
      ],
      "Language": "EN"
    },
    {
      "Code": "DES",
      "Values": [
        "Air Filter Wrap"
      ],
      "Language": "EN"
    },
    {
      "Code": "FAB",
      "Values": [
        "This product wraps your air filter with an additional pre-filter",
        "Extends service interval of your K&N filter",
        "Durable silicone treated polyester material with stitched elastic openings",
        "Water repellent treatment typically lasts 1 to 2 years"
      ],
      "Language": "EN"
    }
  ],
  "Success": true,
  "Message": ""
}
XML response
<ProductDescriptionResponse>
  <Success>true</<Success>
  <Message />
  <Descriptions>
    <Description>
      <Code>DEF</Code>
       <Values>
        <string>Air Filter Wrap</<string>
      </Values>
      <Language>EN</Language>
    </Description>
    <Description>
      <Code>DES</Code>
      <Values>
        <string>Air Filter Wrap</string>
      </Values>
      <Language>EN</Language>
    </<Description>
    <Description>
      <Code>FAB</Code>
      <Values>
        <string>This product wraps your air filter with an additional pre-filter</string>
        <string>Extends service interval of your K&N filter</string>
        <string>Durable silicone treated polyester material with stitched elastic openings</string>
        <string>Water repellent treatment typically lasts 1 to 2 years</<string>
      </Values>
      <Language>EN</Language>
    </Description>
  </Descriptions>
</ProductDescriptionResponse>

Digital Assets

Digital assets assigned to a product

HTTP GET: https://apps.semadata.org/sdapi/v2/products/digitalasset?token={TOKEN}&brandaaiaid={AAIA BRAND ID}&partnumber={PART NUMBER}

Required parameters

Parameter
Usage
Purpose
Token

Token=a123b456c
Verifies user authentication and data authorization
BrandAAIAID
BrandAAIAID=ABCD
Filters the results by an AAIA Brand ID
PartNumber
PartNumber=xyz-123
Filters the results by a part number

Optional parameters

Parameter
Usage
Purpose
DigitalAssetCodes

DigitalAssetCodes=P04
&DigitalAssetCodes=LGO
Filters the results by specific digital asset codes
JSON response
{
  "DigitalAssets": [
    {
      "Code": "PAG",
      "Value": "https://www.knfilters.com/rc-3690dk-air-filter-wrap"
    },
    {
      "Code": "P04",
      "Value": "https://kandn.com/images/l/RC-3690DK.jpg"
    },
    {
      "Code": "ZZ8",
      "Value": "https://www.youtube.com/watch?v=RgMlKrLbq20"
    },
    {
      "Code": "LGO",
      "Value": "https://kandn.com/images/l/kn_logo-Rev1.jpg"
    }
  ],
  "Success": true,
  "Message": ""
}
XML response
<ProductDigitalAssetResponse>
  <Success>true</Success>
  <Message />
  <DigitalAssets>
    <DigitalAsset>
      <Code>PAG</Code>
      <Value>https://www.knfilters.com/rc-3690dk-air-filter-wrap</Value>
    </DigitalAsset>
    <DigitalAsset>
      <Code>P04</Code>
      <Value>https://kandn.com/images/l/RC-3690DK.jpg</Value>
    </DigitalAsset>
    <DigitalAsset>
      <Code>ZZ8</Code>
      <Value>https://www.youtube.com/watch?v=RgMlKrLbq20</Value>
    </<DigitalAsset>
    <DigitalAsset>
      <Code>LGO</Code>
      <Value>https://kandn.com/images/l/kn_logo-Rev1.jpg</<Value>
    </DigitalAsset>
  </DigitalAssets>
</ProductDigitalAssetResponse>

Item Segments

Item details assigned to a product

HTTP GET: https://apps.semadata.org/sdapi/v2/products/itemsegment?token={TOKEN}&brandaaiaid={AAIA BRAND ID}&partnumber={PART NUMBER}

Required parameters

Parameter
Usage
Purpose
Token

Token=a123b456c
Verifies user authentication and data authorization
BrandAAIAID
BrandAAIAID=ABCD
Filters the results by an AAIA Brand ID
PartNumber
PartNumber=xyz-123
Filters the results by a part number
JSON response
{
  "ItemSegment": {
    "AvailableDate": "2004-11-17T00:00:00",
    "BaseItemNumber": "11211",
    "BrandLabel": "Pro Comp Suspension",
    "ContainerType": "BX",
    "EffectiveDate": "2016-12-13T00:00:00",
    "GTIN": "00614901286748",
    "GTINQualifier": "UP",
    "HasACESApplications": true,
    "HasHazardousMaterialCode": false,
    "MaintenanceType": "A",
    "MinimumOrderQuantity": 1,
    "MinimumOrderQuantityUoM": "EA",
    "PartTerminologyID": 7556,
    "ProductCategoryCode": "330703",
    "ProductGroupCode": "CCL",
    "SubGroupCode": "CRSKT",
    "QuantityPerApplication": 1,
    "QuantityPerApplicationQualifier": "MIN",
    "QuantitySize": 65,
    "QuantitySizeUoM": "BX",
    "SubBrandAAIAID": "JJNT",
    "SubBrandLabel": "Performance",
    "UNSPSCCode": "25174418",
    "VMRSCode": "022002003"
  },
  "Success": true,
  "Message": ""
}
XML response
<ProductSegmentsResponse >
  <Success>true</Success>
  <Message />
  <ItemSegment>
    <AvailableDate>2004-11-17T00:00:00</AvailableDate>
    <BaseItemNumber>11211</BaseItemNumber>
    <BrandLabel>Pro Comp Suspension</BrandLabel>
    <ContainerType>BX</ContainerType>
    <EffectiveDate>2016-12-13T00:00:00</EffectiveDate>
    <GTIN>00614901286748</GTIN>
    <GTINQualifier>UP</GTINQualifier>
    <HasACESApplications>true</HasACESApplications>
    <HasHazardousMaterialCode>false</HasHazardousMaterialCode>
    <MaintenanceType>A</MaintenanceType>
    <MinimumOrderQuantity>1</MinimumOrderQuantity>
    <MinimumOrderQuantityUoM>EA</MinimumOrderQuantityUoM>
    <PartTerminologyID>7556</PartTerminologyID>
    <ProductCategoryCode>330703</ProductCategoryCode>
    <QuantityPerApplication>1</QuantityPerApplication>
    <QuantityPerApplicationQualifier>MIN</QuantityPerApplicationQualifier>
    <QuantitySize>65</QuantitySize>
    <QuantitySizeUoM>BX</QuantitySizeUoM>
    <SubBrandAAIAID>JJNT</SubBrandAAIAID>
    <SubBrandLabel>Performance</SubBrandLabel>
    <ProductGroupCode>CCL</ProductGroupCode>
    <SubGroupCode>CRSKT</SubGroupCode>
    <UNSPSCCode>25174418</UNSPSCCode>
    <VMRSCode>022002003</VMRSCode>
  </ItemSegment>
</ProductSegmentsResponse >

Packaging

Packaging details assigned to a product

HTTP GET: https://apps.semadata.org/sdapi/v2/products/packaging?token={TOKEN}&brandaaiaid={AAIA BRAND ID}&partnumber={PART NUMBER}

Required parameters

Parameter
Usage
Purpose
Token

Token=a123b456c
Verifies user authentication and data authorization
BrandAAIAID
BrandAAIAID=ABCD
Filters the results by an AAIA Brand ID
PartNumber
PartNumber=xyz-123
Filters the results by a part number
JSON response
{
  "Success": true,
  "Message": "string",
  "Packaging": {
    "GTIN": "00123456789101",
    "Barcode": "00123456789101",
    "UOM": "EA",
    "PackageQOE": "1",
    "Height": "4",
    "Width": "6",
    "Length": "6",
    "DIMUOM": "IN",
    "Weight": "5.88",
    "WeightUOM": "PG"
  }
}
XML response
<ProductPricingResponse>
  <Success>true</<Success>
  <Message />
  <Packaging>
    <GTIN>00123456789101</<GTIN>
    <Barcode>00123456789101</<Barcode>
    <UOM>EA</<UOM>
    <PackageQOE>1</<PackageQOE>
    <Height>4</<Height>
    <Width>6</<Width>
    <Length>6</<Length>
    <DIMUOM>IN</<DIMUOM>
    <Weight>5.88</<Weight>
    <WeightUOM>PG</<WeightUOM>
  </Packaging>
</ProductPricingResponse>

Prices

Prices assigned to a product

HTTP GET: https://apps.semadata.org/sdapi/v2/products/price?token={TOKEN}&brandaaiaid={AAIA BRAND ID}&partnumber={PART NUMBER}

Required parameters

Parameter
Usage
Purpose
Token

Token=a123b456c
Verifies user authentication and data authorization
BrandAAIAID
BrandAAIAID=ABCD
Filters the results by an AAIA Brand ID
PartNumber
PartNumber=xyz-123
Filters the results by a part number

Optional parameters

Parameter
Usage
Purpose
PriceCodes

PriceCodes=RET
&PriceCodes=JBR
Filters the results by specific price codes
JSON response
{
  "Prices": [
    {
      "Value": 29.99,
      "Code": "DLR",
      "Name": "Dealer",
      "UoM": "PE",
      "Currency": "U.S. Dollar",
      "ISOCode": "USD",
      "EffectiveDate": "2018-10-11T00:00:00"
    },
    {
      "Value": 29.99,
      "Code": "JBR",
      "Name": "Jobber",
      "UoM": "PE",
      "Currency": "U.S. Dollar",
      "ISOCode": "USD",
      "EffectiveDate": null
    },
    {
      "Value": 29.99,
      "Code": "RET",
      "Name": "Retail",
      "UoM": "PE",
      "Currency": "U.S. Dollar",
      "ISOCode": "USD",
      "EffectiveDate": null
    },
    {
      "Value": 29.99,
      "Code": "RMP",
      "Name": "Retail MAP",
      "UoM": "PE",
      "Currency": "U.S. Dollar",
      "ISOCode": "USD",
      "EffectiveDate": null
    }
  ],
  "Success": true,
  "Message": ""
}
XML response
<ProductPricingResponse>
  <Success>true</<Success>
  <Message />
  <Prices>
    <Price>
      <Value>29.9900</<Value>
      <Code>DLR</Code>
      <Name>Dealer</Name>
      <UoM>PE</UoM>
      <Currency>U.S. Dollar</<Currency>
      <ISOCode>USD</<ISOCode>
      <EffectiveDate>2018-10-11T00:00:00</<EffectiveDate>
    </Price>
    <Price>
      <Value>29.9900</Value>
      <Code>JBR</Code>
      <Name>Jobber</Name>
      <UoM>PE</UoM>
      <Currency>U.S. Dollar</Currency>
      <ISOCode>USD</<ISOCode>
      <EffectiveDate xsi:nil="true" />
    </<Price>
    <Price>
      <Value>29.9900</Value>
      <Code>RET</<Code>
      <Name>Retail</Name>
      <UoM>PE</UoM>
      <Currency>U.S. Dollar</<Currency>
      <ISOCode>USD</<ISOCode>
      <EffectiveDate xsi:nil="true" />
    </Price>
    <Price>
      <Value>29.9900</Value>
      <Code>RMP</Code>
      <Name>Retail MAP</Name>
      <UoM>PE</<UoM>
      <Currency>U.S. Dollar</Currency>
      <ISOCode>USD</<ISOCode>
      <EffectiveDate xsi:nil="true" />
    </Price>
  </Prices>
</ProductPricingResponse>

Extended Product Information

Extended product information assigned to a product

HTTP GET: https://apps.semadata.org/sdapi/v2/products/extendedproductinformation?token={TOKEN}&brandaaiaid={AAIA BRAND ID}&partnumber={PART NUMBER}

Required parameters

Parameter
Usage
Purpose
Token

Token=a123b456c
Verifies user authentication and data authorization
BrandAAIAID
BrandAAIAID=ABCD
Filters the results by an AAIA Brand ID
PartNumber
PartNumber=xyz-123
Filters the results by a part number

Optional parameters

Parameter
Usage
Purpose
ExtProdInfoCodes

ExtProdInfoCodes=RET
&ExtProdInfoCodes=JBR
Filters the results by specific extended product info codes
JSON response
{
  "ExtendedProductInfo": [
    {
      "Value": "US",
      "Code": "CTO"
    },
    {
      "Value": "2",
      "Code": "LIF"
    }
  ],
  "Success": true,
  "Message": ""
}
XML response
<ExtendedProductInfoResponse>
  <Success>true</Success>
  <Message />
  <ExtendedProductInfo>
    <ExtProdInfo>
      <Value>US</Value>
      <Code>CTO</Code>
    </ExtProdInfo>
    <ExtProdInfo>
      <Value>2</Value>
      <Code>LIF</Code>
    </ExtProdInfo>
  </ExtendedProductInfo>
</ExtendedProductInfoResponse>

Receiver / Export Methods

Brand Datasets

Brand datasets retrieves the list of authorized brands a receiver is authorized for. A request for a brand's data must be submitted to and approved by a supplier before it will be populated in this API call. 

HTTP GET: https://apps.semadata.org/sdapi/v2/export/branddatasets?token=YOUR_TOKEN
JSON response
{
"success": true,
"message": "",
"BrandDatasets": [
    {
    "AAIABrandId": "AAFF",
    "BrandName": "Aeromotive Fuel System",
    "DatasetId": 66,
    "DatasetName": "Aeromotive Fuel System",
    "LastUpdated": "2021-10-09T12:25:36.443"
    },
    {
    "AAIABrandId": "AAGG",
    "BrandName": "Air Lift",
    "DatasetId": 67,
    "DatasetName": "Air Lift Company_Air Lift",
    "LastUpdated": "2021-10-09T12:25:36.443"
    }]
}
XML response
<branddatasetresponse>
  <success>true</success>
  <message />
  <branddatasets>
    <branddataset>
      <aaiabrandid>AAFF</aaiabrandid>
      <brandname>Aeromotive Fuel System</brandname>
      <datasetid>66</datasetid>
      <datasetname>Aeromotive Fuel System</datasetname>
      <lastupdated>2021-10-09T12:25:36.443</lastupdated>
    </branddataset>
    <branddataset>
      <aaiabrandid>AAGG</aaiabrandid>
      <brandname>Air Lift</brandname>
      <datasetid>67</datasetid>
      <datasetname>Air Lift Company_Air Lift</datasetname>
      <lastupdated>2021-10-09T12:25:36.443</lastupdated>
    </branddataset>
  </branddatasets>
</branddatasetresponse>

Export Plans

Export plans are templates used to create export jobs. Export plans can be run using the ExportPlanID and calling the Run method. 

HTTP GET: https://apps.semadata.org/sdapi/v2/export/plans?token=YOUR_TOKEN&exportplanid=YOUR_exportplanid
JSON response
{
"success": true,
"message": "",
"ExportPlans": [
    {
    "ExportPlanID": 123456,
    "ModuleName": "ACES Flat Export",
    "AAIABrandID": "CNPW",
    "ProductLineID": 456
    "ProductLineName": "Test Product Line",
    "Name": "Test Plan",
    "DeliveryMethod": "DOWNLOAD",
    "ScheduleData": "Now",
    "CreatedOn": "2018-03-14T13:38:31.28",
    "UpdatedOn": "2020-06-11T09:04:15.81",
    "ZipOnDelivery": true,
    "ParentExportPlanID": 10
    }]
}
XML response
<exportjobresponse>
  <success>true</success>
  <message />
  <exportplans>
    <exportplan>
      <exportplanid>123456</exportplanid>
      <modulename>ACES Flat Export</modulename>
      <aaiabrandid>CNPW</aaiabrandid>
      <productlineid>456</productlineid>
      <productlinename>Test Product Line</productlinename>
      <name>Test Plan</name>
      <deliverymethod>FTP</deliverymethod>
      <scheduledata>Now</scheduledata>
      <createdon>PIES 6.5 XML</createdon>
      <updatedon>Full</updatedon>
      <zipondelivery>1234</zipondelivery>
      <parentexportplanid>1234</parentexportplanid>
    </exportplan>
  </exportplans>
</exportjobresponse>

Export Jobs

Export Jobs are the history of all of your exports. If you've scheduled an export through PIMS, all of those exports' information is accessible through this method call. Typically, your scheduled exports will run as expected. 

HTTP GET: https://apps.semadata.org/sdapi/v2/export/jobs?token=YOUR_TOKEN

Optional parameters

Parameter
Usage
Purpose
ExportJobId

exportjobid=123456
Filters statuses by one specific export run (StartDate parameter ignored if used)
Name

name=my%20daily%20run
Filters statuses by a named scheduled export
AAIA_BrandId

AAIA_BrandId=ABCD
Filters statuses by a specific brand
StartDate

StartDate=12/1/15
Filters statuses that start after the specified date (defaults to 24 hours if not specified)
JSON response
{
"success": true,
"message": "",
"ExportJobs": [
    {
    "ExportJobId": 1234,
    "Name": "My Daily Export",
    "ExportModule": "PIES 6.5 XML",    
    "ExportType": "Full",
    "Status": "Finished",
    "StartTime": "2023-06-01T20:06:30.451Z",
    "AAIABrandId": "BBFG",
    "DatasetId": 66,
    "DatasetName": "Supplier Dataset 1",
    "DeliveryMethod": "FTP"
    },
    {
    "ExportJobId": 1235,
    "Name": "My Monthly Export",
    "ExportModule": "ACES 3.0 XML",    
    "ExportType": "Full",
    "Status": "Error",
    "StartTime": "2023-05-01T20:06:30.451Z",
    "AAIABrandId": "BBFF",
    "DatasetId": 67,
    "DatasetName": "Supplier Dataset 2",
    "DeliveryMethod": "FTP"
    }]
}
XML response
<exportjobresponse>
  <success>true</success>
  <message />
  <exportjobs>
    <exportjob>
      <exportjobid>1234</exportjobid>
      <name>My Daily Export</name>
      <exportmodule>PIES 6.5 XML</exportmodule>
      <exporttype>Full</exporttype>
      <status>Finished</status>
      <starttime>2023-06-01T20:06:30.451Z</starttime>
      <aaiabrandid>BBFG</aaiabrandid>
      <datasetid>66</datasetid>
      <datasetname>Supplier Dataset 1</datasetname>
      <deliverymethod>FTP</deliverymethod>
    </exportjob>
    <exportjob>
      <exportjobid>1235</exportjobid>
      <name>My Monthly Export</name>
      <exportmodule>ACES 3.0 XML</exportmodule>
      <exporttype>Full</exporttype>
      <status>Error</status>
      <starttime>2023-05-01T20:06:30.451Z</starttime>
      <aaiabrandid>BBFF</aaiabrandid>
      <datasetid>67</datasetid>
      <datasetname>Supplier Dataset 2</datasetname>
      <deliverymethod>FTP</deliverymethod>
    </exportjob>
  </exportjobs>
</exportjobresponse>

Run

Existing exports can be run when you know their ExportPlanID via the web request above by executing the following.
Only 10 exports at a time can be run via this method. Simply wait for exports to finish to run more. 

HTTP GET: https://apps.semadata.org/sdapi/v2/export/run?token=YOUR_TOKEN&exportplanid=YOUR_exportplanid
JSON response
{
"success": true,
"message": "",
"JobIDs": [
     12345678,
     23456789
    ]
}
XML response
<RunJobResponse>
  <success>true</success>
  <message />
  <JobIDs>
     <int>12345678</int>
     <int>23456789</int>
  </JobIDs>
</RunJobResponse>

PIES Export

Runs and returns a PIES-compliant export based on a brand 

HTTP POST: https://apps.semadata.org/sdapi/v2/export/piesexport
 NOTE: HTTP POST PARAMETERS BELONG IN THE BODY OF THE REQUEST

Note: You must be the brand owner or an authorized receiver within PIMS on any brands specified.

Warning: A limit of 100 products will be returned in the API response. A warning message will be attached to response if this limit is exceeded. Part Number(s) can be used in the API request to limit the response size.

Required parameters

Parameter
Usage
Purpose
token

token=a123b456c
Verifies user authentication and data authorization
PIESVersion

PIESVersion=6.7
Specifies the version of PIES-compliant export.
Currently supported: 6.7
AAIA_BrandId
AAIA_BrandId=DMWK
Filters the results by an ACA brand ID

Optional parameters

Parameter
Usage
Purpose
partNumbers

partNumbers[]=AB-123
&partNumbers[]=AB-456
&partNumbers[]=AB-789
Filters the results by specific part numbers
excludeMarketCopy

excludeMarketCopy=True
Excludes the Market Copy segment
excludePricing

excludePricing=True
Excludes the Pricing segment (if applicable)
JSON response
{
"success": true,
"message": "",    
"ValidationWarnings": [],
"IsValid": true,
"ValidationErrors": [],
"PiesExport": "<?xml version="1.0" encoding="utf-8" ?><pies xmlns="http://www.aftermarket.org">
      ..."
      }
XML response
<piesexportresponse>
  <success>true</success>
  <message />
  <validationwarnings></validationwarnings>
  <isvalid>true</isvalid>
  <validationerrors></validationerrors>
  <piesexport>
    <?xml version="1.0" encoding="utf-8" ?><pies xmlns="http://www.aftermarket.org"> ...
  </piesexport>
</piesexportresponse>

Digital Assets (CDN Delivery)

Returns a list of brand products with a downloadable link. Filterable by part numbers and asset types. 

HTTP POST: https://apps.semadata.org/sdapi/v2/export/digitalassets
 NOTE: HTTP POST PARAMETERS BELONG IN THE BODY OF THE REQUEST

Warning: Do not hotlink (use the URLs) as a means of content delivery. Use the links to download the assets and then serve them from a content store. These links are not guaranteed to be static, and frequently change as the supplier's assets and/or the CDN domain changes.

Required parameters

Parameter
Usage
Purpose
token

token=a123b456c
Verifies user authentication and data authorization
AAIA_BrandId
AAIA_BrandId=DMWK
Filters the results by an AAIA brand ID

Optional parameters

Parameter
Usage
Purpose
partNumbers

partNumbers[]=AB-123
&partNumbers[]=AB-456
&partNumbers[]=AB-789
Filters the results by specific part numbers
assetTypeCodes

assetTypeCodes[]=P04
&assetTypeCodes[]=LGO
&assetTypeCodes[]=P07
Filters the results by PIES asset type codes (Please refer to PIES 'Digital Asset Segment Codes' appendix)
(If not specified, all asset types are returned)
JSON response
{
"success": true,
"message": "",
"DigitalAssets": [
    {
      "PartNumber": "911-42010SL",
      "Link": "http://cdn.rackcdn.com/K&N/logo1.jpg",
      "AssetTypeCode": "LGO",
      "FileName": "logo1.jpg",
      "RecordModifiedDate": "2015-01-05T21:26:36.137"
    },
    {
      "PartNumber": "911-42010SL",
      "Link": "http://cdn.rackcdn.com/K&N/logo2.jpg",
      "AssetTypeCode": "LGO",
      "FileName": "logo2.jpg",
      "RecordModifiedDate": "2015-01-05T21:26:36.137"
    },
    {
      "PartNumber": "911-42010SL",
      "Link": "http://cdn.rackcdn.com/K&N/img1.jpg",
      "AssetTypeCode": "P04",
      "FileName": "img1.jpg",
      "RecordModifiedDate": "2015-01-05T21:26:36.137"
    }]
}
XML response
<digitalassetresponse>
  <success>true</success>
  <message />
  <digitalassets>
    <DigitalAssetv1>
      <partnumber>911-42010SL</partnumber>
      <link>http://cdn.rackcdn.com/K&N/logo1.jpg</link>
      <assettypecode>LGO</assettypecode>
      <filename>LGO</filename>
      <recordmodifieddate>2015-01-05T21:26:36.137</recordmodifieddate>
    </DigitalAssetv1>
    <DigitalAssetv1>
      <partnumber>911-42010SL</partnumber>
      <link>http://cdn.rackcdn.com/K&N/logo2.jpg</link>
      <assettypecode>LGO</assettypecode>
      <filename>LGO</filename>
      <recordmodifieddate>2015-01-05T21:26:36.137</recordmodifieddate>
    </DigitalAssetv1>
    <DigitalAssetv1>
      <partnumber>911-42010SL</partnumber>
      <link>http://cdn.rackcdn.com/K&N/img1.jpg</link>
      <assettypecode>P04</assettypecode>
      <filename>LGO</filename>
      <recordmodifieddate>2015-01-05T21:26:36.137</recordmodifieddate>
    </DigitalAssetv1>
  </products>
</digitalassetresponse>




Data Lookups

Year/Make/Model/Submodel

Years

Valid years as defined by the ACA VCdb 

HTTP GET: https://apps.semadata.org/sdapi/v2/lookup/years?token=YOUR_TOKEN

Note: You must be the brand owner or an authorized receiver within PIMS on any brands specified. If no brands are specified; results are based on all authorized brands

Optional parameters

Parameter
Usage
Purpose
aaia_brandids

aaia_brandids=DMWK &aaia_brandids=BBWQ
Filters the results by a AAIA brand ID or ID's
JSON response
{
"success": true,
"message": "",
"Years": [1999,2000,2001,2002,2003,2004,2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015,2016]
}
XML response
<yearresponse>
  <success>true</success>
  <message />
  <years>
    <int>2016</int>
    <int>2015</int>
    <int>2014</int>
    <int>2013</int>
    <int>2012</int>
    <int>2011</int>
    <int>2010</int>
  </years>
</yearresponse>

Make Names

Valid make names as defined by the ACA VCdb 

HTTP GET: https://apps.semadata.org/sdapi/v2/lookup/makenames?token=YOUR_TOKEN

Note: You must be the brand owner or an authorized receiver within PIMS on any brands specified. If no brands are specified; results are based on all authorized brands

Optional parameters

Parameter
Usage
Purpose
year

year=2005
Filters results by year
aaia_brandids

aaia_brandids=DMWK &aaia_brandids=BBWQ
Filters the results by a AAIA brand ID or ID's
JSON response
{
"success": true,
"message": "",
"Makes": [
    {
    "MakeName": "Acura"
    },
    {
    "MakeName": "Audi"
    },
    {
    "MakeName": "BMW"
    }]
}
XML response
<makeresponse>
  <success>true</success>
  <message />
  <makes>
    <makename>
      <makename>Acura<makename>
    </makename>
    <makename>
      <makename>Audi<makename>
    </makename>
    <makename>
      <makename>BMW<makename>
    </makename>
  </makes>
</makeresponse>

Model Names

Valid model names as defined by the ACA VCdb 

HTTP GET: https://apps.semadata.org/sdapi/v2/lookup/modelnames?token=YOUR_TOKEN

Note: You must be the brand owner or authorized within PIMS on any brands specified. If no brands are specified; results are based on all authorized brands

Optional parameters

Parameter
Usage
Purpose
year

year=2005
Filters results by year
makename

makename=acura
Filters results by make name
aaia_brandids

aaia_brandids=DMWK &aaia_brandids=BBWQ
Filters the results by a AAIA brand ID or ID's
JSON response
{
"success": true,
"message": "",
"Models": [
    {
    "BaseVehicleID": 18268,
    "ModelName": "RSX"
    },
    {
    "BaseVehicleID": 18269,
    "ModelName": "MDX"
    },
    {
    "BaseVehicleID": 18270,
    "ModelName": "NSX"
    }]
}
XML response
<modelresponse>
  <success>true</success>
  <message />
  <modelnames>
    <modelname>
      <basevehicleid>18268<basevehicleid>
      <modelname>RSX<modelname>
    </modelname>
    <modelname>
      <basevehicleid>18269<basevehicleid>
      <modelname>MDX<modelname>
    </modelname>
    <modelname>
      <basevehicleid>18270<basevehicleid>
      <modelname>NSX<modelname>
    </modelname>
  </modelnames>
</modelresponse>

Submodel Names

Valid submodel names as defined by the ACA VCdb 

HTTP GET: https://apps.semadata.org/sdapi/v2/lookup/submodelnames?token=YOUR_TOKEN

Note: You must be the brand owner or authorized within PIMS on any brands specified. If no brands are specified; results are based on all authorized brands

Optional parameters

Parameter
Usage
Purpose
year

year=2000
Filters results by year
makename

makename=acura
Filters results by make name
modelname

modelname=Integra
Filters results by model name
aaia_brandids

aaia_brandids=DMWK &aaia_brandids=BBWQ
Filters the results by a AAIA brand ID or ID's
JSON response
{
"success": true,
"message": "",
"Submodels": [
    {
    "VehicleID": 22060,
    "SubmodelName": "GS-R"
    },
    {
    "VehicleID": 13846,
    "SubmodelName": "Type R"
    },
    {
    "VehicleID": 13940,
    "SubmodelName": "T"
    }]
}
XML response
<submodelresponse>
  <success>true</success>
  <message />
  <submodels>
    <submodel>
      <vehicleid>22060<vehicleid>
      <submodelname>GS-R<submodelname>
    </submodel>
    <submodel>
      <vehicleid>13846<vehicleid>
      <submodelname>Type R<submodelname>
    </submodel>
    <submodel>
      <vehicleid>13940<vehicleid>
      <submodelname>T<submodelname>
    </submodel>
  </submodels>
</submodelresponse>

All Year, Make, Model, and Submodels

Returns all combinations of Years, Makes, Models, and Submodels 

HTTP GET: https://apps.semadata.org/sdapi/v2/vcdb/ymms?token=YOUR_TOKEN
JSON response
{
"success": true,
"message": "",
"Vehicles": [
    {
        "VehicleID": 1,
        "Year": 2002,
        "MakeName": "Suzuki",
        "ModelName": "Aerio",
        "SubmodelName": "S"
    },
    {
        "VehicleID": 2,
        "Year": 2002,
        "MakeName": "Suzuki",
        "ModelName": "Aerio",
        "SubmodelName": "GS"
    }]
}
XML response
<VehicleResponse>
  <Success>true</Success>
  <Message />
  <Vehicles>
    <VehicleBase>
      <VehicleID>1</VehicleID>
      <Year>2002</Year>
      <MakeName>Suzuki</MakeName>
      <ModelName>Aerio</ModelName>
      <SubmodelName>S</SubmodelName>
    </VehicleBase>2002</Year>
    <VehicleBase>
      <VehicleID>2</VehicleID>
      <Year>2002</Year>
      <MakeName>Suzuki</MakeName>
      <ModelName>Aerio</ModelName>
      <SubmodelName>GS</SubmodelName>
    </VehicleBase>
  </Vehicles>
</VehicleResponse>

Engine

Valid engines as defined by the ACA VCdb 

HTTP GET: https://apps.semadata.org/sdapi/v2/lookup/engines?token=YOUR_TOKEN

Note: You must be the brand owner or authorized within PIMS on any brands specified.

Required parameters

Parameter
Usage
Purpose
year

year=2000
Filters results by year
makeid

makeid=54
Filters results by make
modelid

modelid=679
Filters results by model
aaia_brandids

aaia_brandids=DMWK &aaia_brandids=BBWQ
Filters the results by a AAIA brand ID or ID's
JSON response
{
"success": true,
"message": "",
"Engines": [
    {
      "VehicleID": 5184,
      "Liter": "3.0",
      "CC": "2962",
      "CID": "181",
      "Cylinders": "6",
      "BlockType": "V",
      "EngBoreIn": "3.39",
      "EngBoreMetric": "86.0",
      "EngStrokeIn": "3.35",
      "EngStrokeMetric": "85.0",
      "ValvesPerEngine": "24",
      "AspirationName": "Naturally Aspirated",
      "CylinderHeadTypeName": "DOHC",
      "FuelTypeName": "GAS",
      "IgnitionSystemTypeName": "Distributorless",
      "MfrName": "GM Europe",
      "HorsePower": "U/K",
      "KilowattPower": "U/K",
      "EngineDesignationName": "D16Y5"
    }]
}
XML response
<engineresponse>
  <success>true</success>
  <message />
  <engines>
    <engine>
      <vehicleid>12345<vehicleid>
      <liter>3.0<liter>
      <CC>2962<CC>
      <CID>181<CID>
      <Cylinders>6<Cylinders>
      ... (etc) ...
    </engine>
  </engines>
</engineresponse>

Expanded Vehicle Info

Returns expanded ACES vehicle information 

HTTP GET: https://apps.semadata.org/sdapi/v2/lookup/expandedvehicleinfo?token=YOUR_TOKEN

Note: Due to the number of additional possible vehicle configurations wheelbase provides (x10 in many cases), you must explicitly opt-in to receive this data via the includeWheelBase flag.

Required parameters

Parameter
Usage
Purpose
baseVehicleID
(or)
vehicleID
baseVehicleID=12345
(or)
vehicleID=12345
Returns all information given a base vehicle

Returns all information given a vehicle

Optional parameters

Parameter
Usage
Purpose
includeWheelBase
includeWheelBase=true
Incldues wheelbase information (otherwise blank)
sendIDs
sendIDs=true
Sends the corresponding VCDB ID's instead of VCDB values
JSON response
{
"success": true,
"message": "",
"Vehicles": [
    {"Year":2018,
     "Make":"Hyundai",
     "Model": "Sonata",
     "Submodel":"Eco",
     "Region":"United States",
     "Liter":"1.6",
     "Cylinders":"4",
     "BlockType":"L",
     "FuelDeliveryTypeName":"FI",
     "FuelTypeName":"GAS"

       ... (etc) ...

    }
]
}
XML response
<expandedvehicleresponse >
  <success>true</success>
  <message />
  <vehicles>
    <expandedvehicleinfo>
      <year>2018<year>
      <make>Hyundai<make>
      <model>Sonata<model>
      ... (etc) ...
    </expandedvehicleinfo>
  </vehicles>
</expandedvehicleresponse >

Categories

Categories as defined by the ACA PCdb 

HTTP POST: https://apps.semadata.org/sdapi/v2/lookup/categories
 NOTE: HTTP POST PARAMETERS BELONG IN THE BODY OF THE REQUEST

Note: You must be the brand owner or authorized within PIMS on any brands specified. If no brands are specified; results are based on all authorized brands

Required parameters (HTTP POST)

Parameter
Usage
Purpose
token

token=abcd123456
Security token required by all API calls
aaia_brandids

aaia_brandids=DMWK
&aaia_brandids=FDLQ
Filters the results by an AAIA brand ID

Optional parameters

Parameter
Usage
Purpose
baseVehicleIds

baseVehicleIds=12345 &baseVehicleIds=54321
Filters the results by vehicle ACES application(s)
vehicleIds

vehicleIds=12345&vehicleIds=54321
Filters the results by vehicle ACES application(s)
Year, MakeName,
ModelName, (optional)SubmodelName
Year=2013&MakeName=Nissan
&ModelName=Maxima
Filters the results by vehicle ACES application(s)
JSON response
{
"success": true,
"message": "",
"Categories": [
    {
      "ParentId": 1,
      "CategoryId": 3903,
      "Name": "Brake",
      "Categories": [
        {
          "ParentId": 3903,
          "CategoryId": 4512,
          "Name": "Drums and Rotors",
          "Categories": [
            {
              "ParentId": 4512,
              "CategoryId": 4531,
              "Name": "Disc Brake Rotor",
              "Categories": []
            }]
        }
      ]}
}
XML response
<categoryresponse>
  <success>true</success>
  <message />
  <categories>
    <category>
      <parentid>1<parentid>
      <categoryid>3903<categoryid>
      <name>Brake<name>
      <categories>
        <category>
          <parentid>3903<parentid>
          <categoryid>4512<categoryid>
          <name>Drums and Rotors<name>
          <categories>
            <category>
              <parentid>4512<parentid>
              <categoryid>4531<categoryid>
              <name>Disc Brake Rotor<name>
            </category>
          </categories>
        </category>
      </categories>
    </category>
  </categories>
</categoryresponse>

Products by Category

Returns product information given a category 

HTTP POST:https://apps.semadata.org/sdapi/v2/lookup/productsbycategory
 NOTE: HTTP POST PARAMETERS BELONG IN THE BODY OF THE REQUEST

Required parameters (HTTP POST)

Parameter
Usage
Purpose
token

token=abcd123456
Security token required by all API calls
CategoryIds

CategoryId=11924&CategoryId=61800
Filters the results by Category ID(s)

Optional parameters

Parameter
Usage
Purpose
aaia_brandids

aaia_brandids=DMWK
&aaia_brandids=FDLQ
Filters the results by an AAIA brand ID

baseVehicleIds

baseVehicleIds=12345 &baseVehicleIds=54321
Filters the results by vehicle ACES application(s)
vehicleIds

vehicleIds=12345 &vehicleIds=54321
Filters the results by vehicle ACES application(s)
includeChildCategoryParts


includeChildCategoryParts=true
Includes parts from any subcategories, not just the category specified
partNumbers

partNumbers=12345 &partNumbers=54321
Filters the results by part number(s)
piesSegments (specify "all" to receive all)
piesSegments=C10_DES &piesSegments=P05_LGO (piesSegments=all)
Adds PIES data to the results for the provided segments
Year, MakeName,
ModelName, (optional)SubmodelName
Year=2013&MakeName=Nissan
&ModelName=Maxima
Filters the results by vehicle ACES application(s)
PIESFilters
[{ PIESElement: "F10", PIESValue: "Stainless Steel" },{ PIESElement: "F10", PIESValue: "Aluminum" }]
Filters the results based on PIES value(s) such as product attributes. Note: must also set the piesSegments parameter to the PIES elements being filtered
lookupAttributeLabels
lookupAttributeLabels=True
Where appropriate, looks up the product attributes' PADB label and replace the F05 PADB ID with the PADB label
lookupEXPILabels
lookupEXPILabels=True
Where appropriate, looks up the product EXPI code with the full PADB descriptions
JSON response
{
"success": true,
"message": "",
"Products": [
    {    
    "ProductId": 20664458
    "PartNumber": "911-42011SR",
    "PiesAttributes": [
    {
        "PiesSegment": "C10_DEF_EN",
        "Value": "Disc Brake Rotor"
    },
    {
        "PiesSegment": "C10_SHO_EN",
        "Value": "4000 Series Rotor"
    },
    {
        "PiesSegment": "P05_LGO_WhiteLogo.pdf",
        "Value": "WhiteLogo.pdf"
    }]
}
XML response
<productresponse>
  <success>true</success>
  <message />
  <products>
    <product>
      <partnumber>911-42010SL</partnumber>
      <piesattributes>
        <piesattribute>
          <piessegment>C10_DEF_EN</piessegment>
          <value>Disc Brake Rotor</value>
       </piesattribute>
        <piesattribute>
          <piessegment>C10_SHO_EN</piessegment>
          <value>4000 Series Rotor</value>
       </piesattribute>
        <piesattribute>
          <piessegment>P05_LGO_WhiteLogo.pdf</piessegment>
          <value>WhiteLogo.pdf</value>
       </piesattribute>
     </piesattributes>
    </product>
  </products>
</productresponse>

Products by Brand

Returns product information given a brand's AAIA brand ID 

HTTP POST: https://apps.semadata.org/sdapi/v2/lookup/products
 NOTE: HTTP POST PARAMETERS BELONG IN THE BODY OF THE REQUEST

Note: You must be the brand owner or an authorized receiver within PIMS on any brands specified

Required parameters (HTTP POST)

Parameter
Usage
Purpose
token

token=abcd123456
Security token required by all API calls
aaia_brandid
(or)
aaia_brandids

aaia_brandid=DMWK

aaia_brandids=DMWK
&aaia_brandids=FDLQ
Filters the results by an AAIA brand ID



Optional parameters

Parameter
Usage
Purpose
baseVehicleIds

baseVehicleIds=12345 &baseVehicleIds=54321
Filters the results by (base) vehicle ACES application(s)
vehicleIds

vehicleIds=12345 &vehicleIds=54321
Filters the results by vehicle ACES application(s)
partNumbers

partNumbers=12345 &partNumbers=54321
Filters the results by part number(s)
piesSegments (specify "all" to receive all)
piesSegments=C10_DES &piesSegments=P05_LGO (piesSegments=all)
Adds PIES data to the results for the provided segments
Year, MakeName,
ModelName, (optional)SubmodelName
Year=2013&MakeName=Nissan
&ModelName=Maxima
Filters the results by vehicle ACES application(s)
PIESFilters
[{ PIESElement: "F10", PIESValue: "Stainless Steel" },{ PIESElement: "F10", PIESValue: "Aluminum" }]
Filters the results based on PIES value(s) such as product attributes. Note: must also set the piesSegments parameter to the PIES elements being filtered
lookupAttributeLabels
lookupAttributeLabels=True
Where appropriate, looks up the product attributes' PADB label and replace the F05 PADB ID with the PADB label
lookupEXPILabels
lookupEXPILabels=True
Where appropriate, looks up the product EXPI code with the full PADB descriptions
JSON response
{
"success": true,
"message": "",
"Products": [
    {        
    "ProductId": 20664458
    "PartNumber": "911-42011SR",
    "PiesAttributes": [
    {
        "PiesSegment": "C10_DEF_EN",
        "Value": "Disc Brake Rotor"
    },
    {
        "PiesSegment": "C10_SHO_EN",
        "Value": "4000 Series Rotor"
    },
    {
        "PiesSegment": "P05_LGO_WhiteLogo.pdf",
        "Value": "WhiteLogo.pdf"
    }]
}
XML response
<productresponse>
  <success>true</success>
  <message />
  <products>
    <product>
      <partnumber>911-42010SL</partnumber>
      <piesattributes>
        <piesattribute>
          <piessegment>C10_DEF_EN</piessegment>
          <value>Disc Brake Rotor</value>
       </piesattribute>
        <piesattribute>
          <piessegment>C10_SHO_EN</piessegment>
          <value>4000 Series Rotor</value>
       </piesattribute>
        <piesattribute>
          <piessegment>P05_LGO_WhiteLogo.pdf</piessegment>
          <value>WhiteLogo.pdf</value>
       </piesattribute>
     </piesattributes>
    </product>
  </products>
</productresponse>

Product Attributes

Returns a distinct list of product attributes labels and all corresponding attribute data 

HTTP POST:https://apps.semadata.org/sdapi/v2/lookup/productattributes
 NOTE: HTTP POST PARAMETERS BELONG IN THE BODY OF THE REQUEST

Required parameters (HTTP POST)

Parameter
Usage
Purpose
token

token=abcd123456
Security token required by all API calls
aaia_brandids

aaia_brandids=DMWK
&aaia_brandids=FDLQ
Filters the results by an AAIA brand ID

Optional parameters

Parameter
Usage
Purpose
CategoryId
CategoryId=11924
Returns the products in a category
includeChildCategoryParts


includeChildCategoryParts=true
Includes parts from any subcategories, not just the category specified
JSON response
{
"success": true,
"message": "",
"Attributes": [
        {
            "AttributeID": "12345",
            "AttributeIDLabel": "Bracket Color",
            "AttributeData": [
                "black/gold"
            ]
        },
        {
            "AttributeID": "Capacity",
            "AttributeIDLabel": "Capacity",
            "AttributeData": [
                "15 Gallons",
                "17",
                "20 Gallons",
                "22",
                "6",
                "6 Gallons"
            ]
        }]

}
XML response
<productattributeresponse>
  <success>true</success>
  <message />
  <attributes>
    <productattributefilters>
      <attributeid>12345</attributeid>
      <attributeidlabel>Bracket Color</attributeidlabel>
      <attributedata>
        <string>black/gold</string>
     </attributedata>
    </productattributefilters>
    <productattributefilters>
      <attributeid>Capacity</attributeid>
      <attributeidlabel>Capacity</attributeidlabel>
      <attributedata>
        <string>15 Gallons</string>
        <string>17</string>
        <string>20 Gallons</string>
        <string>22</string>
        <string>6</string>
        <string>6 Gallons</string>
     </attributedata>
    </productattributefilters>
  </attributes>
</productattributeresponse>

Vehicles by Brand/Product(s)

Returns vehicles that will fit a given brand or brand's partnumber(s) 

HTTP POST: https://apps.semadata.org/sdapi/v2/lookup/vehiclesbyproduct
 NOTE: HTTP POST PARAMETERS BELONG IN THE BODY OF THE REQUEST

Note: You must be the brand owner or an authorized receiver within PIMS on any brands specified

Required parameters (HTTP POST)

Parameter
Usage
Purpose
token

token=abcd123456
Security token required by all API calls
aaia_brandid

aaia_brandid=DMWK

Filters the results by an AAIA brand ID

partNumber
partNumber=12345
Returns vehicle applications for this part

Optional parameters

Parameter
Usage
Purpose
expandedVehicleInfo
expandedVehicleInfo=true
Includes engine info in addition to YMM
JSON response
{
"success": true,
"message": "",
"Parts": [
    {
    "PartNumber": "AB-123",
    "Vehicles": [
        {
        "Year": 2014,
        "MakeName": "Ford",
        "ModelName": "F-150",
        "SubmodelName": "FX2",
        "FitmentNotes": "Does not fit extended cab."
        },
        {
        "Year": 2014,
        "MakeName": "Ford",
        "ModelName": "F-150",
        "SubmodelName": "FX4",
        "FitmentNotes": "Does not fit extended cab."
        }]
    }]
}
XML response
<vehicleresponse>
  <success>true</success>
  <message />
  <vehicles>
    <vehicle>
      <year>2014</year>
      <makename>Ford</makename>
      <modelname>F-150</modelname>
      <submodelname>FX2</submodelname>
      <fitmentnotes>Does not fit extended cab.</fitmentnotes>
    </vehicle>
    <vehicle>
      <year>2014</year>
      <makename>Ford</makename>
      <modelname>F-150</modelname>
      <submodelname>FX4</submodelname>
      <fitmentnotes>Does not fit extended cab.</fitmentnotes>
    </vehicle>
  </vehicles>
</vehicleresponse>


Vehicles by Brand (Flat)

Returns vehicles that will fit a given brand or brand's partnumber(s) 

HTTP POST: https://apps.semadata.org/sdapi/v2/lookup/vehiclesbybrand
 NOTE: HTTP POST PARAMETERS BELONG IN THE BODY OF THE REQUEST

Note: You must be the brand owner or an authorized receiver within PIMS on any brands specified. If no brands are specified, results are based on all authorized brands
Note: Results for this API call are calcluated daily. Updates throughout the day will not reflect until the following business day.

Required parameters (HTTP POST)

Parameter
Usage
Purpose
token

token=abcd123456
Security token required by all API calls
aaia_brandids

aaia_brandids=DMWK
&aaia_brandids=FDLQ
Filters the results by an AAIA brand ID

JSON response
{
"success": true,
"message": "",
"BrandVehicles": [
    {
    "AAIA_BrandID": "ABCD",
    "BrandName": "My Manufacturer",
    "Year": 2014,
    "MakeName": "Ford",
    "ModelName": "F-150",
    "SubmodelName": "FX2"
    },
    {
    "AAIA_BrandID": "ABCD",
    "BrandName": "My Manufacturer",
    "Year": 2014,
    "MakeName": "Ford",
    "ModelName": "F-150",
    "SubmodelName": "FX4"
    }]
}
XML response
<vehiclesbybrandresponse>
  <success>true</success>
  <message />
  <brandvehicles>
    <brandvehicle>
      <aaia_brandid>ABCD</aaia_brandid>
      <brandname>My Manufacturer</brandname>
      <year>2014</year>
      <makename>Ford</makename>
      <modelname>F-150</modelname>
      <submodelname>FX2</submodelname>
    </brandvehicle>
    <brandvehicle>
      <aaia_brandid>ABCD</aaia_brandid>
      <brandname>My Manufacturer</brandname>
      <year>2014</year>
      <makename>Ford</makename>
      <modelname>F-150</modelname>
      <submodelname>FX4</submodelname>
    </brandvehicle>
  </brandvehicles>
</vehiclesbybrandresponse>


Content Pages

The SDC now provides a page to display content for various items. You can now use the API to display a product (and future others planned).


Content Token

You need to request a content token and use them in the querystring when accessing these pages - this token expires and is an extra layer of security. 

HTTP GET: https://apps.semadata.org/sdapi/v2/token/getcontenttoken?token=YOUR_TOKEN


On valid authentication, the token response will reply with a success property true and your token, or false, with a reason on why the authentication failed. Example success response:

JSON response
{
"success": true,
"message": "",
"contenttoken": "abcd12345"
}
XML response
<contenttokenresponse>
  <success>true</success>
  <message />
  <contenttoken>abcd12345</contenttoken>
</contenttokenresponse>


Product

Returns an HTML page displaying a product 

HTTP GET: https://apps.semadata.org/sdapi/v2/content/product?contenttoken=YOUR_TOKEN&productid=PRODUCTID

Note: You must be the brand owner or an authorized receiver within PIMS on any products specified

Required querystring parameters

Parameter
Usage
Purpose
contenttoken

contenttoken=abcd123456
Security token required by all content calls
Expires after 1 minute
productid

productid=12356
To display the product specified

Optional parameters

Parameter
Usage
Purpose
stripHeaderFooter

stripHeaderFooter=true
Removes the SDC header and footer for generic usage
Full Page
Mobile / Responsive