Integration Service

Order Status Service

Part Query Service

Punchout

PartSearch API Reference

Documentation:

The PartSearch method(s) will return items that have been quoted and not yet added to the cart or purchased. You can access this method either through SOAP Services or the REST API.

SOAP Method: PartSearch

REST Request: POST api/part/search

Properties

DataType: PartSearchRequest

PartSearchRequest class.

NameDescriptionTypeAdditional information
PartNumber

Accessor for the part number to search.

 string

None.
Manufacturer

Accessor for the manufacturer name. Optionally restricts search to a given OEM.

 string

None.
Category

Accessor for the manufacturer name. Optionally restricts search to a given part category.

 string

None.
Model

Accessor for the model. Optionally restricts search to a given model name.

 string

None.
PageNumber

Accessor for the page number for paged result sets.

 integer

None.
PageSize

Accessor for the maximum number of entries to return per response.

 integer

None.
DataType: PartSearchResponse
Parameters:
NameDescriptionTypeAdditional information
Results

Accesor for the search results.

 Collection of CatalogPart

None.
TotalResults

Accessor for the total number of search results.

 integer

None.
PageNumber

Accessor for the result page number

 integer

None.

Request Samples

application/json, text/json

Sample: 
{
  "partNumber": "sample string 1",
  "manufacturer": "sample string 2",
  "category": "sample string 3",
  "model": "sample string 4",
  "pageNumber": 5,
  "pageSize": 6
}

application/xml, text/xml

Sample: 
<PartSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartsSource.Api.Model">
  <Category>sample string 3</Category>
  <Manufacturer>sample string 2</Manufacturer>
  <Model>sample string 4</Model>
  <PageNumber>5</PageNumber>
  <PageSize>6</PageSize>
  <PartNumber>sample string 1</PartNumber>
</PartSearchRequest>

application/x-www-form-urlencoded

Sample: Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PartSearchRequest'.

Response Samples

application/json, text/json

Sample: 
{
  "results": [
    {
      "partIdentifier": "sample string 1",
      "partNumber": "sample string 2",
      "displayPartNumber": "sample string 3",
      "manufacturerId": 4,
      "manufacturerName": "sample string 5",
      "description": "sample string 6",
      "partImages": [
        {
          "largeImagePath": "sample string 1",
          "smallImagePath": "sample string 2"
        },
        {
          "largeImagePath": "sample string 1",
          "smallImagePath": "sample string 2"
        }
      ]
    },
    {
      "partIdentifier": "sample string 1",
      "partNumber": "sample string 2",
      "displayPartNumber": "sample string 3",
      "manufacturerId": 4,
      "manufacturerName": "sample string 5",
      "description": "sample string 6",
      "partImages": [
        {
          "largeImagePath": "sample string 1",
          "smallImagePath": "sample string 2"
        },
        {
          "largeImagePath": "sample string 1",
          "smallImagePath": "sample string 2"
        }
      ]
    }
  ],
  "totalResults": 1,
  "pageNumber": 2
}

application/xml, text/xml

Sample: 
<PartSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartsSource.Api.Model">
  <PageNumber>2</PageNumber>
  <TotalResults>1</TotalResults>
  <Results>
    <CatalogPart>
      <Description>sample string 6</Description>
      <DisplayPartNumber>sample string 3</DisplayPartNumber>
      <ManufacturerId>4</ManufacturerId>
      <ManufacturerName>sample string 5</ManufacturerName>
      <PartIdentifier>sample string 1</PartIdentifier>
      <PartImages>
        <PartImage>
          <LargeImagePath>sample string 1</LargeImagePath>
          <SmallImagePath>sample string 2</SmallImagePath>
        </PartImage>
        <PartImage>
          <LargeImagePath>sample string 1</LargeImagePath>
          <SmallImagePath>sample string 2</SmallImagePath>
        </PartImage>
      </PartImages>
      <PartNumber>sample string 2</PartNumber>
    </CatalogPart>
    <CatalogPart>
      <Description>sample string 6</Description>
      <DisplayPartNumber>sample string 3</DisplayPartNumber>
      <ManufacturerId>4</ManufacturerId>
      <ManufacturerName>sample string 5</ManufacturerName>
      <PartIdentifier>sample string 1</PartIdentifier>
      <PartImages>
        <PartImage>
          <LargeImagePath>sample string 1</LargeImagePath>
          <SmallImagePath>sample string 2</SmallImagePath>
        </PartImage>
        <PartImage>
          <LargeImagePath>sample string 1</LargeImagePath>
          <SmallImagePath>sample string 2</SmallImagePath>
        </PartImage>
      </PartImages>
      <PartNumber>sample string 2</PartNumber>
    </CatalogPart>
  </Results>
</PartSearchResponse>

© 2025, PartsSource Inc.