List Recommendations

post/recommendations.recommend

Retrieves recommended Quote items for a customer, segment, or a product.

See also: Configure Recommended Items Knowledge base article.

If the endpoint receives a request data containing a Quote typedId and a QuoteProductFilter logic is configured in the partition (see Quote Product Picker Filter Logic), then the endpoint will evaluate this logic with the corresponding Quote and gives the resulting Filter object to the recommendation model evaluation.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
required
object
customers
Array of strings
products
Array of strings

Specify SKUs that have been already added to the Quote to exclude them from recommendations. Use the /clicmanager.fetchitemuniquetypes/{typedId} endpoint to retrieve these SKUs.

excludeProducts
Array of strings

Specify any products (SKUs) you want to explicitly exclude from recommendations.

maxResults
integer
typedId
string

typedId of the Quote you want to get the recommendations for.

Responses
200

OK

Response Schema: application/json
object
node
string
Array of objects
Array
categoryName
string
Array of objects
status
integer
Request samples
application/json
{
  • "data": {
    • "customers": [
      • "CD-0001"
      ]
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "pricefx-cluster-app-frontend-844d685f8b-8hn7d",
    • "data": [
      • {
        • "categoryName": "customer",
        • "items": [ ]
        },
      • {
        • "categoryName": "productHistory",
        • "items": [
          ]
        },
      • {
        • "categoryName": "productRelations",
        • "items": [
          ]
        }
      ],
    • "status": 0
    }
}