This is a list and brief description of the parameters used as part of a Feefo SmartLink.
The API Endpoint for a SmartLink is:
https://api.feefo.com/api/smartlink/lfn
The table below lists all parameters for a SmartLink. More details for each parameter can be found in the Sales File Field Summary.
| Parameter Name | Description | Required/Optional |
| merchantidentifier | The unique identifier for a merchant on Feefo which can be found in 'Settings > Business Details' within the Feefo Hub. See Where to find my merchant identifier? for more details. | Required |
| The customer's email address for sending the feedback request email. | Required | |
| date | The sale date when the purchase was made. We recommend that this parameter is present with a valid value but if not:.
| Required |
| name | The customer's name that will be used in the feedback request. We recommend that this parameter is present with a valid value. When name is present with no value, the customer's name will be assigned the value 'Customer'. | Required |
| orderref | A unique identification for the order made by the customer. We recommend that this parameter is present with a valid value. When orderref is present with no value, it will be assigned a value that is the concatenation of date and email. | Required |
| description | The description of the product purchased by the customer. | Required |
| vendorref | Similar to an SKU, used in identifying a product. We recommend that this parameter is present with a valid value. When vendorref is not present or present without a value, it will be assigned the value of description. vendorref does not support values that include the hash (#) character or the URL ASCII code %23. | Optional |
| tag | Tagging data provides a method of filtering sale data when reporting. Tags are assigned to the sale and any associated feedback. The tag format is a list of comma-separated key-value pairs in the format key=value (where the '=' is replaced with the HTML encoding %3D and any spaces between the words of the value are replaced with the HTML encoding %20) located within square brackets. For example: tag=[saleschannel%3Dweb,productline%3DCar%20Insurance] | Optional |
| customerref | The merchant’s unique identifier for the customer. | Optional |
| currency | The 3 letter ISO code for the sale value amount. For example: GBP. | Optional |
| feedbackdate | The date when a feedback request email should be sent to the customer who made a purchase. When feedbackdate is not present, this will default to 7 days from the sale date (date) or the number of days specified by the Feedback Request Delay parameter in the campaign trigger's Feedback Preferences within the Feefo Hub. | Optional |
| productlink | The link to the product on the merchant’s website. When productlink is present but is an invalid value, it will be rejected with an error message displayed. | Optional |
| amount | The cost of the product purchased. It must not include any currency symbols or labels as this is provided by currency. When amount is present but is an invalid numeric value, it will be rejected with an error message displayed. | Optional |