> For the complete documentation index, see [llms.txt](https://docs.partssource.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.partssource.com/api-customer/catalog.md).

# Catalog

Catalog

## Search catalog items

> Returns a paginated list of catalog items matching the supplied criteria.

```json
{"openapi":"3.0.1","info":{"title":"Customer API","version":"v1"},"tags":[{"name":"catalog","description":"Catalog"}],"servers":[{"url":"https://api.partssource.com/customer","description":"Production Environment"}],"security":[{"customer-api-authorizer":[],"api-key":[]}],"components":{"securitySchemes":{"customer-api-authorizer":{"type":"apiKey","description":"AWS Cognito JWT token. Include as 'Authorization: Bearer {token}' header.","name":"Authorization","in":"header"}},"schemas":{"CatalogSearchRequest":{"required":["filters"],"type":"object","properties":{"filters":{"$ref":"#/components/schemas/CatalogSearchFilters"},"pagination":{"$ref":"#/components/schemas/CatalogSearchPagination"}},"additionalProperties":false,"description":"Request parameters for searching the product catalog."},"CatalogSearchFilters":{"required":["query"],"type":"object","properties":{"query":{"maxLength":200,"minLength":1,"pattern":"^[a-zA-Z0-9\\s\\-_\\.]+$","type":"string","description":"Search query string used to find matching products."},"facets":{"type":"array","items":{"$ref":"#/components/schemas/NameValue"},"description":"List of facet filters to narrow search results.","nullable":true}},"additionalProperties":false,"description":"Filter criteria for catalog search operations."},"NameValue":{"type":"object","properties":{"name":{"type":"string","description":"Name or key of the name-value pair.","nullable":true},"value":{"type":"string","description":"Value associated with the name.","nullable":true}},"additionalProperties":false,"description":"Generic name-value pair for representing facet filters and other key-value data."},"CatalogSearchPagination":{"type":"object","properties":{"offset":{"maximum":2147483647,"minimum":0,"type":"integer","description":"Number of items to skip before returning results.","format":"int32"},"limit":{"maximum":100,"minimum":1,"type":"integer","description":"Maximum number of items to return per page.","format":"int32"},"sortBy":{"$ref":"#/components/schemas/CatalogSortBy"},"sortDirection":{"$ref":"#/components/schemas/SortDirection"}},"additionalProperties":false,"description":"Pagination and sorting parameters for catalog search results."},"CatalogSortBy":{"enum":["PartNumber","Description","Manufacturer","Price","QuantityAvailable"],"type":"string","description":"Sorting options for catalog search results.\n\nPossible values:\n- `PartNumber`\n- `Description`\n- `Manufacturer`\n- `Price`\n- `QuantityAvailable`"},"SortDirection":{"enum":["Asc","Desc"],"type":"string","description":"\n\nPossible values:\n- `Asc`\n- `Desc`"},"CatalogSearchResponseApiResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CatalogSearchResponse"},"correlationId":{"type":"string","nullable":true},"timestamp":{"type":"string","format":"date-time"}},"additionalProperties":false},"CatalogSearchResponse":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CatalogItemSummary"},"description":"List of catalog items matching the search criteria."},"facets":{"type":"array","items":{"$ref":"#/components/schemas/SearchFacet"},"description":"Available facets for filtering search results.","nullable":true},"pagination":{"$ref":"#/components/schemas/PaginationInfo"}},"additionalProperties":false,"description":"Response containing catalog search results with items, facets, and pagination information."},"CatalogItemSummary":{"required":["description","partNumber"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the catalog item.","nullable":true},"partNumber":{"minLength":1,"type":"string","description":"Manufacturer part number."},"displayPartNumber":{"type":"string","description":"Formatted part number for display purposes.","nullable":true},"description":{"minLength":1,"type":"string","description":"Product description."},"oem":{"type":"string","description":"Original equipment manufacturer name.","nullable":true},"categories":{"type":"array","items":{"type":"string"},"description":"List of product categories.","nullable":true},"models":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Equipment models compatible with this product, keyed by manufacturer.","nullable":true}},"additionalProperties":false,"description":"Summary information for a catalog item in search results."},"SearchFacet":{"type":"object","properties":{"name":{"type":"string","description":"Facet name (e.g., \"Category\", \"OEM\", \"Models\").","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/FacetResult"},"description":"Facet result values.","nullable":true},"displayLimit":{"type":"integer","description":"Display limit for facet results.","format":"int32"}},"additionalProperties":false,"description":"Search facet with aggregated result counts for filtering catalog items."},"FacetResult":{"type":"object","properties":{"name":{"type":"string","description":"Facet name.","nullable":true},"value":{"type":"string","description":"Facet value.","nullable":true},"count":{"type":"integer","description":"Count of items matching this facet value.","format":"int32"},"parent":{"type":"string","description":"Parent facet for hierarchical facets.","nullable":true}},"additionalProperties":false,"description":"Individual facet value with its count of matching items."},"PaginationInfo":{"required":["hasMore","limit","offset","total"],"type":"object","properties":{"total":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"limit":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"offset":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"hasMore":{"type":"boolean"}},"additionalProperties":false},"ApiProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true},"correlationId":{"type":"string","nullable":true},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"timestamp":{"type":"string","format":"date-time"},"service":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/catalog/search":{"post":{"tags":["catalog"],"summary":"Search catalog items","description":"Returns a paginated list of catalog items matching the supplied criteria.","operationId":"SearchCatalog","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogSearchRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/CatalogSearchRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CatalogSearchRequest"}}}},"responses":{"200":{"description":"Search results.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogSearchResponseApiResponse"}}}},"400":{"description":"Invalid request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiProblemDetails"}}}},"403":{"description":"Unauthorized access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiProblemDetails"}}}}}}}}}
```

## Catalog item detail

> Retrieves detailed information for a catalog item.

```json
{"openapi":"3.0.1","info":{"title":"Customer API","version":"v1"},"tags":[{"name":"catalog","description":"Catalog"}],"servers":[{"url":"https://api.partssource.com/customer","description":"Production Environment"}],"security":[{"customer-api-authorizer":[],"api-key":[]}],"components":{"securitySchemes":{"customer-api-authorizer":{"type":"apiKey","description":"AWS Cognito JWT token. Include as 'Authorization: Bearer {token}' header.","name":"Authorization","in":"header"}},"schemas":{"CatalogItemDetailRequest":{"required":["facilityId","productId","requesterId"],"type":"object","properties":{"productId":{"minLength":1,"type":"string","description":"Unique identifier for the product."},"facilityId":{"type":"integer","description":"Facility identifier to scope the catalog request.","format":"int64"},"requesterId":{"type":"integer","description":"User identifier making the request.","format":"int64"}},"additionalProperties":false,"description":"Request parameters for retrieving detailed information about a catalog item."},"CatalogItemDetailResponseApiResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CatalogItemDetailResponse"},"correlationId":{"type":"string","nullable":true},"timestamp":{"type":"string","format":"date-time"}},"additionalProperties":false},"CatalogItemDetailResponse":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/CatalogProduct"},"options":{"type":"array","items":{"$ref":"#/components/schemas/PricingOption"},"description":"Available pricing options for the product.","nullable":true}},"additionalProperties":false,"description":"Response containing detailed product and pricing information."},"CatalogProduct":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the product.","nullable":true},"partNumber":{"type":"string","description":"Manufacturer part number.","nullable":true},"title":{"type":"string","description":"Product title or name.","nullable":true},"displayPartNumber":{"type":"string","description":"Formatted part number for display purposes.","nullable":true},"equivalentPartNumber":{"type":"string","description":"Alternative part number that can be used interchangeably.","nullable":true},"description":{"type":"string","description":"Short description of the product.","nullable":true},"longDescription":{"type":"string","description":"Extended description with additional product details.","nullable":true},"keywords":{"type":"string","description":"Search keywords associated with the product.","nullable":true},"manufacturer":{"type":"string","description":"Name of the product manufacturer.","nullable":true},"weight":{"type":"number","description":"Product weight in pounds.","format":"double","nullable":true},"models":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Equipment models compatible with this product, keyed by manufacturer.","nullable":true},"oemCompatibleParts":{"type":"array","items":{"$ref":"#/components/schemas/ProductCompatiblePart"},"description":"List of OEM compatible parts for this product.","nullable":true},"equivalentParts":{"type":"array","items":{"type":"string"},"description":"List of equivalent part numbers from other manufacturers.","nullable":true},"productAttributes":{"type":"array","items":{"$ref":"#/components/schemas/InventoryItemAttribute"},"description":"Additional product attributes and specifications.","nullable":true}},"additionalProperties":false,"description":"Detailed product information from the catalog."},"ProductCompatiblePart":{"type":"object","properties":{"oemItemNumber":{"type":"string","description":"OEM item number for the compatible part.","nullable":true},"displayPartNumber":{"type":"string","description":"Formatted part number for display purposes.","nullable":true},"oemName":{"type":"string","description":"Name of the original equipment manufacturer.","nullable":true},"purpose":{"type":"string","description":"Intended purpose or use case for the part.","nullable":true}},"additionalProperties":false,"description":"Information about an OEM compatible part."},"InventoryItemAttribute":{"type":"object","properties":{"name":{"type":"string","description":"Attribute name (e.g., \"Color\", \"Size\", \"Voltage\").","nullable":true},"value":{"type":"string","description":"Attribute value.","nullable":true}},"additionalProperties":false,"description":"Product attribute name-value pair."},"PricingOption":{"type":"object","properties":{"priceOptionId":{"type":"string","description":"Unique identifier for this pricing option.","nullable":true},"price":{"type":"number","description":"Unit price for the product.","format":"double"},"condition":{"type":"string","description":"Product condition (e.g., \"New\", \"Refurbished\", \"Used\").","nullable":true},"warranty":{"type":"string","description":"Warranty terms for this pricing option.","nullable":true},"purchaseChoice":{"type":"string","description":"Purchase choice type (e.g., \"Outright\", \"Exchange\", \"Repair\").","nullable":true},"unitOfMeasurement":{"type":"string","description":"Unit of measurement for pricing (e.g., \"Each\", \"Box\", \"Case\").","nullable":true},"minimumOrderQuantity":{"type":"integer","description":"Minimum quantity required for this pricing option.","format":"int64","nullable":true},"estimatedShipDate":{"type":"string","description":"Estimated ship date for this option.","nullable":true},"estimatedShipDateMessage":{"type":"string","description":"Estimated Ship Message","nullable":true},"vendorCertifications":{"type":"array","items":{"type":"string"},"description":"List of vendor certifications (e.g., \"ISO\", \"OEM Certified\").","nullable":true},"coreCharge":{"type":"number","description":"Core Charge","format":"double"},"requestQuote":{"type":"boolean","description":"Request For Quote"},"reason":{"type":"string","description":"Request For Quote Reason","nullable":true},"formulary":{"$ref":"#/components/schemas/FormularyDto"},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/PricingCustomFieldDto"},"description":"Custom fields required for this pricing option.","nullable":true},"isHazmat":{"type":"boolean","description":"Is Hazmat"},"isProp65":{"type":"boolean","description":"Is Prop65"},"prop65Warning":{"type":"string","description":"Prop65 Warning","nullable":true},"bulkPricing":{"$ref":"#/components/schemas/BulkPricingDto"}},"additionalProperties":false,"description":"Pricing option for a catalog product."},"FormularyDto":{"type":"object","properties":{"status":{"type":"string","description":"Status","nullable":true},"approvalRequired":{"type":"boolean","description":"Whether approval is required"}},"additionalProperties":false},"PricingCustomFieldDto":{"type":"object","properties":{"fieldId":{"type":"string","description":"Unique identifier for the custom field.","nullable":true},"prompt":{"type":"string","description":"Label or prompt text displayed to the user.","nullable":true},"description":{"type":"string","description":"Detailed description of the field purpose.","nullable":true},"isRequired":{"type":"boolean","description":"Indicates whether the field must be filled in."},"formatRegex":{"type":"string","description":"Regular expression pattern for input validation.","nullable":true},"errorMessage":{"type":"string","description":"Error message displayed when validation fails.","nullable":true},"placeholder":{"type":"string","description":"Placeholder text shown in the input field.","nullable":true}},"additionalProperties":false,"description":"Custom field for a pricing option."},"BulkPricingDto":{"type":"object","properties":{"tiers":{"type":"array","items":{"$ref":"#/components/schemas/BulkPricingItemDto"},"description":"Bulk pricing tiers","nullable":true}},"additionalProperties":false,"description":"Bulk pricing information"},"BulkPricingItemDto":{"required":["minQuantity","price"],"type":"object","properties":{"minQuantity":{"type":"integer","description":"Minimum quantity for this tier","format":"int32"},"maxQuantity":{"type":"integer","description":"Maximum quantity for this tier","format":"int32","nullable":true},"price":{"type":"number","description":"Price for this tier","format":"double"}},"additionalProperties":false,"description":"A single bulk pricing tier"},"ApiProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true},"correlationId":{"type":"string","nullable":true},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"timestamp":{"type":"string","format":"date-time"},"service":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/catalog/detail":{"post":{"tags":["catalog"],"summary":"Catalog item detail","description":"Retrieves detailed information for a catalog item.","operationId":"GetCatalogItemDetail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogItemDetailRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/CatalogItemDetailRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CatalogItemDetailRequest"}}}},"responses":{"200":{"description":"Item detail.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogItemDetailResponseApiResponse"}}}},"400":{"description":"Invalid request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiProblemDetails"}}}},"403":{"description":"Unauthorized access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiProblemDetails"}}}},"404":{"description":"Item not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiProblemDetails"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.partssource.com/api-customer/catalog.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.