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

Import a recommendation

Authorizations:
Bearer
query Parameters
reason
string
Default: "resource import thru REST Api"
Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
No sample

Response samples

Content type
application/json
No sample

Get items

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

Responses

Response samples

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

Create an item

Authorizations:
Bearer
Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
No sample

Response samples

Content type
application/json
No sample

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
No sample

Update item

Authorizations:
Bearer
path Parameters
id
required
string
Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
No sample

Response samples

Content type
application/json
No sample

Delete item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

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,
  • "totalItems": 0,
  • "totalPages": 0,
  • "size": 0,
  • "number": 0
}

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,
  • "totalItems": 0,
  • "totalPages": 0,
  • "size": 0,
  • "number": 0
}

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,
  • "totalItems": 0,
  • "totalPages": 0,
  • "size": 0,
  • "number": 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": {
    }
}