Fetches related recommendations or outfits (items which as a set complement the source item(s)) based on business rules agreed with Mapp Fashion. Depending on the items passed and these rules, the result might be related to some, all or none of the items specified
For example this could be used on the checkout page to show recommendations based on the content of the user's basket.
This is the api equivalent of the shopping basket widget
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 one or more source item. The interpretation of this item is controlled by the identifier_type parameter
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 the product feed 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 the feed
- sku is style without color or size (can be supplemented with an extra parameter specifying the color + size variant)
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
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 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 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.
List of product identifiers to be excluded from the results
Information about the recommended garments
Fetches related recommendations or outfits (items which as a set complement the source item(s)) based on business rules agreed with Mapp Fashion. Depending on the items passed and these rules, the result might be related to some, all or none of the items specified
For example this could be used on the checkout page to show recommendations based on the content of the user's basket.
This is the api equivalent of the shopping basket widget
An event id. This should be used when posting events relating to this dataset.
The method used to generate responses. Exact values will depend on business rules agreed with Mapp Fashion
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
The outfits to be displayed (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, for example on /items/{id}/complementary, where outfits are not built per occasion
The items making up the outfit
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
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 recommended items
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
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
unrecognized product codes
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