True Fit Products API

openapi: 3.2.0
info:
  title: True Fit - Consumer Products 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: Products
  description: The products available at a store.
paths:
  /products:
    get:
      tags:
      - Products
      summary: Retrieve product information for multiple products
      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: 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: s
        in: query
        description: Store Style IDs to request information for.
        required: true
        style: form
        explode: true
        schema:
          minItems: 1
          type: array
          items:
            type: string
      responses:
        '200':
          description: A list of products
          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: array
                items:
                  $ref: '#/components/schemas/Product'
      operationId: getProducts
      x-operation-id-source: derived
  /products/{styleId}:
    get:
      tags:
      - Products
      summary: Retrieve the product information for a single product
      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: 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: styleId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: colorId
        in: query
        description: Sending this parameter will attempt to find an `imageUrl` for the product that corresponds to the `colorId`. It is not guaranteed that the `imageUrl` will actually correspond to the `colorId`.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: The product based on a styleId.
          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/Product'
      operationId: getProductsByStyleId
      x-operation-id-source: derived
components:
  schemas:
    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
    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
    Category:
      type: string
      example: Bottoms
      enum:
      - Bottoms
      - Dresses
      - Shoes
      - Tops
      - Bras
    Gender:
      type: string
      example: Female
      enum:
      - Female
      - Male
      - Unisex
x-explorer-enabled: false