Search products

POST/api/products/search

Searches products using full-text query, filters, and pricing context.

Request Body

application/json

Request payload for Search products.

TypeScript Definitions

Use the request body type in TypeScript.

query*string

Free-text search query applied to products.

Example"valve"

priceListId*|

Price list identifier used to resolve product pricing.

Example"DEFAULT"

filters?array<>|

Structured product filters applied before search ranking.

sorting?array<>|

Product sorting applied before pagination.

onlyFavorites?|

Whether to restrict results to favorite products.

Examplefalse

targetCurrency?|

Target currency code for converted prices.

Example"USD"

customerId?|

Customer identifier used only to evaluate customer-specific pricing metadata.

limit?|||||

Maximum number of products to return.

Example50

offset?|||||

Number of products to skip before returning results.

Example0

searchType?|

Which indexed field should be searched.

Example"all"

orderSelectableOnly?|

Whether to return only products selectable on sales orders.

lifecycleScope?|

Lifecycle scope used to include active, archived, or all products.

Response Body

`application/json`

curl -X POST "https://example.com/api/products/search" \  -H "Content-Type: application/json" \  -d '{    "query": "valve",    "priceListId": "DEFAULT"  }'

[  {    "id": "prod_123",    "workspaceId": "ws_123",    "handle": "string",    "sku": "string",    "productGroup": "string",    "title": "string",    "description": "string",    "vendor": "string",    "category": "string",    "categoryId": "string",    "lifecycleStatus": "string",    "archivedAt": "string",    "deletedAt": "string",    "searchText": "string",    "basePrice": {      "amount": 0,      "currencyCode": "USD"    },    "baseCost": {      "amount": 0,      "currencyCode": "USD"    },    "data": {},    "customFields": {},    "createdAt": "string",    "updatedAt": "string",    "baseUnit": null,    "alternativeUnits": [],    "referenceUnits": [],    "defaultUnitCode": "string",    "price": {      "amount": 0,      "currencyCode": "USD"    },    "mainImageSrc": "string",    "priceSource": null,    "pricingMetadata": null,    "isFavorite": true,    "calculatedFields": null  }]

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`