Jump to

• Request
• Response
• Examples

Render Recommended Products

post

/rest/v19/intelligence/actions/recommendProducts

Use this endpoint to render product recommendations during runtime.

Request

Supported Media Types

• application/json

Body ()

Root Schema : RecommendProductsRequest

Type: object

Show Source

• commerce: Commerce
  Title: Commerce

  The commerce data source.

{
    "properties":{
        "commerce":{
            "format":"",
            "description":"The commerce data source.",
            "title":"Commerce",
            "allOf":[
                {
                    "$ref":"#/definitions/CommerceIntelligenceDataSource"
                }
            ]
        }
    }
}

Nested Schema : Commerce

Title: Commerce

The commerce data source.

Match All

The commerce data source.

Show Source

• object CommerceIntelligenceDataSource

{
    "format":"",
    "description":"The commerce data source.",
    "title":"Commerce",
    "allOf":[
        {
            "$ref":"#/definitions/CommerceIntelligenceDataSource"
        }
    ]
}

Nested Schema : CommerceIntelligenceDataSource

Type: object

Show Source

• cacheInstanceId: string()
  Title: Cache Instance ID

  The commerce cache instance ID.
• id: integer()
  Title: Transaction ID

  Transaction ID.
• maxTopPicks: integer()
  Title: Maximum Number Of Top Picks

  The maximum number of top picks to return.
• onlyTopPicks: boolean()
  Title: Only Top Picks

  Flag which gets all recommendation categories in addition to the Top Picks cagtegory if false. This is an optional parameter which defaults to true.
• trainingId: integer()
  Title: Training ID

  Training ID.

{
    "properties":{
        "id":{
            "type":"integer",
            "format":"",
            "description":"Transaction ID.",
            "title":"Transaction ID"
        },
        "cacheInstanceId":{
            "type":"string",
            "format":"",
            "description":"The commerce cache instance ID.",
            "title":"Cache Instance ID"
        },
        "onlyTopPicks":{
            "type":"boolean",
            "format":"",
            "description":"Flag which gets all recommendation categories in addition to the Top Picks cagtegory if false. This is an optional parameter which defaults to true.",
            "title":"Only Top Picks"
        },
        "maxTopPicks":{
            "type":"integer",
            "format":"",
            "description":"The maximum number of top picks to return.",
            "title":"Maximum Number Of Top Picks"
        },
        "trainingId":{
            "type":"integer",
            "format":"",
            "description":"Training ID.",
            "title":"Training ID"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Success

Body ()

Root Schema : RecommendProductsResponse

Type: object

Show Source

• customersAlsoBought: array Customers Also Bought
  Title: Customers Also Bought

  The recommendations of products also bought by customers.
• frequentlyBoughtTogether: array Frequently Bought Together
  Title: Frequently Bought Together

  The recommendations of products frequently bought together.
• topPicks: array Top Picks
  Title: Top Picks

  The top recommendations.

{
    "properties":{
        "topPicks":{
            "type":"array",
            "format":"",
            "description":"The top recommendations.",
            "title":"Top Picks",
            "items":{
                "$ref":"#/definitions/RecommendationResponse"
            }
        },
        "frequentlyBoughtTogether":{
            "type":"array",
            "format":"",
            "description":"The recommendations of products frequently bought together.",
            "title":"Frequently Bought Together",
            "items":{
                "$ref":"#/definitions/RecommendationResponse"
            }
        },
        "customersAlsoBought":{
            "type":"array",
            "format":"",
            "description":"The recommendations of products also bought by customers.",
            "title":"Customers Also Bought",
            "items":{
                "$ref":"#/definitions/RecommendationResponse"
            }
        }
    }
}

Nested Schema : Customers Also Bought

Type: array

Title: Customers Also Bought

The recommendations of products also bought by customers.

Show Source

• Array of: object RecommendationResponse

{
    "type":"array",
    "format":"",
    "description":"The recommendations of products also bought by customers.",
    "title":"Customers Also Bought",
    "items":{
        "$ref":"#/definitions/RecommendationResponse"
    }
}

Nested Schema : Frequently Bought Together

Type: array

Title: Frequently Bought Together

The recommendations of products frequently bought together.

Show Source

• Array of: object RecommendationResponse

{
    "type":"array",
    "format":"",
    "description":"The recommendations of products frequently bought together.",
    "title":"Frequently Bought Together",
    "items":{
        "$ref":"#/definitions/RecommendationResponse"
    }
}

Nested Schema : Top Picks

Type: array

Title: Top Picks

The top recommendations.

Show Source

• Array of: object RecommendationResponse

{
    "type":"array",
    "format":"",
    "description":"The top recommendations.",
    "title":"Top Picks",
    "items":{
        "$ref":"#/definitions/RecommendationResponse"
    }
}

Nested Schema : RecommendationResponse

Type: object

Show Source

• confidence: number()
  Title: Confidence

  The rule confidence measure between 0 to 1.
• lift: number()
  Title: Lift

  The rule lift measure.
• rank: integer()
  Title: Rank

  The recommendation rank.
• recommendationReason: string()
  Title: Reason

  The reason for the recommendation.
• recommendationType: string()
  Title: Type

  Allowed Values: [ "frequentlyBoughtTogether", "customersAlsoBought" ]

  The recommendation type.
• recommendedItem: Recommended Item
  Title: Recommended Item

  The recommended item.

{
    "properties":{
        "recommendedItem":{
            "format":"",
            "description":"The recommended item.",
            "title":"Recommended Item",
            "allOf":[
                {
                    "$ref":"#/definitions/RecommendedItem"
                }
            ]
        },
        "rank":{
            "type":"integer",
            "format":"",
            "description":"The recommendation rank.",
            "title":"Rank"
        },
        "recommendationType":{
            "type":"string",
            "format":"",
            "description":"The recommendation type.",
            "title":"Type",
            "enum":[
                "frequentlyBoughtTogether",
                "customersAlsoBought"
            ]
        },
        "recommendationReason":{
            "type":"string",
            "format":"",
            "description":"The reason for the recommendation.",
            "title":"Reason"
        },
        "confidence":{
            "type":"number",
            "format":"",
            "description":"The rule confidence measure between 0 to 1.",
            "title":"Confidence"
        },
        "lift":{
            "type":"number",
            "format":"",
            "description":"The rule lift measure.",
            "title":"Lift"
        }
    }
}

Nested Schema : Recommended Item

Title: Recommended Item

The recommended item.

Match All

The recommended item.

Show Source

• object RecommendedItem

{
    "format":"",
    "description":"The recommended item.",
    "title":"Recommended Item",
    "allOf":[
        {
            "$ref":"#/definitions/RecommendedItem"
        }
    ]
}

Nested Schema : RecommendedItem

Type: object

Show Source

• bomItemVariableName: string()
  Title: BOM Item Variable Name

  The BOM Item variable name.
• description: string()
  Title: Description

  The product description.
• id: integer()
  Title: ID

  The top recommendations.
• label: string()
  Title: Label

  The product label.
• listPrice: string()
  Title: List Price

  The list price.
• partNumber: string()
  Title: Part Number

  The part number.
• productIdentifier: string()
  Title: Product Identifier

  The product identifier.
• productType: object Product Type
  Title: Product Type

  The product type.
• status: object Status
  Title: Status

  The product status.

{
    "properties":{
        "id":{
            "type":"integer",
            "format":"",
            "description":"The top recommendations.",
            "title":"ID"
        },
        "partNumber":{
            "type":"string",
            "format":"",
            "description":"The part number.",
            "title":"Part Number"
        },
        "productIdentifier":{
            "type":"string",
            "format":"",
            "description":"The product identifier.",
            "title":"Product Identifier"
        },
        "bomItemVariableName":{
            "type":"string",
            "format":"",
            "description":"The BOM Item variable name.",
            "title":"BOM Item Variable Name"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"The product description.",
            "title":"Description"
        },
        "label":{
            "type":"string",
            "format":"",
            "description":"The product label.",
            "title":"Label"
        },
        "listPrice":{
            "type":"string",
            "format":"",
            "description":"The list price.",
            "title":"List Price"
        },
        "status":{
            "type":"object",
            "format":"",
            "description":"The product status.",
            "title":"Status"
        },
        "productType":{
            "type":"object",
            "format":"",
            "description":"The product type.",
            "title":"Product Type"
        }
    }
}

Nested Schema : Product Type

Type: object

Title: Product Type

The product type.

Nested Schema : Status

Type: object

Title: Status

The product status.

Back to Top

Examples

The following example shows how to render product recommendations during runtime by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/intelligence/actions/recommendProducts

Request Body Sample

{
  "commerce": {
    "id": 3023201387,
    "cacheInstanceId": "K4MAHuD725BG6ivxR3tvGqazte22AOVHIb9owz7WmBtO84saOneTD3hN4Nkb73i9",
    "onlyTopPicks": false,
    "maxTopPicks": 4
  }
}

Response Body Sample

{
  "topPicks": [{
      "recommendedItem": {
        "id": 15213819,
        "partNumber": "Customer Specific Pricing 02",
        "productIdentifier": "PART_Customer Specific Pricing 02",
        "description": "Base price in all currencies - Absolute price profile in USD only",
        "label": "Customer Specific Pricing 02",
        "listPrice": "$2.00",
        "status": {
          "displayValue": "Created",
          "lookupCode": "ORA_CREATED"
        },
        "productType": {
          "displayValue": "Part",
          "lookupCode": 0
        }
      },
      "rank": 1,
      "recommendationType": "customersAlsoBought",
      "recommendationReason": "Customers also bought this item with others in the transaction.",
      "confidence": 1.0,
      "lift": 2.0
    }, {
      "recommendedItem": {
        "id": 8523277,
        "partNumber": "part100",
        "productIdentifier": "PART_part100",
        "label": "Part Display 100",
        "listPrice": "$100.00",
        "status": {
          "displayValue": "Created",
          "lookupCode": "ORA_CREATED"
        },
        "productType": {
          "displayValue": "Part",
          "lookupCode": 0
        }
      },
      "rank": 2,
      "recommendationType": "frequentlyBoughtTogether",
      "recommendationReason": "This item is frequently bought together with others in the transaction.",
      "confidence": 1.0,
      "lift": 2.793103448275862
    }, {
      "recommendedItem": {
        "id": 8523072,
        "partNumber": "part1",
        "productIdentifier": "BOM_configIntegrationRoot",
        "bomItemVariableName": "configIntegrationRoot",
        "label": "Part Display 1",
        "listPrice": "$1.00",
        "status": {
          "displayValue": "Created",
          "lookupCode": "ORA_CREATED"
        },
        "productType": {
          "displayValue": "Bom",
          "lookupCode": 1
        }
      },
      "rank": 3,
      "recommendationType": "frequentlyBoughtTogether",
      "recommendationReason": "This item is frequently bought together with others in the transaction.",
      "confidence": 0.9655172413793104,
      "lift": 1.4756018217306441
    }, {
      "recommendedItem": {
        "id": 19823338,
        "partNumber": "PriceScore1",
        "productIdentifier": "PART_PriceScore1",
        "description": "pricescore",
        "label": "PriceScore1",
        "listPrice": "$200.00",
        "status": {
          "displayValue": "Created",
          "lookupCode": "ORA_CREATED"
        },
        "productType": {
          "displayValue": "Part",
          "lookupCode": 0
        }
      },
      "rank": 4,
      "recommendationType": "customersAlsoBought",
      "recommendationReason": "Customers also bought this item with others in the transaction.",
      "confidence": 1.0,
      "lift": 2.0
    }, {
      "recommendedItem": {
        "id": 8523091,
        "partNumber": "part10",
        "productIdentifier": "PART_part10",
        "label": "Part Display 10",
        "listPrice": "$10.00",
        "status": {
          "displayValue": "Created",
          "lookupCode": "ORA_CREATED"
        },
        "productType": {
          "displayValue": "Part",
          "lookupCode": 0
        }
      },
      "rank": 5,
      "recommendationType": "frequentlyBoughtTogether",
      "recommendationReason": "This item is frequently bought together with others in the transaction.",
      "confidence": 0.9655172413793104,
      "lift": 2.6068965517241383
    }
  ],
  "frequentlyBoughtTogether": [{
      "recommendedItem": {
        "id": 8523277,
        "partNumber": "part100",
        "productIdentifier": "PART_part100",
        "label": "Part Display 100",
        "listPrice": "$100.00",
        "status": {
          "displayValue": "Created",
          "lookupCode": "ORA_CREATED"
        },
        "productType": {
          "displayValue": "Part",
          "lookupCode": 0
        }
      },
      "rank": 1,
      "recommendationType": "frequentlyBoughtTogether",
      "recommendationReason": "This item is frequently bought together with others in the transaction.",
      "confidence": 1.0,
      "lift": 2.793103448275862
    }, {
      "recommendedItem": {
        "id": 8523072,
        "partNumber": "part1",
        "productIdentifier": "BOM_configIntegrationRoot",
        "bomItemVariableName": "configIntegrationRoot",
        "label": "Part Display 1",
        "listPrice": "$1.00",
        "status": {
          "displayValue": "Created",
          "lookupCode": "ORA_CREATED"
        },
        "productType": {
          "displayValue": "Bom",
          "lookupCode": 1
        }
      },
      "rank": 2,
      "recommendationType": "frequentlyBoughtTogether",
      "recommendationReason": "This item is frequently bought together with others in the transaction.",
      "confidence": 0.9655172413793104,
      "lift": 1.4756018217306441
    }, {
      "recommendedItem": {
        "id": 8523091,
        "partNumber": "part10",
        "productIdentifier": "PART_part10",
        "label": "Part Display 10",
        "listPrice": "$10.00",
        "status": {
          "displayValue": "Created",
          "lookupCode": "ORA_CREATED"
        },
        "productType": {
          "displayValue": "Part",
          "lookupCode": 0
        }
      },
      "rank": 3,
      "recommendationType": "frequentlyBoughtTogether",
      "recommendationReason": "This item is frequently bought together with others in the transaction.",
      "confidence": 0.9655172413793104,
      "lift": 2.6068965517241383
    }, {
      "recommendedItem": {
        "id": 8523281,
        "partNumber": "part102",
        "productIdentifier": "PART_part102",
        "label": "part102",
        "listPrice": "$102.00",
        "status": {
          "displayValue": "Created",
          "lookupCode": "ORA_CREATED"
        },
        "productType": {
          "displayValue": "Part",
          "lookupCode": 0
        }
      },
      "rank": 4,
      "recommendationType": "frequentlyBoughtTogether",
      "recommendationReason": "This item is frequently bought together with others in the transaction.",
      "confidence": 0.9655172413793104,
      "lift": 2.793103448275862
    }
  ],
  "customersAlsoBought": [{
      "recommendedItem": {
        "id": 15213819,
        "partNumber": "Customer Specific Pricing 02",
        "productIdentifier": "PART_Customer Specific Pricing 02",
        "description": "Base price in all currencies - Absolute price profile in USD only",
        "label": "Customer Specific Pricing 02",
        "listPrice": "$2.00",
        "status": {
          "displayValue": "Created",
          "lookupCode": "ORA_CREATED"
        },
        "productType": {
          "displayValue": "Part",
          "lookupCode": 0
        }
      },
      "rank": 1,
      "recommendationType": "customersAlsoBought",
      "recommendationReason": "Customers also bought this item with others in the transaction.",
      "confidence": 1.0,
      "lift": 2.0
    }, {
      "recommendedItem": {
        "id": 19823338,
        "partNumber": "PriceScore1",
        "productIdentifier": "PART_PriceScore1",
        "description": "pricescore",
        "label": "PriceScore1",
        "listPrice": "$200.00",
        "status": {
          "displayValue": "Created",
          "lookupCode": "ORA_CREATED"
        },
        "productType": {
          "displayValue": "Part",
          "lookupCode": 0
        }
      },
      "rank": 2,
      "recommendationType": "customersAlsoBought",
      "recommendationReason": "Customers also bought this item with others in the transaction.",
      "confidence": 1.0,
      "lift": 2.0
    }, {
      "recommendedItem": {
        "id": 8523135,
        "partNumber": "part32",
        "productIdentifier": "PART_part32",
        "label": "part32",
        "listPrice": "$32.00",
        "status": {
          "displayValue": "Created",
          "lookupCode": "ORA_CREATED"
        },
        "productType": {
          "displayValue": "Part",
          "lookupCode": 0
        }
      },
      "rank": 3,
      "recommendationType": "customersAlsoBought",
      "recommendationReason": "Customers also bought this item with others in the transaction.",
      "confidence": 1.0,
      "lift": 2.0
    }, {
      "recommendedItem": {
        "id": 8523080,
        "partNumber": "part5",
        "productIdentifier": "PART_part5",
        "label": "Part Display 5",
        "listPrice": "$5.00",
        "status": {
          "displayValue": "Created",
          "lookupCode": "ORA_CREATED"
        },
        "productType": {
          "displayValue": "Part",
          "lookupCode": 0
        }
      },
      "rank": 4,
      "recommendationType": "customersAlsoBought",
      "recommendationReason": "Customers also bought this item with others in the transaction.",
      "confidence": 1.0,
      "lift": 2.0
    }, {
      "recommendedItem": {
        "id": 16267157,
        "partNumber": "Basic Pricing 13",
        "productIdentifier": "PART_Basic Pricing 13",
        "description": "Explicitly added to Pricebook 5: Multiplier of Pricebook 3 (10.0x) in all MDB currencies.",
        "label": "Basic Pricing 13",
        "listPrice": "$1.00",
        "status": {
          "displayValue": "Created",
          "lookupCode": "ORA_CREATED"
        },
        "productType": {
          "displayValue": "Part",
          "lookupCode": 0
        }
      },
      "rank": 5,
      "recommendationType": "customersAlsoBought",
      "recommendationReason": "Customers also bought this item with others in the transaction.",
      "confidence": 1.0,
      "lift": 2.0
    }
  ]
}

Back to Top