return top curated recommendations for a user

Prev Next
Get
/items/top

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

Security
api_key & user_token
API Key: api_key
Header parameter namex-api-key

API Key: user_token
Header parameter namex-dressipi-jwt

The JWT for the user

Query parameters
garment_format
string

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 dressipi generated information about the item, such as predicted size.

The retailer_ids format only returns the item identifiers.

Valid values[ "detailed", "document", "retailer_ids" ]
Default"retailer_ids"
pretty
boolean

If true, pretty print json output. This increases response size and should usually be off in production environments

include_dressipi_ids
boolean

Controls whether dressipi garment ids (raw_garment_id) are included in response

Defaulttrue
fields
array of string

A list of garment attributes to fetch. Only supported for garment_format=document or detailed. Custom fields may be available - contact dressipi for details

Valid Item values[ "size", "recommendedness", "garment_category_id", "owned", "department" ]
locale
string

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.

language
string

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.

department
string

The department to which the items will belong

Valid values[ "female", "male", "girls", "boys", "unisex" ]
Default"female"
max_reduced_by
integer (int32)

The maximum price reduction (in percent) of any returned items

excluded_ids
array of string

List of product identifiers to be excluded from the results.

include_user_data
boolean

Include information about the user in the response (if known)

Responses
200

Information about the curated recommendations

Expand All
object

The top recommendations endpoint 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.

Example{ "event_id": "5b76c289c81285611e000071", "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 } }
event_id
string

An event id. This should be used when posting events relating to this dataset.

Example5a621005c2c9adc12e1192b7
reparentable
boolean

If true, the eventid should be posted to /events//reparent

top_items
object (TopItems)
content_id
string

An opaque identifier identifying this section of the response. This should be used when posting posting events relating to an item in this outfit.

Example5a621005c2c9adc12e1192b7
items
Array of object (BareGarment)

The curated items

object
garment_id
string

The garment_id. The type of identifier used depends on the requests garment_format

ExampleABC-123
raw_garment_id
integer (int32)

The internal dressipi id for the garment. This may be omitted depending on garment_format

Example123456
ancillary_product_code
string

An alternative identifier to identify the product, hidden when not provided in feed

ExampleA1B2C3
garment_data
Array of string

Metadata for the garments in the response

string
user
object (User)
style_quiz_complete
boolean

Whether the user has completed the dressipi signup quiz

first_name
string

The user's first name, if they have supplied it

400

missing client_id

Expand All
object

Generic error object

error
object
message
string

A human readable error message

404

missing picker

Expand All
object

Generic error object

error
object
message
string

A human readable error message