Text file field name

XML field name (case sensitive)


Default value





tags define the sales/product attributes for uploaded sales data allowing you to create subsets of the full data which can then be used to determine which campaign is used for feedback requests or to generate reports filtered by the tags. The full list of available tags is shown in Sales And Product Tags

The best way to understand tags is to look at an example. You may have three separate sales channels: store, phone and web. By giving each sale in the uploaded sales data one or more tags, each in the form of ‘key:value’ or 'key=value', reports filtered by the tags can be generated that only show one or more of these sales channels. Following through with this example, the ‘key’ would be saleschannel and the ‘value’ will depend on which sales channel the customer purchased their items. In the following examples, colon (:) has been chosen as the separator but if preferred, equals (=) can be used instead. Note that Reviews API only supports colons as the separator for tags.

  • For store sales:    saleschannel:Store
  • For phone sales:    saleschannel:Phone
  • For web sales:    saleschannel:Web

The data could then be tagged further with details of the actual store where the purchase took place (for store sales) and the sales person (for store and phone sales) who made the sale leading to examples for store sales such as:

  • store:London 
  • store:Oxford 
  • store:Southampton 
  • store:Edinburgh 
  • salesperson:Karen Jones 
  • salesperson:Mary O’Brien

And for phone sales: 

  • salesperson:John Smith 
  • salesperson:Jane Williams

Any number of the available sales/product tags can be added to each sale, each being separated by a comma (,) so taking the above examples, a sale could have the following set of tags:

  • For a store sale: saleschannel:Store,store:Oxford,salesperson:Karen Jones 
  • For a phone sale: saleschannel:Phone,salesperson:Jane Williams

When using multiple tags where the value contains a comma, square brackets [  ] are used as a further delimiter to ensure the correct values are assigned. For example:

  • [department:CDs, Vinyl & Tapes]
  • [department:Cookware, Tableware & Glasses]
Having added tags to the relevant sales lines, the tag can then be used to filter the data for reporting. See Reporting Overview for more details. Where multiple tags have been added to a single sale, filtering can be set up using each tag individually or they can be combined to create complex filtering operations to identify the sales concerned.   Sales File Field: product linkSales And Product Tags