> ## Documentation Index > Fetch the complete documentation index at: https://docs.mapp.com/llms.txt > Use this file to discover all available pages before exploring further. # return top curated recommendations for a user > 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. ## OpenAPI ````json GET /items/top { "openapi": "3.0.4", "info": { "title": "Mapp Fashion API", "description": "Mapp Fashion recommendation API.\n\n**Host:** there is no shared API host. A dedicated host is configured per partner and supplied during onboarding. All paths below are relative to that host.\n\nTwo versions are available in parallel. **v1** (`/api/...`) covers the established endpoints and is fully maintained, with no deprecation planned. **v2** (`/api/v2/...`) standardizes the inputs and provides one endpoint per recommendation type. New integrations should use v2 wherever a v2 endpoint exists. See Recommendation Strategy for which endpoint to use when.\n", "version": "13" }, "servers": [ { "url": "/api" } ], "security": [ { "api_key": [] }, { "api_key": [], "user_token": [] } ], "tags": [ { "name": "Items", "description": "Operations for retrieving recommendations or items related to one or more seed items" }, { "name": "Items (v2)", "description": "v2: one endpoint per recommendation type, identifiers passed as parameters" }, { "name": "Recommendations", "description": "Operations about recommendations" }, { "name": "Recommendations (v2)", "description": "v2: facetted recommendations in the v2 response format" }, { "name": "Authorization", "description": "Operations for obtaining or refreshing JWTs" } ], "paths": { "/items/top": { "get": { "tags": [ "Items" ], "summary": "return top curated recommendations for a user", "description": "Returns curated recommendations for a user profile\nwithout targeting a specific garment.\n\nThis endpoint provides personalized item recommendations based on the user's profile\nand preferences.\nCurrently only available for the womens department\n\n\n**v2 equivalent:** `/api/v2/items/top`. New integrations should use it.\n", "operationId": "getItemsTop", "parameters": [ { "name": "garment_format", "in": "query", "description": "The desired response format.\n\nThe 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.\n\nThe `detailed` format includes the most amount of item metadata (name, description, price etc).\n\nThe `document` format only includes item identifiers, and if requested Mapp Fashion generated information about the item, such as predicted size.\n\nThe `retailer_ids` format only returns the item identifiers.\n", "schema": { "enum": [ "detailed", "document", "retailer_ids" ], "type": "string", "default": "retailer_ids" } }, { "name": "pretty", "in": "query", "description": "If true, pretty print JSON output. This increases response size and should usually be off in production environments\n", "schema": { "type": "boolean", "default": false } }, { "name": "include_dressipi_ids", "in": "query", "description": "Controls whether Mapp Fashion garment ids (raw_garment_id) are included in response\n", "schema": { "type": "boolean", "default": true } }, { "name": "fields", "in": "query", "description": "**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.\n\nA list of garment attributes to fetch. Only supported for garment_format=document or detailed. Retailer specific custom fields are named `x-` and may be requested in addition to the values listed here - contact Mapp Fashion for details", "schema": { "type": "array", "items": { "enum": [ "size", "recommendedness", "garment_category_id", "owned", "department" ], "type": "string" } } }, { "name": "locale", "in": "query", "description": "A locale parameter describing what stock information to use and what language to return text in (if applicable). This parameter will only\nfunction if the corresponding information is in your product data & processed accordingly. If stock local and UI language are not the same,\nspecify the language parameter in addition to this one.\n", "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Allows you to specify a locale used for product attributes such as product name that should be localized using a different locale to price &\nstock information. This parameter will only function if the corresponding information is in your product data & processed accordingly.\n", "schema": { "type": "string" } }, { "name": "department", "in": "query", "description": "The department to which the items will belong.\n\n`unisex` is accepted for backwards compatibility but is not currently implemented: such requests fall back to `female`.\n", "schema": { "enum": [ "female", "male", "girls", "boys", "unisex" ], "type": "string", "default": "female" } }, { "name": "excluded_ids", "in": "query", "description": "List of product identifiers to be excluded from the results.\n", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "max_reduced_by", "in": "query", "description": "The maximum price reduction (in percent) of any returned item. Requires that discount data is shared with the API.\n", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "include_user_data", "in": "query", "description": "Include information about the user in the response (if known)\n", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Information about the curated recommendations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopRecommendationsResponse" } } } }, "400": { "description": "Missing client_id, or one or more parameter values are invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "$ref": "#/components/responses/InvalidJwt" }, "404": { "description": "No recommender is available for this partner", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "$ref": "#/components/responses/ServerError" } } } } }, "components": { "schemas": { "TopRecommendationsResponse": { "required": [ "event_id", "top_items", "garment_data" ], "type": "object", "properties": { "event_id": { "type": "string", "description": "An event id. This should be used when posting events relating to this dataset.", "example": "5a621005c2c9adc12e1192b7" }, "currency": { "type": "string", "description": "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", "nullable": true, "example": "GBP" }, "reparentable": { "type": "boolean", "description": "If true, the eventid should be posted to /events/{id}/reparent" }, "top_items": { "$ref": "#/components/schemas/TopItems" }, "garment_data": { "type": "array", "items": { "type": "object" }, "description": "Metadata for the garments in the response" }, "available_skus": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableSkus" }, "description": "The variant SKUs of the recommended items that are still in stock, one entry per item. An empty array when none are known.\n\nOnly 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." }, "user": { "$ref": "#/components/schemas/User" } }, "description": "The top recommendations endpoint returns curated recommendations for a user profile\nwithout targeting a specific garment.\n\nThis endpoint provides personalized item recommendations based on the user's profile\nand preferences.\n", "example": { "event_id": "5b76c289c81285611e000071", "currency": "GBP", "reparentable": false, "top_items": { "content_id": "5b76c289c81285611e000072", "items": [ { "garment_id": "Q10G10NEME", "raw_garment_id": 4532078, "ancillary_product_code": "Q-111" }, { "garment_id": "Q05R85NYLW", "raw_garment_id": 4532040, "ancillary_product_code": "Q-222" } ] }, "garment_data": [], "user": { "first_name": "Jane", "style_quiz_complete": true } } }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string", "description": "A human readable error message" } } } }, "description": "Generic error object" }, "TopItems": { "required": [ "content_id", "items" ], "type": "object", "properties": { "content_id": { "type": "string", "description": "An opaque identifier identifying this section of the response. This should be used when posting posting events relating to an item in this outfit.", "example": "5a621005c2c9adc12e1192b7" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/BareGarment" }, "description": "The curated items" } } }, "AvailableSkus": { "required": [ "garment_id", "skus" ], "type": "object", "properties": { "garment_id": { "type": "string", "description": "The item the SKUs belong to, as returned in `garment_id`" }, "skus": { "type": "array", "items": { "type": "string" }, "description": "The variant SKUs of the item that are still in stock" } }, "description": "The in-stock variant SKUs of one recommended item.", "example": { "garment_id": "TS30165CHARCOALHB", "skus": [ "TS30165CHARCOALHB-S", "TS30165CHARCOALHB-M" ] } }, "User": { "type": "object", "properties": { "style_quiz_complete": { "type": "boolean", "description": "Whether the user has completed the Mapp Fashion signup quiz" }, "first_name": { "type": "string", "description": "The user's first name, if they have supplied it" } } }, "BareGarment": { "required": [ "garment_id" ], "type": "object", "properties": { "garment_id": { "type": "string", "description": "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`", "example": "ABC-123" }, "raw_garment_id": { "type": "integer", "description": "The internal Mapp Fashion id for the garment. This may be omitted depending on `garment_format`", "format": "int32", "example": 123456 }, "product_id": { "type": "string", "description": "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", "example": "TS30165" }, "ancillary_product_code": { "type": "string", "description": "An alternative identifier to identify the product, hidden when not provided in your product data", "example": "A1B2C3" } } } }, "responses": { "InvalidJwt": { "description": "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", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "ServerError": { "description": "An internal error occurred. Retry the request. If the issue persists, contact Technical Support", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "securitySchemes": { "api_key": { "type": "apiKey", "name": "x-api-key", "in": "header" }, "user_token": { "type": "apiKey", "description": "The JWT for the user. Optional: requests without a user token return non-personalized results. The header name is unchanged for backwards compatibility.", "name": "x-dressipi-jwt", "in": "header" } } } } ````