Skip to main content
API docs by Redocly

Product Recommendation (1.0)

Download OpenAPI specification:Download

License: Nexway License Version 1.0

API to manage product recommendations (crossell, upsell, upgrade)

ProductRecommendation

Get items

Authorizations:
Bearer
query Parameters
required
object (Pageable)
predicate
required
object
target
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Create an item

Authorizations:
Bearer
Request Body schema: application/json
required
One of
catalogId
string
createDate
string <date-time>
Deprecated
customerId
string
dbVersion
integer <int64>
object (DiscountPlan)

Discount plan

eligibleParentProductIds
Array of strings unique

Parent product ids on which recommendation can be applied

eligibleProductIds
Array of strings unique

Variant product ids on which recommendation can be applied

eligibleStoreIds
required
Array of strings unique

Store ids on which recommendation can be applied

endDate
required
string <date-time>

Rule end date timestamp in milliseconds

fallbackLocale
string

Fallback locale

function
required
string
Value: "predefinedIdsRecoRule, idToIdsRecoRule"

Recommendations selection mode

id
string
Deprecated
lastUpdateReason
string
levels
required
Array of strings unique
Items Enum: "CART" "PRODUCT" "PURCHASE" "INTERSTITIAL" "CART, PRODUCT, PURCHASE, INTERSTITIAL"

Level on which recommendation will be displayed

object

Localized descriptions

marketingOperationId
string

Prices and bundle from this marketing operation will be applied

modelVersion
string
Deprecated
name
required
string

Rule name

originalId
string
sources
Array of strings unique
Items Enum: "PURCHASE" "SUBSCRIPTION" "MANUAL_RENEWAL" "BILLING_PLAN" "UPGRADE" "PURCHASE, SUBSCRIPTION, MANUAL_RENEWAL, BILLING_PLAN"

Restriction of recommendation to specific sources

startDate
required
string <date-time>

Rule start date timestamp in milliseconds

status
required
string
Enum: "ENABLED" "DISABLED"

Rule status

type
required
string
Enum: "CROSS_SELL" "UP_SELL" "UPGRADE" "DEFAULT" "CROSS_SELL, UP_SELL, UPGRADE"

Recommendation type

updateDate
string <date-time>
Deprecated
weight
integer <int32>

Set rule priority when several rules apply. Bigger weight = bigger priority

object
object

Responses

Request samples

Content type
application/json
Example
{
  • "catalogId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "discountPlan": {
    },
  • "eligibleParentProductIds": [
    ],
  • "eligibleProductIds": [
    ],
  • "eligibleStoreIds": [
    ],
  • "endDate": "2019-08-24T14:15:22Z",
  • "fallbackLocale": "string",
  • "function": "predefinedIdsRecoRule, idToIdsRecoRule",
  • "id": "string",
  • "lastUpdateReason": "string",
  • "levels": "CART, PRODUCT, PURCHASE, INTERSTITIAL",
  • "localizedDesc": {
    },
  • "marketingOperationId": "string",
  • "modelVersion": "string",
  • "name": "string",
  • "originalId": "string",
  • "sources": "PURCHASE, SUBSCRIPTION, MANUAL_RENEWAL, BILLING_PLAN",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "ENABLED",
  • "type": "CROSS_SELL",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "weight": 0,
  • "byParentProductIds": {
    },
  • "byProductIds": {
    }
}

Response samples

Content type
application/json
Example
{
  • "catalogId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "discountPlan": {
    },
  • "eligibleParentProductIds": [
    ],
  • "eligibleProductIds": [
    ],
  • "eligibleStoreIds": [
    ],
  • "endDate": "2019-08-24T14:15:22Z",
  • "fallbackLocale": "string",
  • "function": "predefinedIdsRecoRule, idToIdsRecoRule",
  • "id": "string",
  • "lastUpdateReason": "string",
  • "levels": "CART, PRODUCT, PURCHASE, INTERSTITIAL",
  • "localizedDesc": {
    },
  • "marketingOperationId": "string",
  • "modelVersion": "string",
  • "name": "string",
  • "sources": "PURCHASE, SUBSCRIPTION, MANUAL_RENEWAL, BILLING_PLAN",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "ENABLED",
  • "type": "CROSS_SELL",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "weight": 0,
  • "byParentProductIds": {
    },
  • "byProductIds": {
    }
}

Get distinct values for a given field

Authorizations:
Bearer
query Parameters
target
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Import a recommendation

Authorizations:
Bearer
query Parameters
reason
string
Default: "resource import thru REST Api"
Request Body schema: application/json
required
One of
catalogId
string
createDate
string <date-time>
Deprecated
customerId
string
dbVersion
integer <int64>
object (DiscountPlan)

Discount plan

eligibleParentProductIds
Array of strings unique

Parent product ids on which recommendation can be applied

eligibleProductIds
Array of strings unique

Variant product ids on which recommendation can be applied

eligibleStoreIds
required
Array of strings unique

Store ids on which recommendation can be applied

endDate
required
string <date-time>

Rule end date timestamp in milliseconds

fallbackLocale
string

Fallback locale

function
required
string
Value: "predefinedIdsRecoRule, idToIdsRecoRule"

Recommendations selection mode

id
string
Deprecated
lastUpdateReason
string
levels
required
Array of strings unique
Items Enum: "CART" "PRODUCT" "PURCHASE" "INTERSTITIAL" "CART, PRODUCT, PURCHASE, INTERSTITIAL"

Level on which recommendation will be displayed

object

Localized descriptions

marketingOperationId
string

Prices and bundle from this marketing operation will be applied

modelVersion
string
Deprecated
name
required
string

Rule name

originalId
string
sources
Array of strings unique
Items Enum: "PURCHASE" "SUBSCRIPTION" "MANUAL_RENEWAL" "BILLING_PLAN" "UPGRADE" "PURCHASE, SUBSCRIPTION, MANUAL_RENEWAL, BILLING_PLAN"

Restriction of recommendation to specific sources

startDate
required
string <date-time>

Rule start date timestamp in milliseconds

status
required
string
Enum: "ENABLED" "DISABLED"

Rule status

type
required
string
Enum: "CROSS_SELL" "UP_SELL" "UPGRADE" "DEFAULT" "CROSS_SELL, UP_SELL, UPGRADE"

Recommendation type

updateDate
string <date-time>
Deprecated
weight
integer <int32>

Set rule priority when several rules apply. Bigger weight = bigger priority

object
object

Responses

Request samples

Content type
application/json
Example
{
  • "catalogId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "discountPlan": {
    },
  • "eligibleParentProductIds": [
    ],
  • "eligibleProductIds": [
    ],
  • "eligibleStoreIds": [
    ],
  • "endDate": "2019-08-24T14:15:22Z",
  • "fallbackLocale": "string",
  • "function": "predefinedIdsRecoRule, idToIdsRecoRule",
  • "id": "string",
  • "lastUpdateReason": "string",
  • "levels": "CART, PRODUCT, PURCHASE, INTERSTITIAL",
  • "localizedDesc": {
    },
  • "marketingOperationId": "string",
  • "modelVersion": "string",
  • "name": "string",
  • "originalId": "string",
  • "sources": "PURCHASE, SUBSCRIPTION, MANUAL_RENEWAL, BILLING_PLAN",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "ENABLED",
  • "type": "CROSS_SELL",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "weight": 0,
  • "byParentProductIds": {
    },
  • "byProductIds": {
    }
}

Response samples

Content type
application/json
Example
{
  • "catalogId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "discountPlan": {
    },
  • "eligibleParentProductIds": [
    ],
  • "eligibleProductIds": [
    ],
  • "eligibleStoreIds": [
    ],
  • "endDate": "2019-08-24T14:15:22Z",
  • "fallbackLocale": "string",
  • "function": "IdToIdsRecoRule",
  • "id": "string",
  • "lastUpdateReason": "string",
  • "levels": "CART, PRODUCT, PURCHASE, INTERSTITIAL",
  • "localizedDesc": {
    },
  • "marketingOperationId": "string",
  • "modelVersion": "string",
  • "name": "string",
  • "sources": "PURCHASE, SUBSCRIPTION, MANUAL_RENEWAL, BILLING_PLAN",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "ENABLED",
  • "type": "CROSS_SELL",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "weight": 0,
  • "byParentProductIds": {
    },
  • "byProductIds": {
    }
}

Get recap quantities for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Get recommendations for a cart

Get product recommendations for all products in a given cart.

Authorizations:
Bearer
query Parameters
cartId
required
string

Responses

Response samples

Content type
application/json
{
  • "recommendations": {
    },
  • "reports": {
    }
}

Get recommendations for a line item

Get product recommendations for a line item.

Authorizations:
Bearer
query Parameters
previousLineItemId
required
string
enduserId
required
string

Responses

Response samples

Content type
application/json
{
  • "recommendations": {
    },
  • "reports": {
    }
}

Search unwind for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Delete item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "catalogId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "discountPlan": {
    },
  • "eligibleParentProductIds": [
    ],
  • "eligibleProductIds": [
    ],
  • "eligibleStoreIds": [
    ],
  • "endDate": "2019-08-24T14:15:22Z",
  • "fallbackLocale": "string",
  • "function": "predefinedIdsRecoRule, idToIdsRecoRule",
  • "id": "string",
  • "lastUpdateReason": "string",
  • "levels": "CART, PRODUCT, PURCHASE, INTERSTITIAL",
  • "localizedDesc": {
    },
  • "marketingOperationId": "string",
  • "modelVersion": "string",
  • "name": "string",
  • "sources": "PURCHASE, SUBSCRIPTION, MANUAL_RENEWAL, BILLING_PLAN",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "ENABLED",
  • "type": "CROSS_SELL",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "weight": 0,
  • "byParentProductIds": {
    },
  • "byProductIds": {
    }
}

Update item

Authorizations:
Bearer
path Parameters
id
required
string
Request Body schema: application/json
required
One of
catalogId
string
createDate
string <date-time>
Deprecated
customerId
string
dbVersion
integer <int64>
object (DiscountPlan)

Discount plan

eligibleParentProductIds
Array of strings unique

Parent product ids on which recommendation can be applied

eligibleProductIds
Array of strings unique

Variant product ids on which recommendation can be applied

eligibleStoreIds
required
Array of strings unique

Store ids on which recommendation can be applied

endDate
required
string <date-time>

Rule end date timestamp in milliseconds

fallbackLocale
string

Fallback locale

function
required
string
Value: "predefinedIdsRecoRule, idToIdsRecoRule"

Recommendations selection mode

id
string
Deprecated
lastUpdateReason
string
levels
required
Array of strings unique
Items Enum: "CART" "PRODUCT" "PURCHASE" "INTERSTITIAL" "CART, PRODUCT, PURCHASE, INTERSTITIAL"

Level on which recommendation will be displayed

object

Localized descriptions

marketingOperationId
string

Prices and bundle from this marketing operation will be applied

modelVersion
string
Deprecated
name
required
string

Rule name

originalId
string
sources
Array of strings unique
Items Enum: "PURCHASE" "SUBSCRIPTION" "MANUAL_RENEWAL" "BILLING_PLAN" "UPGRADE" "PURCHASE, SUBSCRIPTION, MANUAL_RENEWAL, BILLING_PLAN"

Restriction of recommendation to specific sources

startDate
required
string <date-time>

Rule start date timestamp in milliseconds

status
required
string
Enum: "ENABLED" "DISABLED"

Rule status

type
required
string
Enum: "CROSS_SELL" "UP_SELL" "UPGRADE" "DEFAULT" "CROSS_SELL, UP_SELL, UPGRADE"

Recommendation type

updateDate
string <date-time>
Deprecated
weight
integer <int32>

Set rule priority when several rules apply. Bigger weight = bigger priority

object
object

Responses

Request samples

Content type
application/json
Example
{
  • "catalogId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "discountPlan": {
    },
  • "eligibleParentProductIds": [
    ],
  • "eligibleProductIds": [
    ],
  • "eligibleStoreIds": [
    ],
  • "endDate": "2019-08-24T14:15:22Z",
  • "fallbackLocale": "string",
  • "function": "predefinedIdsRecoRule, idToIdsRecoRule",
  • "id": "string",
  • "lastUpdateReason": "string",
  • "levels": "CART, PRODUCT, PURCHASE, INTERSTITIAL",
  • "localizedDesc": {
    },
  • "marketingOperationId": "string",
  • "modelVersion": "string",
  • "name": "string",
  • "originalId": "string",
  • "sources": "PURCHASE, SUBSCRIPTION, MANUAL_RENEWAL, BILLING_PLAN",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "ENABLED",
  • "type": "CROSS_SELL",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "weight": 0,
  • "byParentProductIds": {
    },
  • "byProductIds": {
    }
}

Response samples

Content type
application/json
Example
{
  • "catalogId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "discountPlan": {
    },
  • "eligibleParentProductIds": [
    ],
  • "eligibleProductIds": [
    ],
  • "eligibleStoreIds": [
    ],
  • "endDate": "2019-08-24T14:15:22Z",
  • "fallbackLocale": "string",
  • "function": "predefinedIdsRecoRule, idToIdsRecoRule",
  • "id": "string",
  • "lastUpdateReason": "string",
  • "levels": "CART, PRODUCT, PURCHASE, INTERSTITIAL",
  • "localizedDesc": {
    },
  • "marketingOperationId": "string",
  • "modelVersion": "string",
  • "name": "string",
  • "sources": "PURCHASE, SUBSCRIPTION, MANUAL_RENEWAL, BILLING_PLAN",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "ENABLED",
  • "type": "CROSS_SELL",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "weight": 0,
  • "byParentProductIds": {
    },
  • "byProductIds": {
    }
}

Public

Get recommendations for a cart

Get product recommendations for all products in a given cart.

Authorizations:
Bearer
query Parameters
cartId
required
string

Responses

Response samples

Content type
application/json
{
  • "recommendations": {
    },
  • "reports": {
    }
}