NederlandsYou'll find all the information you need to implement this feature at https://developers.tweakwise.com/api under Guided Selling. There are two types of calls for Guided Selling:
- Advisor: This call retrieves the Compare from Navigator. With the Compare, questions are set up that the customer needs to answer. If the customer has gone through all the questions, then the products that have the best match are shown first. The answers don't need to match 100%, so there will always be some results.
- Filter wizard: This call retrieves the Funnel from Navigator. The funnel is set up based on a filter template. What the Funnel does, is practically filter your product range, only your customer is lead through the process. The products need to match a property. The result page returns not only the products but the used filters as well.
Advisor
The following parameters can be sent with the request:
|
instancekey* |
This instance key is a unique identification for a Tweakwise Navigator instance. You can find this key in Navigator at https://navigator.tweakwise.com/endpoint |
|
code* |
This code is a unique code to determine which Guided Selling rule should be retrieved. You can find this code in Navigator at: https://navigator.tweakwise.com/nl/guidedselling. In the case of the Advisor, this should be a Compare. |
|
tn_qs |
Using qs, the answered questions can be sent with the request. Multiple answers should be separated by commas before they're sent, URL encoded. Example: qs1=1%2C2&qs2=3 |
|
tn_skip_qs |
Some questions can be skipped by using skip_qs. Example: skip_qs=2%2C4%2C6 OR ?skip_qs=2&skip_qs=4&skip_qs=6 |
|
ps |
The number of products that are returned on the page. The default number is 12 and there's a maximum of 100 returned products. |
The response
<advisor xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<advisorid>compare id</advisorid>
<title>compare name</title>
<code>compare code</code>
<questions>
<question>
<questionid>question id</questionid>
<question>question</question>
<attributeid>attribute id</attributeid>
<explanation>explanation or summary for this question</explanation>
<ismultiselect>true/false to indicate if multiselect is possible</ismultiselect>
<imageurl>url to question image</imageurl>
<current>true/false to indicate if this is the question that should be answered next<current>
<skippable>true/false to indicate if this question can be skipped</skippable>
<skiplabel>label for button to skip this question</skiplabel>
<answers>
<answer>
<answerid>answer id</answerid>
<answer>answer</answer>
<caption>answer subtext</caption>
<summary>explanation or summary for this answer</summary>
<imageurl>url to image</imageurl>
<isselected>true/false to indicate if this answer is selected</isselected>
<nextquestionid>id of the next question when this answer is chosen</nextquestionid>
</answer>
</answers>
</question>
</questions>
<items>
<item>
<itemno>product no.</itemno>
<title>product title</title>
<price>price</price>
<properties>
<property>
<propertyid>property id</propertyid>
<title>property title</title>
<attributes>
<attribute>attribute value</attrubute>
</attributes>
<ismatch>true/false</ismatch>
<isfiltered>true/false</isfiltered>
</property>
</properties>
</item>
</items>
</compare>
Filter wizard
The following parameters can be sent in the request:
|
instancekey* |
This instance key is a unique identification for a Tweakwise Navigator instance. You can find this key in Navigator at https://navigator.tweakwise.com/endpoint |
|
code* |
This code is a unique code to determine which Guided Selling rule should be retrieved. You can find this code in Navigator at: https://navigator.tweakwise.com/nl/guidedselling. In the case of the Filter wizard, this should be a Funnel. |
|
catid |
If the Guided Selling should only show products from a specific store view, you can add the category ID here. Example: catid=100 |
|
qs |
Using qs, the answered questions can be sent with the request. Multiple answers should be separated by commas before they're sent, URL encoded. Example: qs1=1%2C2&qs2=3 Voorbeeld: qs1=1%2C2&qs2=3 |
|
skip_qs |
Some questions can be skipped by using skip_qs. Voorbeeld: skip_qs=2%2C4%2C6 OR ?skip_qs=2&skip_qs=4&skip_qs=6 |
The response
<filterwizard xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<code>funnel code</code>
<name>funnel name</name>
<count>number of products found with selected answers</count>
<navigationurl>
url for navigation request with selected answers
</navigationurl>
<filtertemplateid>id of used filter template</filtertemplateid>
<questions>
<question>
<questionid>question id</questionid>
<question>question</question>
<explanation>explanation or summary for this question</explanation>
<ismultiselect>true/false to indicate if multiselect is possible</ismultiselect>
<imageurl>url to question image</imageurl>
<current>true/false to indicate if this is the question that should be answered next<current>
<skippable>true/false to indicate if this question can be skipped</skippable>
<skiplabel>label for button to skip this question</skiplabel>
<answers>
<answer>
<answerid>answer id</answerid>
<answer>answer</answer>
<caption>answer subtext</caption>
<summary>explanation or summary for this answer</summary>
<imageurl>url to image</imageurl>
<count>number of products left when this answer is selected</count>
<isselected>true/false to indicate if this answer is selected</isselected>
<nextquestionid>id of the next question when this answer is chosen</nextquestionid>
</answer>
</answers>
</question>
</questions>
<items>
<item>
<itemno>product no.</itemno>
<title>product title</title>
<brand>brand</brand>
<price>price</price>
<url>product url</url>
<image>product image url</url>
<labels>
<label>
<name>label name</name>
<value>label value</value>
</label>
</labels>
<attributes>
<attribute>
<name>attribute name</name>
<values>
<value>attribute value</value>
</values>
</attribute>
</attributes>
</item>
</items>
</filterwizard>