True Fit Discovery Recommendation API

openapi: 3.2.0
info:
  title: True Fit - Consumer Discovery Recommendation API
  description: These APIs can be used to create a custom True Fit integration.
  version: '3.0'
servers:
- url: /profile/public/v3/{tla}
tags:
- name: Discovery Recommendation
  description: Retrieve True Fit powered product recommendations for the shopper profile.
paths:
  /style-recommendations:
    get:
      tags:
      - Discovery Recommendation
      summary: Retrieve product recommendations for the shopper profile
      parameters:
      - name: X-TF-UserToken
        in: header
        description: The session token for the current user.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: category
        in: query
        required: true
        style: form
        explode: true
        schema:
          type: string
          enum:
          - Bottoms
          - Dresses
          - Tops
          - Shoes
          - Bras
      - name: locale
        in: query
        description: 'Identifier specifying the locale to use when retrieving suggested brands or any type of sizes e.g. sizes, bra sizes, inseams or sleeve lengths. This attribute is only required when the store supports multiple locales. Use an ISO 639 language code followed by an ISO 3166 country code, e.g. en_US. '
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of products to return on a request. The current maximum limit is 24 products, and the default limit is 6.
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: s
        in: query
        description: Store Style IDs to exclude from Discovery Recommendations.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: currentStyle
        in: query
        description: Store style ID of the product the user is currently viewing, if applicable.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Discovery Recommendations were successfully returned.
          headers:
            X-TF-UserToken:
              description: The updated token for the user. This updated token should be used on all following requests. This header is only present when the token has cycled.
              style: simple
              explode: false
              schema:
                type: string
            X-TF-UserTokenMaxAge:
              description: This will be most useful when storing the token as a cookie. The value is the suggested max age of the token (in seconds).
              style: simple
              explode: false
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiscoveryRecommendationsResultSet'
        '202':
          description: Discovery Recommendations could not be generated at this time. Try again after `refreshAfter` ms.
          headers:
            X-TF-UserToken:
              description: The updated token for the user. This updated token should be used on all following requests. This header is only present when the token has cycled.
              style: simple
              explode: false
              schema:
                type: string
            X-TF-UserTokenMaxAge:
              description: This will be most useful when storing the token as a cookie. The value is the suggested max age of the token (in seconds).
              style: simple
              explode: false
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiscoveryRecommendationsUnavailable'
      operationId: getStyleRecommendations
      x-operation-id-source: derived
  /style-recommendations/available:
    get:
      tags:
      - Discovery Recommendation
      summary: Determine if style recommendations are currently available
      parameters:
      - name: X-TF-UserToken
        in: header
        description: The session token for the current user.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: The availablity status returned successfully
          headers:
            X-TF-UserToken:
              description: The updated token for the user. This updated token should be used on all following requests. This header is only present when the token has cycled.
              style: simple
              explode: false
              schema:
                type: string
            X-TF-UserTokenMaxAge:
              description: This will be most useful when storing the token as a cookie. The value is the suggested max age of the token (in seconds).
              style: simple
              explode: false
              schema:
                type: integer
          content:
            application/json:
              schema:
                type: boolean
      operationId: getStyleRecommendationsAvailable
      x-operation-id-source: derived
components:
  schemas:
    DiscoveryRecommendationsUnavailable:
      type: object
      properties:
        refreshAfter:
          type: integer
          description: If we can't provide discovery recommendations at the moment, the amount of time in milliseconds to wait before trying to retrieve a recommendation again.
          example: 500
    Category:
      type: string
      example: Bottoms
      enum:
      - Bottoms
      - Dresses
      - Shoes
      - Tops
      - Bras
    DiscoveryRecommendation:
      required:
      - product
      type: object
      properties:
        product:
          $ref: '#/components/schemas/Product'
        colorId:
          type: string
    Product:
      required:
      - recommendable
      - styleId
      type: object
      properties:
        styleId:
          type: string
        recommendable:
          type: boolean
        brandName:
          type: string
        productUrl:
          type: string
        category:
          $ref: '#/components/schemas/Category'
        gender:
          $ref: '#/components/schemas/Gender'
        ageGroup:
          $ref: '#/components/schemas/AgeGroup'
        classification:
          $ref: '#/components/schemas/Classification'
        imageUrl:
          type: string
        styleName:
          type: string
    DiscoveryRecommendationsResultSet:
      type: object
      properties:
        recommendations:
          type: array
          items:
            $ref: '#/components/schemas/DiscoveryRecommendation'
    Classification:
      type: string
      description: "###### Possible Mens Shoes Classifications\n* AthleticSneakers\n* Casual \n* Dress\n* Sandals\n* Boots\n###### Possible Womens Shoes Classifications\n* AthleticSneakers\n* Flats\n* Sandals\n* Boots\n* Heels\n"
      example: General
      enum:
      - AthleticSneakers
      - Boots
      - Casual
      - CasualShirts
      - Dress
      - DressShirts
      - Flats
      - General
      - Heels
      - Jeans
      - Pants
      - Sandals
    AgeGroup:
      type: string
      example: Adult
      enum:
      - Adult
      - Child
    Gender:
      type: string
      example: Female
      enum:
      - Female
      - Male
      - Unisex
x-explorer-enabled: false