> 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/search/searchable-fields.md). # Searchable Fields Reference Available search fields for Customer API GET search endpoints Each GET search endpoint defines its own set of searchable fields. This page lists the available fields, their types, and example queries for each endpoint. For full query syntax, operators, and boolean logic, see the [Search Query Language](https://github.com/PartsSourceInc/gitbook-documentation/blob/main/documentation/core-concepts/search-query-language/README.md). Querying an unregistered field returns a `400 Bad Request` error listing the valid fields for that endpoint. *** ## GET /manufacturers/search | Field | Type | Description | Example | | ---------------- | ------- | ------------------------------------ | ------------------------------------------------- | | `name` | String | Manufacturer name (case-insensitive) | `name~"philips"` or `name:"Siemens Healthineers"` | | `manufacturerId` | Numeric | Manufacturer ID | `manufacturerId:26799` | **Examples:** ``` GET /manufacturers/search?q=name~"philips" GET /manufacturers/search?q=manufacturerId:26799 GET /manufacturers/search?q=name~"philips" AND manufacturerId:26799 ``` *** ## GET /orders/search > **Note:** Delegates to the external Order API. The `q` parameter is passed through. | Field | Type | Level | Supports IN | Description | Example | | --------------------- | -------- | --------- | ----------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------- | | `orderId` | Token | Order | Yes | Order ID (bypass field) | `orderId:10001` or `orderId IN [10001, 10002]` | | `companyId` | Token | Order | Yes | Company ID | `companyId:12345` | | `rootCompanyId` | Token | Order | Yes | Root company ID (alternative to companyId) | `rootCompanyId:100` | | `requesterId` | Token | Order | Yes | Requester ID | `requesterId:500` | | `createdDate` | DateTime | Order | No | Order creation date (ISO 8601) | `createdDate>="2026-01-01"` | | `status` | Token | Line Item | Yes | Line item status name ([values](#line-item-status-values)) | `status:"Ordered"` or `status IN ["Ordered", "Shipped"]` | | `poNumber` | String | Line Item | No | Line item purchase order number (case-insensitive, bypass field) | `poNumber~"PO-456"` or `poNumber:"PO-456"` | | `lineId` | Token | Line Item | No | Line item ID (bypass field) | `lineId:789012` | | `partNumber` | String | Line Item | No | Part number — searches both replacement and requested part number (case-insensitive, always substring match) | `partNumber~"MOT"` | | `lineItemDescription` | String | Line Item | No | Line item description (case-insensitive) | `lineItemDescription~"pump"` | **Validation rules:** * Either `orderId`, `poNumber`, or `lineId` must be specified, **or** both `companyId` (or `rootCompanyId`) and a bounded `createdDate` range are required. * Date ranges cannot exceed **90 days** and require both upper and lower bounds. * Negation (`-`) is **not supported** for `companyId` or `status`. * Only `AND` logic is supported — `OR` queries are rejected. **Related data:** Use `include=lineItems`, `include=shippingInfo`, or `include=lineItems,shippingInfo` to fetch related data inline. See [Including Related Data](https://github.com/PartsSourceInc/gitbook-documentation/blob/main/documentation/core-concepts/including-related-data.md). **Response fields:** Each order includes `poNumber` and `requesterName`. Line items (when included) include `requestedPartNumber`, `replacementPartNumber`, and `statusName`. Shipping info (when included) returns address, carrier, and service level. ### Line item status values | statusName | | ---------------------- | | Awaiting Approval | | Awaiting PO | | Approval Rejected | | Back Ordered | | Delivered | | Ordered | | Quoted | | Requested | | Return Requested | | Returned | | Repairing | | Shipped | | Submitted for Punchout | | Initiated | | Open Service | | Work Completed | | Info Requested | **Examples:** ``` GET /orders/search?q=companyId:12345 AND status:"Ordered" AND createdDate>="2026-01-01" AND createdDate<"2026-02-01" GET /orders/search?q=companyId:12345 AND createdDate>="2026-01-01" AND createdDate<"2026-02-01" GET /orders/search?q=status:"Shipped" AND companyId:500 AND createdDate>="2026-01-01" AND createdDate<"2026-04-01" GET /orders/search?q=poNumber~"PO-456" GET /orders/search?q=lineId:789012 GET /orders/search?q=orderId IN [10001, 10002, 10003] GET /orders/search?q=companyId:12345 AND partNumber~"motor" AND createdDate>="2026-01-01" AND createdDate<"2026-02-01" GET /orders/search?q=companyId:12345 AND createdDate>="2026-01-01" AND createdDate<"2026-02-01"&include=lineItems,shippingInfo ``` *** ## GET /users/search {% hint style="info" %} The searchable fields for this endpoint will be documented here once finalized. In the meantime, querying with an invalid field name will return a `400` response listing the valid fields. {% endhint %} --- # 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/search/searchable-fields.md?ask=&goal= ``` `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.