Web API Reference

Here you'll find available endpoints, parameters, response examples and more.

PingV2

Ping the API using credentials as a test. Returns an int of 1 on success.

API	Description
GET v2/Ping	Ping

AddressV2

API	Description
POST v2/Address/Validation	Address Validation

PartV2

Part Related Calls

API	Description
GET v2/Part/Details?PartId={PartId}&CategoryId={CategoryId}&BrandId={BrandId}&PartFamilyId={PartFamilyId}&Zipcode={Zipcode}&DocumentFormat={DocumentFormat}&WarehouseId={WarehouseId}&PartType={PartType}&DealerPricing={DealerPricing}&AllWarehouses={AllWarehouses}&NewDate={NewDate}&IncludeUnavailable={IncludeUnavailable}&ReferenceId={ReferenceId}	Details
GET v2/Part/Media?PartId={PartId}&ShowImages={ShowImages}&ReferenceId={ReferenceId}	Media
GET v2/Part/StopSale?PartId={PartId}&State={State}&CountryId={CountryId}&ReferenceId={ReferenceId}	StopSale
GET v2/Part/Inventory?PartId={PartId}&PartFamilyId={PartFamilyId}&BrandId={BrandId}&PartType={PartType}&AllWarehouses={AllWarehouses}&NewDate={NewDate}&ReferenceId={ReferenceId}	Inventory
GET v2/Part/Spec?PartId={PartId}&PartFamilyId={PartFamilyId}&BrandId={BrandId}&PartType={PartType}&StoreId={StoreId}&NewDate={NewDate}&DocumentFormat={DocumentFormat}&ReferenceId={ReferenceId}	Spec
GET v2/Part/PriceBreak?PartId={PartId}&ZipCode={ZipCode}&WarehouseId={WarehouseId}&ReferenceId={ReferenceId}	PriceBreak
GET v2/Part/Price?PartId={PartId}&ZipCode={ZipCode}&WarehouseId={WarehouseId}&ReferenceId={ReferenceId}	Price
GET v2/Part/PartFamily?PartFamilyId={PartFamilyId}&BrandId={BrandId}&CategoryId={CategoryId}&PartType={PartType}&ReferenceId={ReferenceId}	PartFamily
GET v2/Part/Kit?PartId={PartId}&ReferenceId={ReferenceId}	Kit

OrderV2

Order related calls

API	Description
POST v2/Order/ReviewOrder	ReviewOrder
POST v2/Order/PlaceOrder	PlaceOrder

Ping

Ping the API using credentials as a test. Returns an int of 1 on success.

API	Description
GET v1/ping	Ping the API using credentials as a test. Returns an int of 1 on success.

Price

Part Pricing

API	Description
GET v1/price?zipCode={zipCode}&warehouseId={warehouseId}	Gets all prices for prices data file
GET v1/Price/{id}?quantity={quantity}&format={format}&zipCode={zipCode}&warehouseId={warehouseId}	Get part details for a single part.

PriceBreak

Part quantity price break data.

API	Description
GET v1/pricebreak?id={id}&zipCode={zipCode}&warehouseId={warehouseId}	Get part details for a single part.
GET v1/pricebreak/{id}?zipCode={zipCode}&warehouseId={warehouseId}	Get part details for a single part.

PartFamily

API	Description
GET v1/partfamily/{id}	Gets part family details by Id
GET v1/PartFamily?categoryId={categoryId}&brandId={brandId}&partType={partType}	Gets part family details

StopSale

Part related stop sale data.

API	Description
GET v1/stopsale/{id}?locationId={locationId}&countryId={countryId}	Gets list of stop sales for a part

Media

Part Media Information

API	Description
GET v1/Media?partFamilyId={partFamilyId}&brandId={brandId}&partType={partType}&newDate={newDate}&format={format}	Get all part media for all parts
GET v1/Media/{id}?showImages={showImages}&format={format}	Get part media for a part id

Part

Get part details

API	Description
GET v1/Part?categoryId={categoryId}&brandId={brandId}&partType={partType}&dealerPricing={dealerPricing}&allWarehouses={allWarehouses}&newDate={newDate}&format={format}&includeUnavailable={includeUnavailable}&partFamilyId={partFamilyId}&zipCode={zipCode}&warehouseId={warehouseId}	Get part details for a group of parts.
GET v1/Part/{id}?format={format}&dealerPricing={dealerPricing}&allWarehouses={allWarehouses}&zipCode={zipCode}&warehouseId={warehouseId}&includeUnavailable={includeUnavailable}	Get part details for a single part.

Invoice

API	Description
GET v1/Invoice?invoiceId={invoiceId}&orderId={orderId}&startDate={startDate}&poNumber={poNumber}&invoiceStatus={invoiceStatus}	Gets invoice data

InvoiceLineItem

API	Description
GET v1/InvoiceLineItem?invoiceId={invoiceId}	Gets line details for an invoice

PartPublic

Get part information - no dealer specific data.

API	Description
GET v1/PartPublic/{id}?format={format}	Get part information - no dealer specific data.

Warehouse

Warehouse related data.

API	Description
GET v1/Warehouse?warehouseId={warehouseId}	No documentation available.

Spec

Get part spec data.

API	Description
GET v1/Spec?partFamilyId={partFamilyId}&brandId={brandId}&partType={partType}&newDate={newDate}&format={format}&storeId={storeId}	Get part specs for a part family id
GET v1/Spec/{id}?format={format}&storeId={storeId}	Get part specs for a part id

OrderHistory

API	Description
GET v1/OrderHistory?format={format}&searchTerm={searchTerm}&orderBy={orderBy}&startDate={startDate}&endDate={endDate}&orderStatus={orderStatus}&orderType={orderType}&SortDesc={SortDesc}&orderCount={orderCount}	Get order histories

OrderHistoryLineItem

API	Description
GET v1/OrderHistoryLineItem?orderId={orderId}&shipDate={shipDate}&shipViaCode={shipViaCode}&trackingNumber={trackingNumber}&packId={packId}	Get the lines for an order history

Inventory

Get Inventory Data For Parts

API	Description
GET v1/Inventory?partFamilyId={partFamilyId}&brandId={brandId}&partType={partType}&allWarehouses={allWarehouses}&newDate={newDate}	Get Parts Inventory
GET v1/Inventory/{id}?allWarehouses={allWarehouses}	Get Part Inventory by Id