The themed recommendations api allows retrieval of the most recommended garments for a user matching a theme. Themes should be agreed in advance with Mapp Fashion.
This is the api equivalent of the plp widget.
The JWT for the user. Optional: requests without a user token return non-personalized results. The header name is unchanged for backwards compatibility.
The desired response format.
The response includes a description of the outfits / similar items but no data on the items themselves: since these may be repeated within the response, garment data is provided separately in the response.
The detailed format includes the most amount of item metadata (name, description, price etc).
The document format only includes item identifiers, and if requested Mapp Fashion generated information about the item, such as predicted size.
The retailer_ids format only returns the item identifiers.
If true, pretty print JSON output. This increases response size and should usually be off in production environments
Controls whether Mapp Fashion garment ids (raw_garment_id) are included in response
A device type identifier. This allows segmenting a/b test statistics in the same way as you do.
A locale parameter describing what stock information to use and what language to return text in (if applicable). This parameter will only function if the corresponding information is in your product data & processed accordingly. If stock local and UI language are not the same, specify the language parameter in addition to this one.
Allows you to specify a locale used for product attributes such as product name that should be localized using a different locale to price & stock information. This parameter will only function if the corresponding information is in your product data & processed accordingly.
The theme identifier, as agreed with Mapp Fashion.
The number of recommendations to return
Information about the related garments
The themed recommendations api allows retrieval of the most recommended garments for a user matching a theme. Themes should be agreed in advance with Mapp Fashion.
This is the api equivalent of the plp widget.
An event id. This should be used when posting events relating to this dataset.
If true, the eventid should be posted to /events//reparent
An opaque identifier identifying this section of the response. This should be used when posting events relating to an item in this outfit.
The recommended items
Fetches information about a garment. The garment format is implicitly set to detailed.
The garment_id. The type of identifier used depends on the requests' garment_format
The internal Mapp Fashion id for the garment. This may be omitted depending on garment_format
The product level identifier the item belongs to (Product ID in the Product Catalog), grouping all its colors and sizes. Omitted if your product data contains no Product ID
An alternative identifier to identify the product, hidden when not provided in your product data
Whether garment has extended verdicts. Only presents for verdicts/dislikes, also not present if format=retailer_ids
Whether outfits can be generated. not present if format=retailer_ids
Information about the recommended size
Information about size immediately bigger than the recommended one (if available)
Information about size immediately smaller than the recommended one (if available)
If whys have been requested & if the profile has shape data, a list of human readable reasons for recommendation
If verdicts have been requested, the approval status of the garment (true=like, false=dislike, nil=no verdict given)
If owned has been requested, whether the use has previously purchased the product
A numerical score for the garment (out of 10)
A human readable interpretation of the score
If features have been requested, a list of whitelisted feature objects
The id for the feature
The human readable name for the feature
The feature category of the feature
The category id for the product.
The garment department (female male girls boys).
If eans have been requested, the array of eans present in your product data.
The category name for the product.
Array of the product occasions. Only present if format=detailed, and only populated when occasions is requested via fields; otherwise the key may be returned as null. The possible values are casual, evening, occasion, holiday, work and creative_work
The retailer name for the product. Only present if format=detailed
The array of image_urls present in your product data. Only present if format=detailed
The brand name for the product. Only present if format=detailed
The product name. Only present if format=detailed
The current price, as it appears in your product data. Only present if format=detailed
The previous price, as it appears in your product data. Only present if format=detailed
The URL for the PDP for the garment. Only present if format=detailed
The status of the garment. Only present if format=detailed
Product attributes, as agreed with Mapp Fashion
The name of the attribute
The value of the attribute (if string valued)
The value of the attribute (if array valued)
If true, theme was not recognized
One or more parameter values are invalid
Generic error object
A human readable error message
Invalid JWT: a user token was supplied but could not be verified. Requests without a user token are not affected - they return non-personalized results
Generic error object
A human readable error message
error message
Generic error object
A human readable error message
An internal error occurred. Retry the request. If the issue persists, contact Technical Support
Generic error object
A human readable error message