Returns personalized curated recommendations for a user, like /items/top. It does not return items similar to the garments in the basket. The department is taken from the garments in the basket, and these garments are excluded from the recommendations. The basket can be empty.
v2 equivalent: /api/v2/items/basket. 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.
List of garment identifiers representing the user's basket, for example ids=A,B. Identifiers that cannot be resolved are ignored. The basket garments are excluded from the recommendations, and the department is taken from them. If the list is empty or none of the identifiers can be resolved, recommendations are still returned.
List of garment identifiers to be excluded from the recommendations.
The type of garment identifiers provided in ids and excluded_ids.
There is no fallback logic for partial matches: an identifier must match completely, and the first match is used for the response.
In general, product-code is the style + color identifier from your product data, sku is the variant identifier (style, color and size) and gtin is the barcode, for example EAN-13 or UPC.
The desired number of recommended items to return.
The maximum price reduction (in percent) of any returned item. Requires that discount data is shared with the API.
The attribute to sort results by. Currently only 'price' is supported.
The direction to sort results by.
The desired response format. If 'simple', only basic garment identifiers are returned. If 'detailed', more comprehensive garment metadata is included.
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.
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
If true, user information will be included in the response where applicable
Information about the curated recommendations
The basket recommendations endpoint returns curated recommendations for a user profile based on the garments in their basket (which can be empty).
This endpoint provides personalized item recommendations based on the user's profile and preferences.
The unique event ID for tracking purposes
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
The recommended items for the current basket
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
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
The recommendation service reported an error. The response contains its 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