Returns curated recommendations for a user profile based on the garments in their basket (which can be empty).
This is the v2 equivalent of /items/basket. It uses the same service objects and retry/fallback logic.
Garment identifiers are always interpreted as product codes: the v1 parameter identifier_type is not supported. No user object is returned.
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. Interpreted as product codes
List of garment identifiers to be excluded from the recommendations. Interpreted as product codes
The maximum number of items to return. Six items are returned when this parameter is not set
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 the partner feed.
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 the product feed & 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 feed 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 the product feed & 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 for the returned items.
Note that this defaults to false, whereas the v1 equivalent defaults to true.
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 neither source nor reparentable is returned. No user object is returned.
An event id. Use it when posting events relating to this dataset
The recommended items for the current basket, in the order they should be displayed
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
An alternative identifier to identify the product, hidden when not provided in feed
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 feed 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 the partner product feed 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 the partner feed
The style level identifier the product code belongs to
The partner identifier
The retailer name
The brand name
The product name
The current price as it appears in the feed. Formatting follows the feed and does not necessarily include a currency
The previous price as it appears in the feed. Empty if the garment is not reduced
Product rating. May be null if the partner feed 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 the product feed
Mapp Fashion hosted image for the garment
Mapp Fashion hosted thumbnail for the garment
The feed image judged to be the best model shot. May be empty
The feed 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 style level identifier from the feed
The EANs present in the product feed
The sizes currently available for the garment, as label and value pairs
A size entry as a label and value pair, for example ["Size", "XL"]
An internal error occurred. Retry the request. If the issue persists, contact Technical Support
Generic error object
A human readable error message