Fetches either similar items (items which are related to the source item by common features) or outfits (items which as a set complement the source item).'
This is the api equivalent of the outfits widget.
v2 equivalent: this endpoint's methods are available as separate v2 endpoints: /api/v2/items/similar, /api/v2/items/outfits and /api/v2/items/partner_outfits. New integrations should use those.
The JWT for the user. Optional: requests without a user token return non-personalized results. The header name is unchanged for backwards compatibility.
An identifier for the source item. The interpretation of this item is controlled by the identifier_type parameter
The methods through which related items should be generated. These are attempted in order.
The partner_outfits method is only available if Mapp Fashion has been provided with curated outfit data for the item
If false (the default), the methods listed are attempted until one succeeds and only results for that method are returned.
If true, results for all successful methods are returned
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.
Whether to exclude the source item from any returned outfits or not
The number of outfits to attempt to return per occasion. In the case of a single occasion garment, this limit is doubled internally. If fewer outfits are available, as many as possible are returned
The maximum number of similar items to return.
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.
List of stores to filter recommendations by. An item must be available in at least one of the specified stores in order to be returned.
This requires that per-store availability data is shared with Mapp Fashion
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.
How Mapp Fashion should interpret the item id. Not all of these may be available, depending on the information in your product data and how it is processed. Contact Mapp Fashion for examples of these types for your specific integration.
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, and the first match is used for the response.
ancillary-product-code is an additional, optional product code. When used, it is checked against the product code column for a complete match.
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
List of product identifiers to be excluded from the results.
The interpretation of this item is controlled by the identifier_type parameter
Include information about the user in the response (if known)
The maximum price reduction (in percent) of any returned item
Information about the related garments
Fetches either similar items (items which are related to the source item by common features) or outfits (items which as a set complement the source item).'
This is the api equivalent of the outfits widget.
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
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
If true, the eventid should be posted to /events//reparent
Extra data about the garments in the response. Only present for detailed and document response formats. Do not rely on this for the correct ordering of results (use the similar_items or outfits key as appropriate)
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
The outfits found containing the source item (if any)
An outfit built around a source garment: the occasion it was built for, the template used and the items it consists of.
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 garment id for which the outfit was constructed
The internal Mapp Fashion id for the main garment. This may be omitted depending on garment_format
A string identifying the template from which the outfit was constructed
The occasion for this outfit. May be null
The items making up the outfit
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
The saved outfit id
Indicate whether the user saved the outfit or not
The partner_outfits found containing the source item (if any). template_id will always be partner_outfit for these outfits
An outfit built around a source garment: the occasion it was built for, the template used and the items it consists of.
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 garment id for which the outfit was constructed
The internal Mapp Fashion id for the main garment. This may be omitted depending on garment_format
A string identifying the template from which the outfit was constructed
The occasion for this outfit. May be null
The items making up the outfit
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
The saved outfit id
Indicate whether the user saved the outfit or not
An opaque identifier identifying this section of the response. This should be used when posting events relating to an item in this outfit.
The similiar 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
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
garment not found
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