Returns curated recommendations for a user profile without targeting a specific garment.
This endpoint provides personalized item recommendations based on the user's profile and preferences. Currently only available for the womens department
v2 equivalent: /api/v2/items/top. New integrations should use it.
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
Deprecated. This parameter still returns data, but the logic behind it is no longer maintained and it has no v2 equivalent. Do not rely on it for new integrations.
A list of garment attributes to fetch. Only supported for garment_format=document or detailed. Retailer specific custom fields are named x-<field> and may be requested in addition to the values listed here - contact Mapp Fashion for details
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 department to which the items will belong.
unisex is accepted for backwards compatibility but is not currently implemented: such requests fall back to female.
List of product identifiers to be excluded from the results.
The maximum price reduction (in percent) of any returned item. Requires that discount data is shared with the API.
Include information about the user in the response (if known)
Information about the curated recommendations
The top recommendations endpoint returns curated recommendations for a user profile without targeting a specific garment.
This endpoint provides personalized item recommendations based on the user's profile and preferences.
An event id. This should be used when posting events relating to this dataset.
The currency the prices in this response are expressed in, resolved from the requested locale (the default currency if no locale is given). Null if your product data contains no currency
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 posting events relating to an item in this outfit.
The curated items
The item identifier. In v2, it uses the same identifier type as the request (identifier_type), by default the product code. In v1, the type of identifier depends on the request's 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
Metadata for the garments in the response
The variant SKUs of the recommended items that are still in stock, one entry per item. An empty array when none are known.
Only reliable if the variant IDs are maintained in the Product Catalog and the products have their real product images from the first import on. Products imported with placeholder images or dummy URLs can receive SKUs of other products.
The in-stock variant SKUs of one recommended item.
The item the SKUs belong to, as returned in garment_id
The variant SKUs of the item that are still in stock
Whether the user has completed the Mapp Fashion signup quiz
The user's first name, if they have supplied it
Missing client_id, or 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
No recommender is available for this partner
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