Import a recommendation

Request

POST https://api.nexway.store/product-recommendations/import

Query parameters

Parameter name Value Description Additional
dryRun boolean

dryRun

Request body

The request body takes a complete ProductRecommendation resource, containing the following writable properties:

{
    "catalogId": "string",
    "createDate": "date-time",
    "customerId": "string",
    "dbVersion": "int64",
    "eligibleParentProductIds": [
        "string"
    ],
    "eligibleProductIds": [
        "string"
    ],
    "eligibleStoreIds": [
        "string"
    ],
    "endDate": "string",
    "function": "string",
    "id": "string",
    "level": "string",
    "name": "string",
    "startDate": "string",
    "status": "string",
    "type": "string",
    "updateDate": "date-time",
    "weight": "int32"
}

Properties

Name Type Description Additional
catalogId string Optional
createDate date-time Optional
customerId string Optional
dbVersion int64 Optional
eligibleParentProductIds[] array of string Optional
eligibleProductIds[] array of string Optional
eligibleStoreIds[] array of string Optional
endDate string Optional
function string Optional
id string Optional
level string

Possible values are:

  • CART
  • PRODUCT
 Optional
name string Optional
startDate string Optional
status string

Possible values are:

  • ENABLED
  • DISABLED
 Optional
type string

Possible values are:

  • CROSS_SELL
  • UP_SELL
 Optional
updateDate date-time Optional
weight int32 Optional

Authorisation

This request requires the use of one of following authorisation methods: OAuth2.

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Success

 ProductRecommendation
201 Created

Created

 Created
401 Unauthorized

Unauthorized
403 Forbidden

Forbidden
404 Not Found

Not Found
500 Internal Server Error

Failure

Example

{
    "endDate": "yyyy-MM-dd'T'HH:mm:ss'Z'",
    "startDate": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}

Explore this API

dryRun

dryRun
reco

reco
Request Content-Type
Response Content-Type

Choose an authorisation method:

Access Token Access token to be used for request
Try it out!