Visually Similar
Used to return the list of items that have similar images with a product. This tactic is based on the images compare program.
getVisually Similar Request (by product identifier)
get
/1.0/ClientRecom/{websiteId}/OnlyVisuallySimilar?productRef={refId}
This endpoint will return a list of similar looking products when given a product identifier.
Request
Response
Request
Path Parameters
websiteId
required
string
Your website ID provided to you by PA
Query Parameters
refId
required
string
This is the product identifier/ID
Response
200: OK
This endpoint will return, in the payload, an ordered array of product identifiers for products that are visually similar to the item in the productRef parameter.
{"payload": ["1234", "5678", "9012"],"type": 1,"code": 0}
getVisually Similar Request (by style identifier)
get
/1.0/ClientRecom/{websiteId}/OnlyVisuallySimilar?productStyleId={styleId}
This endpoint will return a list of similar looking products when given a style identifier.
Request
Response
Request
Path Parameters
websiteId
required
string
Your website ID provided by PA
Query Parameters
styleId
required
string
This is the style identifier. The style identifier is an ID that sits below the product ID but is not as granular as a variant level identifier/SKU.
Response
200: OK
This endpoint will return, in the payload, an ordered aray of product identifiers for products that are visually similar to the item in the productStyleId parameter.
{"payload": ["1234", "5678", "9012"],"type": 1,"code": 0}