Constructor.io's largely schema-less result format allows for a large variety of return values, with some light structure to facilitate common use cases.
We'll first review the data Constructor.io returns for all product search queries:
valueThe primary value for the item in question - typically
matched_termsAll terms within the item matching the user's query (regardless of whether misspelled).
In addition to the data always returned, Constructor.io will display any data that's been uploaded for the products in question. We'll go over a typical subset below:
Additional Data (may not be present)
urlThe URL where the item can be viewed or purchased.
idAn ID that identifies the item within the company.
image_urlAn image of the item in question.
groupsThe category(ies) an item belongs to.
facetsThe facet(s) an item is associated with.
variation_idID of the selected (best matching) variation. All metadata of the best matching variation will also be merged into the item's
variationslist of this item's variations.
Groups info in results response
The Search API will return information on the group(s) the item belongs to. Three pieces of information will always be returned:
display_nameThe name of the group as you'd present it to users.
group_idThe id of the group. Any ASCII characters can be used.
pathThe path of
group_IDsabove this group.
This example captures common use-cases; please reach out to Constructor.io support if you'd like assistance in designing your search experience.