Returns personalized curated recommendations for a user, like /v2/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.
This is the v2 equivalent of /items/basket. It uses the same service objects and retry/fallback logic.
Identifiers in ids and excluded_ids are interpreted according to identifier_type, by default as product codes. fashion-id is not supported here. A user object is only returned if include_user_data=true.
The JWT for the user. Optional: requests without a user token return non-personalized results. The header name is unchanged for backwards compatibility.
Comma separated list of garment identifiers representing the user's basket, for example ids=A,B. Interpreted according to identifier_type. 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.
Bracketed array syntax (ids[]=A&ids[]=B) is not accepted.
Comma separated list of garment identifiers to be excluded from the recommendations, for example excluded_ids=A,B. Interpreted according to identifier_type.
Bracketed array syntax is not accepted.
How Mapp Fashion should interpret ids and excluded_ids. Not all of these may be available, depending on the information in your product data and how it is processed.
In general
- product-code is the style + color identifier from your product data
- sku is the variant identifier (style, color and size)
- gtin is the barcode, for example EAN-13 or UPC
There is no fallback logic for partial matches: an identifier must match completely.
The maximum number of items to return. Six items are returned when this parameter is not set
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 (name, description, price etc.) is included.
simple is equivalent to the v1 value retailer_ids. The v1 value document is not available in v2.
With detailed, garment attributes are returned in garment_data as GarmentDetail objects. The v1 fields parameter has no v2 equivalent: the set of attributes is fixed and depends on the endpoint and your product data.
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 locale 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
If true, a user object is included in the response.
Information about the curated recommendations
The response of /api/v2/items/basket.
Note that this envelope differs from the other v2 items endpoints: the recommendations are a flat array with no section identifier, and no source is returned. A user object is only returned if include_user_data=true.
An event id. Use it 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
The recommended items for the current basket, in the order they should be displayed
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
Attributes of the garments in the response. Empty unless garment_format=detailed
An entry in garment_data, returned when garment_format=detailed.
Note that this object is not the same shape as Garment (used by the v1 recommendations endpoints): it carries the product and media attributes of the garment and identifies it via id and product_code rather than garment_id.
The set of attributes present depends on the endpoint and on what your product data contains, so individual attributes may be absent, empty or null. The v1 fields parameter has no v2 equivalent.
Do not rely on the order of this array. It does not necessarily match the order of the recommendations, which is authoritative for display.
The internal Mapp Fashion id for the garment
The product code from your product data
The product level identifier the product code belongs to (Product ID in the Product Catalog)
The partner identifier
The retailer name
The brand name
The product name
The current price as it appears in your product data. Formatting follows your product data and does not necessarily include a currency
The previous price as it appears in your product data. Empty if the garment is not reduced
Product rating. May be null if your product data does not provide one
The URL of the product detail page
The category id for the product
The category name for the product
The garment department
All image URLs present in your product data
Mapp Fashion hosted image for the garment
Mapp Fashion hosted thumbnail for the garment
The product image judged to be the best model shot. May be empty
The product image judged to be the best product shot. May be null
Human readable reasons for the recommendation. Only populated if the profile has shape data
Whether outfits can be generated for the garment
The stock status of the garment
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
An internal error occurred. Retry the request. If the issue persists, contact Technical Support
Generic error object
A human readable error message
The request was queued for too long because of high load. Retry the request later
Generic error object
A human readable error message