Skip to main content
API docs by Redocly

EyeFitU REST API (v1)

Download OpenAPI specification:Download

EyeFitU REST API responds with a size recommendation for a garment and a given body measurements.

/config

/config endpoint provides information on how to interact with a user while recommending size for a specific product.

Authorizations:
X-EFU-Token
query Parameters
store
required
string (StoreIdentifier)
Example: store=sandbox.eyefitu.com

Store domain identifying the client.

brandName
string
productId
string
productName
string

Product category which could be used to select the right size chart.

productTitle
string

Product title used to select size chart when productName is indecisive.

gender
string (Gender)
Enum: "female" "male"
sizeLabels
string
Example: sizeLabels=["S", "M", "L", "XL"]

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "measurements": [
    ]
}

/size-recommendation

/size-recommendation endpoint should be used to receive size recommendation for given body measurements and product.

Body measurements could be given in basic or detailed sets.

Basic body measurements include height, weigth and age.

Detailed body measurements could be received from /measurements endpoint or provided from third-party system.

Adjusted detailedMeasurements could be used instead of predicted ones. All keys of detailedMeasurements are required. Unadjusted measurements should be left unchaged from /measurements endpoint.

Authorizations:
X-EFU-Token
Request Body schema: application/json
gender
required
string (Gender)
Enum: "female" "male"
height
required
number (Height)

Height in centimeters.

weight
required
number (Weight)

Weight in kilograms.

age
required
integer (Age)
Enum: 16 17 18 26 36 46 56 66 75

Age range of a person. Only 16 and 17 are literal values, by 18 we code a 18-25 range, same for following values. 75 means 75+.

object (DetailedMeasurements)
userId
required
string

Temporary UUID assigned to a user receiving size recommendation.

This UUID should not be related to any PII. If would be used to count Monthly Active Users for metering purposes only.

store
required
string

Store domain used to configure size charts.

object (Preferences)

Preferences which could be used to alter predition model (depends on activated features).

required
object

Product metadata used to select the right size chart.

Required set of metadata properties is dependent on structure of store size charts.

sizeLabels
required
Array of strings non-empty

sizeLabels could contain sizes available in stock, but it could also be a list of all possible sizes for a specific product.

This information is useful when ranges in size chart are labeled in multiple sizing systems. For example, depending on the content of sizeLabels we may suggest either S or 46 for the same garment type and body measurements:

  • for ["S", "M", "L"] we may recommend S,
  • and for ["46", "48", "50"] we may recommend 46.

Responses

Request samples

Content type
application/json
{
  • "gender": "female",
  • "height": 164,
  • "weight": 54,
  • "age": 16,
  • "detailedMeasurements": {
    },
  • "userId": "33a9a818-6321-44fa-a678-444e0384c4c7",
  • "store": "sandbox.eyefitu.com",
  • "preferences": {
    },
  • "productMetadata": {
    },
  • "sizeLabels": [
    ]
}

Response samples

Content type
application/json
{
  • "recommendedSize": "S",
  • "bodyPlace": "TOPS",
  • "extended": [
    ],
  • "visualization": {
    }
}

/measurements

Predict detailed measurements for a given profile.

Authorizations:
X-EFU-Token
Request Body schema: application/json
store
string (StoreIdentifier)

Store domain identifying the client.

object (Preferences)

Preferences which could be used to alter predition model (depends on activated features).

object

Responses

Request samples

Content type
application/json
{
  • "store": "sandbox.eyefitu.com",
  • "preferences": {
    },
  • "predictedMeasures": {
    }
}

Response samples

Content type
application/json
{
  • "predictedMeasures": {
    }
}