Get product recommendations

Returns recommended products for an order based on workspace history and fallback catalog data.

POST/api/product-recommendations/query

Returns recommended products for an order based on workspace history and fallback catalog data.

Request Body

application/json

Request payload for Get product recommendations.

TypeScript Definitions

Use the request body type in TypeScript.

orderId*string

Order identifier used as the recommendation context.

Example"order_123"

Response Body

`application/json`

curl -X POST "https://example.com/api/product-recommendations/query" \  -H "Content-Type: application/json" \  -d '{    "orderId": "order_123"  }'

[  {    "id": "recommended-products",    "title": "Recommended products",    "description": "Top-selling products from similar orders.",    "lines": [      {        "productId": "product_123",        "name": "Fertilizer Pack",        "sku": "SKU-123",        "price": 19990,        "currency": "USD",        "imageUrl": "https://files.recerc.test/product-image.jpg",        "recommendedQuantity": 0,        "product": {          "baseUnit": {            "type": "base",            "code": "unit",            "name": "Unit",            "dimension": "count",            "step": 0,            "rounding": "nearest"          },          "alternativeUnits": [            {              "type": "alternative",              "code": "box",              "name": "Box",              "factor": 0,              "dimension": "count",              "rounding": "nearest"            }          ]        }      }    ]  }]

{  "_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."}

Get product recommendations

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`