Skip to main content
GET
Get shoe recommendation results

Authorizations

Authorization
string
header
required

Recommended. Pass your API key as a Bearer token in the Authorization header: Authorization: Bearer YOUR_API_KEY.

Path Parameters

shoe_recommendation_id
string
required

Identifier returned by POST /shoeRecommendation/form.

Response

Results ready (status was success).

Successful result payload. recommendations maps each shoe parameter to a recommendation.

recommendations
object
required

Maps each shoe parameter to an object with a recommendation value. Typical keys include heel_to_toe_drop, motion_control_shoe, midsole_thickness, midsole_hardness, carbon_plate, shoe_weight, rocker, bending_stiffness. motion_control_shoe may be null when only side-view data was used.

best_matching_shoe
object | null
required

Top match summary; fields may include brand, model, and catalog metadata. Always includes gtins and mpns at the root (string arrays, possibly empty) for catalog integration.

all_matches
object[]
required

Ranked list of catalog matches (length and shape depend on processing mode). Each item includes top-level gtins and mpns (string arrays, possibly empty) and may include detailed_scores with per-criterion recommended_value and shoe_value.

user_id
string
required

Technical user identifier associated with the recommendation.