Missing data with allOf

[jeremy-wizaplace]

Hello,

I have multiple reference with allOf and on my last definition, I have the data on the right part but not on the left part.

Ex :

components:
    schemas:
        schema1:
            // My data1
        schema2:
            allOf:
                - $ref: '#/components/schemas/schema1'
                - // My additional data 1
        schema3:
            allOf:
                - $ref: '#/components/schemas/schema2'
                - // My additional data 2

When I go to schema3, I see My data, My additional data 1, My additional data 2 on the right part but on the left part only My data and My additional data 1.

Where is My additional data 2 ? I don't know

I use redoc v2.0.0-alpha.25, I've tried with rc.0 and I have the same issue.

Do you have any idea ?

Thanks
And happy new year ! 🎉

[jeremy-wizaplace]

If you want more example :

pim.yml see #/components/schemas/CreatePimProduct

tags:
  - name: PIM
    description: >
      PIM means [*Product Information
      Management*](https://en.wikipedia.org/wiki/Product_information_management).

      This module enables you to manage products, categories, etc.


      The PIM is used by vendors and administrators.


      If you are looking for products and categories that are published to the
      front-office you should instead

      use the **Catalog**. The catalog is a read-only and denormalized version
      of the information found in the PIM,

      optimized for displaying on the e-commerce website.


      ## Products and declinations


      Products are created and owned by companies (aka vendors). By default
      products have a price, a stock and

      can be purchased.


      However sometimes a product can have multiple declinations, for example a
      t-shirt might be available in

      multiple sizes or colors.


      Creating declinations is made possible by *enabling* options on a product.


      For example there could be the following options (remember that options
      are global to the marketplace):


      - *Color*

      - *Size*


      Given a product "*Comfortable chair*", you could enable variants on those
      options:


      - variants *Red* and *Green* for the *Color* option

      - variants *Small* and *Large* for the *Size* option


      That gives 4 declinations (combinations of all the options).


      **Note:** declinations are optional. A product without declinations is
      simply a product that will

      automatically have **one** declination.


      ### Multi-vendor products


      Multi-vendor products group products sold by different vendors together.


      This feature is optional, it will be disabled if the marketplace does not
      use multi-vendor products.


      ### Attributes


      Attributes are additionnal metadata on products. Attributes and their
      variants are created

      by the marketplace administrators. Vendors can then select values for each
      attribute

      on their products.


      **Note:** attributes will be sometimes referenced as `features`. These 2
      words represent

      the same thing.

components:
  parameters:
    shippingId:
      name: shippingId
      in: path
      description: Shipping ID.
      required: true
      schema:
        type: integer
    multiVendorProductId:
      name: multiVendorProductId
      in: path
      description: Multi vendor product identifier.
      required: true
      schema:
        type: string
        format: uuid
    moderationActionByProduct:
      name: moderationAction
      in: path
      description: Product moderation action.
      required: true
      schema:
        type: string
        enum:
          - pending
          - approve
          - disapprove
          - standby
    moderationActionByCompany:
      name: moderationAction
      in: path
      description: Product moderation action.
      required: true
      schema:
        type: string
        enum:
          - approve
          - disapprove
          - standby
  schemas:
    PimProductSummary:
      type: object
      properties:
        product_id:
          type: integer
          description: Product ID.
          readOnly: true
        product_code:
          type: string
          description: >
            The product code (aka
            [EAN](https://en.wikipedia.org/wiki/International_Article_Number)).
            It must be unique for each company.
          example: '4006381333933'
        product_template_type:
          type: string
          description: Product's template type
          example: service
        infinite_stock:
          type: bool
          description: true if the product has infinite stock
        supplier_ref:
          type: string
          description: Supplier reference.
          example: abcdef
        product:
          type: string
          description: Product name.
          example: Very comfortable chair.
        status:
          type: string
          enum:
            - A
            - D
            - H
          description: >
            Status of the product:


            - `A`: enabled

            - `D`: disabled

            - `H`: hidden (the multi-vendor product is published in front but is
            not indexed in search results)
        approved:
          type: string
          readOnly: true
          enum:
            - 'Y'
            - 'N'
            - P
          description: |
            A product is created by vendors and is moderated by administrators.

            The moderation status can be:

            - `Y`: approved
            - `N`: refused
            - `P`: pending (the product is pending approval by administrators)
        timestamp:
          type: string
          readOnly: true
          description: Timestamp of the date the product was created.
          example: 1500363711
        updated_timestamp:
          type: string
          readOnly: true
          description: Timestamp of the date the product was last updated.
          example: 1500364328
        company_id:
          type: integer
          readOnly: true
          description: ID of the company selling this product.
          example: 123
        main_category:
          type: integer
          description: ID of the product's category.
          example: 456
        green_tax:
          type: number
          description: Price of the green tax.
          example: 0.45
          default: 0
        condition:
          type: number
          enum:
            - 'N'
            - U
          description: |
            Condition of the product:

            - `N`: new product
            - `U`: used product (second-hand)

            If you need more values you will need to create a custom attribute
            instead of using this field.
          default: 'N'
        geolocation:
          type: object
          description: >-
            Geolocation of the product. This field is optional and can be
            `null`.
          properties:
            latitude:
              type: number
            longitude:
              type: number
            label:
              type: string
              description: 'Label of the location, e.g. can be an address.'
            zipcode:
              type: string
          required:
            - latitude
            - longitude
        free_features:
          $ref: '#/components/schemas/FreeAttributes'
        free_shipping:
          type: string
          enum:
            - 'Y'
            - 'N'
          description: |
            Is the product's shipping free:

            - `Y`: yes
            - `N`: no
          default: 'N'
        weight:
          type: number
          description: Weight of the product.
        is_edp:
          type: string
          enum:
            - 'Y'
            - 'N'
          description: |
            Is the product an electronic document that can be downloaded:

            - `Y`: yes
            - `N`: no
          default: 'N'
        affiliate_link:
          type: string
          description: |
            Link to use for products of type affiliation.
        attachments:
          type: array
          description: List of product attachments
          readOnly: true
          items:
            $ref: '#/components/schemas/ReadProductAttachment'
        divisions:
          type: array
          description: List of product's divisions
          example: [FR, FR-ARA, FR-69, FR-01]
      required:
        - product_code
        - product
        - status
        - main_category
        - green_tax
    PimProduct:
      allOf:
        - $ref: '#/components/schemas/PimProductSummary'
        - type: object
          properties:
            main_pair:
              description: Main image.
              $ref: '#/components/schemas/ImagePair'
            image_pairs:
              type: array
              description: Additional images.
              items:
                $ref: '#/components/schemas/ImagePair'
            full_description:
              type: string
              description: Long description of the product (contains HTML).
              example: <p>This is a long product description.</p>
            short_description:
              type: string
              description: Short description of the product (contains HTML).
              example: <p>This is a short product description.</p>
            tax_ids:
              type: array
              description: List of tax IDs to activate on the product.
              items:
                type: integer
            allowed_options_variants:
              type: array
              description: >
                List of options to enable for this product.


                Enabling options for a product allows to create declinations.
                For

                example, given a product *Comfortable chair*, there could be the

                following options:


                - *Color*

                - *Size*


                Through the `allowed_options_variants` property you can then
                enable:


                - variants *Red* and *Green* for the *Color* option

                - variants *Small* and *Large* for the *Size* option


                That gives 4 declinations (combinations of all the options).


                Can be `null` if the product doesn't have any declination.
              items:
                type: object
                properties:
                  option_id:
                    type: integer
                    description: ID of the option.
                  variants:
                    type: array
                    description: List of variant IDs to enable for the option.
                    items:
                      type: integer
            inventory:
              type: array
              description: >
                The inventory allows to define declinations and their price,
                stock, etc.
              items:
                type: object
                properties:
                  combination:
                    type: object
                    description: |
                      Key-value map (JSON object) where:

                      - keys: option ID
                      - value: variant ID

                      If there are no declinations this value should be `null`.
                    additionalProperties:
                      $ref: '#/components/schemas/AnyValue'
                    example:
                      '123': 456
                      '789': 101
                  amount:
                    type: integer
                    description: |
                      Stock quantity for the declination.
                    example: 5
                  infinite_stock:
                    type: bool
                    description: true if the declination has infinite stock
                  price:
                    type: number
                    description: |
                      Price for the declination.
                    example: 48.4
                  combination_code:
                    type: string
                    description: >
                      Product code (aka
                      [EAN](https://en.wikipedia.org/wiki/International_Article_Number))

                      for this specific declination.


                      If not provided, the product code will be the same as the
                      product.
                    example: '4006381333933'
                required:
                  - amount
                  - price
            video:
              type: string
              description: URL of the video attached to the product
          required:
            - tax_ids
    CreatePimProduct:
      allOf:
        - $ref: '#/components/schemas/PimProduct'
        - type: object
          properties:
            attachments:
              type: array
              description: List of product attachments
              items:
                $ref: '#/components/schemas/CreateProductAttachment'
            company_id:
              type: integer
              description: ID of the company selling this product, when the request is issued by an administrator.
              example: 123
    MultiVendorProduct:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 3f79d867-f325-47a6-9e82-2ba6b9cade14
          readOnly: true
        name:
          type: string
          description: Product name.
          example: Comfortable chair
        code:
          type: string
          description: >
            The product code (aka
            [EAN](https://en.wikipedia.org/wiki/International_Article_Number)).
          example: '4006381333933'
        supplierReference:
          type: string
          description: Supplier reference.
          example: abcdef
        slug:
          type: string
          description: >-
            Unique and URL-safe identifier that can be used to create a URL for
            the product.
          example: comfortable-chair
        shortDescription:
          type: string
          description: Short description which may contain HTML.
          example: <p>Super comfortable chair.</p>
        description:
          type: string
          description: Long description which may contain HTML.
          example: <p>This chair is the best from our line of …</p>
        seoTitle:
          type: string
          description: Value used in the title tag.
          example: Comfortable chair
        seoDescription:
          type: string
          description: Value used in the meta description tag.
          example: Super comfortable chair
        seoKeywords:
          type: string
          description: Value used in the meta keywords tag.
          example: chair, furniture
        status:
          type: string
          enum:
            - A
            - D
            - H
          description: >
            Status of the multi-vendor product:


            - `A`: enabled

            - `D`: disabled

            - `H`: hidden (the multi-vendor product is published in front but is
            not indexed in search results)
        category:
          allOf:
            - $ref: '#/components/schemas/CategorySummary'
            - readOnly: true
        categoryId:
          type: integer
        imageIds:
          type: array
          readOnly: true
          items:
            type: integer
        attributes:
          type: object
          description: >
            JSON object (key-value map) where:


            - keys: attribute ID

            - value: attribute value (e.g. variant ID or free value depending on
            the attribute's type)
          additionalProperties:
            $ref: '#/components/schemas/AnyValue'
          example:
            '1': 4
            '2': 4K
            '4': false
        freeAttributes:
          $ref: '#/components/schemas/FreeAttributes'
    MultiVendorProductLink:
      type: object
      description: Link between a multi-vendor product and a product.
      properties:
        id:
          type: integer
          description: ID of the link.
        multiVendorProductId:
          type: string
          description: ID of the multi-vendor product.
        productId:
          type: integer
          description: ID of the product.
      required:
        - multiVendorProductId
        - productId
    Category:
      type: object
      properties:
        category_id:
          type: integer
          description: Category ID.
        category:
          type: string
          description: Category name.
        status:
          type: string
          enum:
            - A
            - D
            - H
          description: |
            Status:

            - `A`: enabled
            - `D`: disabled
            - `H`: hidden
        parent_id:
          type: integer
          description: ID of the parent category or `null` for root categories.
        is_fillable:
          type: boolean
          description: >
            If `true` products can be added to this category, else products
            cannot be added.


            For example products must be added to leaf categories.
    CategorySummary:
      type: object
      properties:
        id:
          type: integer
          description: Category ID.
        name:
          type: string
          description: Category name.
    Attribute:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
          description: Attribute name.
          example: Brand
        code:
          type: string
          description: Attribute unique code.
          example: brand
        description:
          type: string
          description: Attribute description which may contain HTML.
          example: <p>The brand of the product.</p>
        type:
          $ref: '#/components/schemas/AttributeType'
        categoryIds:
          type: array
          items:
            type: integer
          description: |
            The list of category IDs in which the attribute will be available.
            If `null` the attribute will be available everywhere.
          example:
            - 123
            - 456
        parent:
          $ref: '#/components/schemas/Attribute'
          description: The parent attribute (the group) or `null`.
        isDisplayedOnProduct:
          type: boolean
          description: |
            If `true` the attribute will be returned in the list of attributes
            in the *Catalog*. That means the attribute will be displayed on the
            product page.
        isRequired:
          type: boolean
          description: >
            If `true` the attribute must be filled when creating or updating a
            product.
        isOnlyEditableByAdmin:
          type: boolean
          description: >
            If `true` the attribute can only be changed by an administrator (not
            vendors).
        isASearchFilter:
          type: boolean
          description: >
            If `true` the attribute will be available as a search filter and
            will

            appear in the search facets.
        isIndexedForTextSearch:
          type: boolean
          description: >
            If `true` the attribute's value will be indexed for the product
            search.


            For example if the attribute is a brand, and a product has "Apple"
            as the

            attribute value, then searching for "Apple" will allow to find the
            product.
        isUsedForRecommendations:
          type: boolean
          description: >
            If `true` the attribute will be used by the recommendation engine.
        status:
          type: string
          enum:
            - A
            - D
          description: |
            Status of the attribute:

            - `A`: the attribute is enabled
            - `D`: the attribute is disabled
        position:
          type: integer
          description: Position of the attribute (used to sort attributes).
        variants:
          type: array
          description: >
            List of variants for this attribute. Note that some attributes do
            not have

            variants (e.g. attributes where the value is free text).
          items:
            type: object
            properties:
              id:
                type: integer
                description: Variant ID.
              name:
                type: string
                description: Variant name.
                example: Brand 1
    AttributeType:
      type: string
      enum:
        - G
        - S
        - E
        - 'N'
        - M
        - T
        - O
        - C
      description: >
        Attribute type.


        Special type:


        - `G`: group attribute - a group is an attribute that contains
        sub-attributes


        Attribute with variants:


        - `S`: selection of one variant (variants are text values)

        - `E`: selection of one variant (variants are text values but this is a
        special type for brands)

        - `N`: selection of one variant (variants are numbers)

        - `M`: selection of multiple variants (variants are text values)


        Attribute without variants:


        - `T`: free text value

        - `O`: free numeric value

        - `C`: checkbox with 2 possible values: `Y` (yes) or `N` (no)
    Variant:
      type: object
      properties:
        id:
          type: integer
          description: Variant ID.
        attribute:
          type: object
          description: The attribute for which the variant exist.
          properties:
            id:
              type: integer
              description: Attribute ID.
            name:
              type: string
              description: Attribute name.
              example: Brand
        name:
          type: string
          description: Variant name.
          example: Brand 1
        description:
          type: string
          description: Variant description which may contain HTML.
          example: <p>This brand is awesome.</p>
        pageTitle:
          type: string
          description: Page title.
          example: Brand 1 - The best brand
        metaDescription:
          type: string
        metaKeywords:
          type: string
        position:
          type: integer
          description: Position of the variant (used to sort variants).
    FreeAttributes:
      type: object
      description: |
        Key-value map (JSON object) where:

        - key: free attribute name
        - value: free attribute value

        Free attributes are not used for search.
      additionalProperties:
        $ref: '#/components/schemas/AnyValue'
      example:
        color: blue
        wifi: true
        hdmiPorts: 1
    PimAttributeValue:
      type: object
      properties:
        feature_id:
          type: integer
          description: Attribute ID.
        description:
          type: string
          readOnly: true
          description: Attribute name.
          example: Brand
        feature_type:
          allOf:
            - $ref: '#/components/schemas/AttributeType'
            - readOnly: true
        categories_path:
          type: array
          readOnly: true
          items:
            type: integer
          description: |
            The list of category IDs in which the attribute will be available.
            If `null` the attribute will be available everywhere.
          example:
            - 123
            - 456
        value_str:
          type: string
          description: >
            Value set for the attribute.


            This field is used for attributes that do not have variants (`T`,
            `O` or `C`).
          example: Brand 1
        variants:
          type: array
          description: >
            List of variants selected for this attribute.


            This field is used for attributes that have variants (`S`, `E`, `N`
            or `M`).
          items:
            type: object
            properties:
              variant_id:
                type: integer
                description: Variant ID.
              name:
                type: string
                description: Variant name.
                example: Brand 1
    ImagePair:
      type: object
      description: |
        To upload an image you can either:

        - use the `image_path` field,
        - or use the `image_data`, `image_name` and `image_type` fields.
      properties:
        detailed:
          type: object
          properties:
            image_path:
              type: string
              format: uri
              description: |
                URL where the image is stored.

                If provided, the image will be downloaded and the copy
                will be stored in the system.

                Please note that this must be the direct URL to the
                image (redirects are not supported).
            image_data:
              type: string
              format: byte
              description: |
                Content of the file encoded in `base64`.
            image_name:
              type: string
              description: Image file name (with the extension).
            image_type:
              type: string
              enum:
                - image/jpeg
                - image/png
                - image/gif
              description: Mime type.
    PimShipping:
      type: object
      properties:
        shipping_id:
          type: integer
          readOnly: true
        status:
          type: string
          enum:
            - A
            - D
          description: |
            Status of the shipping:

            - `A`: the shipping is enabled
            - `D`: the shipping is disabled
        shipping:
          type: string
          readOnly: true
          description: Shipping name.
          example: TNT Express
        delivery_time:
          type: string
          readOnly: true
          description: >
            Delay for delivery for this shipping.


            Note that this is a plain text, it is not parsed not can it be used
            to

            calculate delivery dates.
          example: 24h
        rates:
          type: array
          items:
            type: object
            description: |
              The shipping costs:

              - when `amount = 0`, the shipping cost for the first item
              - when `amount = 1`, the shipping cost for every additional item

              There must be exactly 2 items, the first with `amount: 0`, the
              second with `amount: 1`.
            properties:
              amount:
                type: integer
                enum:
                  - 0
                  - 1
              value:
                type: number
                description: Price of the shipping.
          example:
            - amount: 0
              value: 3.99
            - amount: 1
              value: 1.99
        specific_rate:
          type: boolean
        product_id:
          type: integer
          example: 1
        description:
          type: string
          readOnly: true
          description: Shipping description (contains HTML).
          example: <p>TNT shipping without tracking.</p>
    ProductAttachment:
      type: object
      properties:
        label:
          type: string
          description: Attachment name. File name or label.
    CreateProductAttachment:
      type: object
      properties:
        label:
          type: string
          description: Attachment name. File name or label.
        url:
          type: string
          description: URL of the attachment.
  requestBodies:
      MultiVendorProduct:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultiVendorProduct'
        description: The data for the multi vendor product.
        required: true
      Company:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Company'
        description: The company's data
        required: true
      Variant:
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                description:
                  type: string
                pageTitle:
                  type: string
                metaKeywords:
                  type: string
                metaDescription:
                  type: string
                position:
                  type: integer
        description: The data for the variant
        required: true

paths:
  /products:
    get:
      tags:
        - PIM
      summary: Get products
      description: Get the list of all products.
      parameters:
        - name: page
          in: query
          description: Page to return.
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: pcode
          in: query
          description: Filter the products by their product code.
          schema:
            type: string
        - name: q
          in: query
          description: >
            Global search parameter based on pname, pshort, pfull fields

            Example: `q=my_search`
          schema:
            type: string
        - name: pname
          in: query
          description: >
            Specifies the global search q on the product name.

            Example: `q=my_search&pname=Y`
          schema:
            type: string
            enum:
              - 'Y'
        - name: pshort
          in: query
          description: >
            Specifies the global search q on the short description.

            Example: `q=my_search&pshort=Y`
          schema:
            type: string
            enum:
              - 'Y'
        - name: pfull
          in: query
          description: >
            Specifies the global search q on the full description.

            Example: `q=my_search&pfull=Y`
          schema:
            type: string
            enum:
              - 'Y'
        - name: match
          in: query
          description: >
            Match pcode, pname, pshort, pfull filters with includes or excludes condition.

            Example: `q=my_search&pname=Y&pshort=Y&pfull=Y&match=any`
          schema:
            type: string
            enum:
              - 'any'
              - 'all'
        - name: amount_from
          in: query
          description: Filter the products by the minimum amount.
          schema:
            type: number
        - name: amount_to
          in: query
          description: Filter the products by the maximum amount.
          schema:
            type: number
        - name: company_ids
          in: query
          description: Filter the products by companies ID.
        - name: cid
          in: query
          description: Filter the products by their category ID.
          schema:
            type: string
        - name: subcats
          in: query
          description: >
            When the `cid` filter is set (to filter products by category):


            - Y: products in sub-categories of the category will be included

            - N: products in sub-categories of the category will **not** be
            included
          schema:
            type: string
            enum:
              - 'Y'
              - 'N'
        - name: status
          in: query
          description: Filter the products by their status.
          schema:
            type: string
            enum:
              - A
              - D
              - H
        - name: items_per_page
          in: query
          description: Number of products to return per page
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 100
        - name: sort_by
          in: query
          description: Sort products by term
          schema:
            type: string
            enum:
              - 'status'
              - 'code'
              - 'product'
              - 'amount'
              - 'price'
        - name: sort_order
          in: query
          description: Type of sort
          schema:
            type: string
            enum:
              - 'asc'
              - 'desc'
      responses:
        '200':
          description: The product list.
          content:
            application/json:
              schema:
                type: object
                properties:
                  products:
                    type: array
                    items:
                      $ref: '#/components/schemas/PimProductSummary'
        '400':
          description: Invalid request.
    post:
      tags:
        - PIM
      summary: Create a product
      description: Create a new product.
      responses:
        '200':
          description: Information about the created product.
          content:
            application/json:
              schema:
                type: object
                properties:
                  product_id:
                    type: integer
                    description: The created product's ID.
                    example: 10
        '400':
          description: Invalid request.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePimProduct'
        required: true
  '/products/{productId}':
    parameters:
      - $ref: '#/components/parameters/productId'
    get:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Get a product
      description: Retrieve a product by its ID.
      responses:
        '200':
          description: The product.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PimProduct'
        '404':
          description: The product was not found.
    put:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Update a product
      description: Update a product.
      responses:
        '201':
          description: The product.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PimProduct'
        '404':
          description: The product was not found.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PimProduct'
        description: The data for the product.
        required: true
    delete:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Delete a product
      description: Delete a product by its ID.
      responses:
        '200':
          description: Product removed.
        '400':
          description: Product not found.
  '/products/{productId}/shippings':
    parameters:
      - $ref: '#/components/parameters/productId'
    get:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Get a product's shippings
      description: Retrieve the list of shippings of a product.
      responses:
        '200':
          description: The product's shippings.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PimShipping'
        '404':
          description: The product was not found.
  '/products/{productId}/shippings/{shippingId}':
    parameters:
      - $ref: '#/components/parameters/productId'
      - $ref: '#/components/parameters/shippingId'
    get:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Get a product's shipping
      description: Retrieve the shipping of a product.
      responses:
        '200':
          description: The shipping.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PimShipping'
        '404':
          description: The product or the shipping was not found.
    put:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Update a product's shipping
      description: Update the shipping of a product.
      responses:
        '200':
          description: The shipping.
          content:
            application/json:
              schema:
                type: object
                properties:
                  shipping_id:
                    type: string
                    example: "1"
                  product_id:
                    type: int
                    example: 2
        '404':
          description: The product or the shipping was not found.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PimShipping'
        description: The data for the shipping.
        required: true
  '/products/{productId}/features':
    parameters:
      - $ref: '#/components/parameters/productId'
    get:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Get a product's attributes
      description: Retrieve the values set for the attributes of a product.
      responses:
        '200':
          description: The product's attributes.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PimAttributeValue'
        '404':
          description: The product was not found.
  '/products/{productId}/features/{attributeId}':
    parameters:
      - $ref: '#/components/parameters/productId'
      - $ref: '#/components/parameters/attributeId'
    get:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Get a product's attribute
      description: Retrieve the value set for an attribute of a product.
      responses:
        '200':
          description: The attribute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PimAttributeValue'
        '404':
          description: The product or the attribute was not found.
    put:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Update a product's attribute's value
      description: Update the value set for an attribute of a product.
      responses:
        '200':
          description: The attribute's value is updated.
          content:
            application/json:
              schema:
                type: object
                properties:
                  feature_id:
                    type: integer
                    description: The attribute ID.
                    example: 345
        '404':
          description: The product or the attribute was not found.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                value_str:
                  type: string
                  description: >
                    Value set for the attribute.


                    This field is used for attributes that do not have variants
                    (`T`, `O` or `C`).
                  example: Brand 1
                variant_id:
                  type: array
                  items:
                    type: integer
                  description: >
                    List of variant IDs selected for this attribute.


                    This field is used for attributes that have variants (`S`,
                    `E`, `N` or `M`).
                  example: '[3] or [1, 23, 5]'
        description: The attribute's value (use only one of the following fields).
        required: true
  '/pim/products/{productId}/attachments/{attachmentId}':
    parameters:
      - $ref: '#/components/parameters/productId'
      - $ref: '#/components/parameters/attachmentId'
    delete:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Remove an attachment from a product
      description: Try to remove an attachment if it belongs to the product.
      responses:
        '204':
          description: Attachment has been removed.
        '401':
          description: Attachment does not belong to the product.
        '403':
          description: >-
            The vendor is not allowed to delete an attachment of a product he or
            she doesn't own.
        '404':
          description: Attachment or Product not found.
  /csv/products:
    post:
      tags:
        - PIM
      summary: CSV product import
      description: >
        Import (create or update) products using a CSV file.


        The separator used in the CSV import must be `;`.


        **Warning: please be aware that this API route is not prefixed by
        `/api/v1/`, the URL is `https://<domain>/csv/products`.**
      responses:
        '200':
          description: The CSV file is being imported asynchronously.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                type_csv_file:
                  description: >
                    Must contain either:

                    - `url` if `file_csv_file` contains the URL of the CSV file
                    (the file will be downloaded),

                    - or `local` if `file_csv_file` contains the CSV file
                    directly.
                  type: string
                  enum:
                    - url
                    - local
                file_csv_file:
                  type: string
                  format: binary
              required:
                - type_csv_file
                - file_csv_file
  '/pim/moderation/products/{productId}/{moderationAction}':
    parameters:
      - $ref: '#/components/parameters/productId'
      - $ref: '#/components/parameters/moderationActionByProduct'
    put:
      tags:
        - PIM
      summary: Moderate a product
      description: >-
        Moderate a product to a predefined state (`pending`, `approved`,
        `disapproved`, `standby`).
      responses:
        '204':
          description: Moderation status updated.
        '400':
          description: 'Invalid request: see the error message in the body.'
        '403':
          description: You must be an admin to moderate products.
        '404':
          description: Product not found or invalid moderation status.
  '/pim/moderation/companies/{companyId}/products/{moderationAction}':
    parameters:
      - $ref: '#/components/parameters/companyId'
      - $ref: '#/components/parameters/moderationActionByCompany'
    put:
      tags:
        - PIM
      summary: Moderate products of a company
      description: >-
        Moderate products of a company to a predefined state (pending, approved,
        disapproved, standby)
      responses:
        '204':
          description: Moderation status updated.
        '400':
          description: 'Invalid request: see the error message in the body.'
        '403':
          description: You must be an admin to moderate products.
        '404':
          description: Company not found or invalid moderation status.
  /pim/multi-vendor-products:
    get:
      parameters:
        - name: page
          in: query
          description: Page to return (starts at 1).
          schema:
            type: integer
            default: 1
        - name: resultsPerPage
          in: query
          description: Number of results per page.
          schema:
            type: integer
            default: 50
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Get multi-vendor products
      description: List all multi-vendor products.
      responses:
        '200':
          description: List of multi vendor products.
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  count:
                    type: integer
                  _embedded:
                    type: array
                    items:
                      $ref: '#/components/schemas/MultiVendorProduct'
    post:
      tags:
        - PIM
      summary: Create a multi-vendor product
      description: Create a new multi vendor product.
      responses:
        '201':
          description: Multi vendor products created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiVendorProduct'
        '400':
          description: 'Invalid argument : see error message in the body'
        '404':
          description: Multi vendor product not found
      requestBody:
        $ref: '#/components/requestBodies/MultiVendorProduct'
  '/pim/multi-vendor-products/{multiVendorProductId}':
    parameters:
      - $ref: '#/components/parameters/multiVendorProductId'
    get:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Get a multi-vendor product
      description: Retrieve a multi vendor product.
      responses:
        '200':
          description: The multi-vendor product.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiVendorProduct'
        '404':
          description: Multi vendor product not found
    put:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Update a multi-vendor product
      description: Update a multi-vendor product.
      responses:
        '201':
          description: Multi vendor product added
        '400':
          description: 'Invalid argument : see error message in the body'
        '404':
          description: Multi vendor product not found
      requestBody:
        $ref: '#/components/requestBodies/MultiVendorProduct'
    patch:
      tags:
      - PIM
      security:
      - apiKey: []
      summary: Partially update a multi-vendor product
      description: Partially update a multi-vendor product.
      responses:
        '201':
          description: The multi-vendor product was updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiVendorProduct'
        '404':
          description: The multi-vendor product was not found.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultiVendorProduct'
        description: The modified data for the multi-vendor product.
        required: true
    delete:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Delete a multi-vendor product
      description: Delete a multi vendor product.
      responses:
        '204':
          description: Multi vendor product removed
        '404':
          description: Multi vendor product not found
  '/pim/multi-vendor-products/{multiVendorProductId}/images':
    parameters:
      - $ref: '#/components/parameters/multiVendorProductId'
    post:
      tags:
        - PIM
      summary: Add an image to a multi-vendor product
      description: >-
        Upload and associate an image to an MVP. **The request should be in
        multipart.**
      responses:
        '200':
          description: Image is uploaded and associated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiVendorProduct'
        '400':
          description: 'Invalid argument : see error message in the body'
        '404':
          description: Multi vendor product not found
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  description: Image file.
                  type: string
                  format: binary
              required:
                - file
  '/pim/multi-vendor-products/{multiVendorProductId}/images/{imageId}':
    parameters:
      - $ref: '#/components/parameters/multiVendorProductId'
      - $ref: '#/components/parameters/imageId'
    delete:
      tags:
        - PIM
      summary: Delete an image from a multi-vendor product
      description: >-
        Delete the image from the multi-vendor product
      responses:
        '204':
          description: Image is deleted
        '404':
          description: Multi vendor product or image not found
  '/pim/multi-vendor-products/{multiVendorProductId}/links':
    parameters:
      - $ref: '#/components/parameters/multiVendorProductId'
    get:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Get a multi-vendor product's links
      description: >-
        List all links between a multi-vendor product and the associated
        products.
      responses:
        '200':
          description: List of links between MVP and product
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MultiVendorProductLink'
    post:
      tags:
        - PIM
      summary: Link a multi-vendor product to a product
      description: >
        Create a new link between a multi-vendor product and a product.


        By default links are created and deleted automatically by the
        marketplace so this

        API endpoint will not be useful. It exists only for the cases when links
        are

        managed manually.
      responses:
        '201':
          description: The link was created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiVendorProductLink'
        '400':
          description: 'Invalid argument : see error message in the body'
        '404':
          description: Multi vendor product not found
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - multiVendorProductId
                - productId
              properties:
                multiVendorProductId:
                  type: string
                productId:
                  type: integer
        description: The data for the link
        required: true
  '/pim/multi-vendor-products/{multiVendorProductId}/links/{productId}':
    parameters:
      - $ref: '#/components/parameters/multiVendorProductId'
      - $ref: '#/components/parameters/productId'
    delete:
      tags:
        - PIM
      summary: Detach a multi-vendor product and a product
      description: >
        Delete a link between a multi-vendor product and a product.


        By default links are created and deleted automatically by the
        marketplace so this

        API endpoint will not be useful. It exists only for the cases when links
        are

        managed manually.
      responses:
        '204':
          description: Product is detached from MVP
        '404':
          description: Link not found
  /categories:
    get:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Get categories
      description: List all categories.
      parameters:
        - name: leaves
          in: query
          description: Retrieve only leaves.
          required: false
          schema:
            type: boolean
        - name: category_ids
          in: query
          description: Retrieve only categories matching the given ids.
          required: false
          schema:
            type: array
            items:
              type: integer
      responses:
        '200':
          description: List of categories.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Category'
  '/categories/{categoryId}':
    parameters:
      - $ref: '#/components/parameters/categoryId'
    get:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Get a category
      description: Retrieve a specific category by ID.
      responses:
        '200':
          description: The category.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Category'
        '404':
          description: The category does not exist.
  /pim/attributes:
    get:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Get attributes
      description: List all attributes (flatten and groups included).
      responses:
        '200':
          description: List of attributes.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Attribute'
    post:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Create an attibute
      description: Create a new attibute.
      responses:
        '201':
          description: The attribute was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Attribute'
        '400':
          description: 'Invalid request: see the error message in the body.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - type
              properties:
                id:
                  type: integer
                name:
                  type: string
                  description: Attribute name.
                  example: Brand
                code:
                  type: string
                  description: Attribute unique code.
                  example: brand
                description:
                  type: string
                  description: Attribute description which may contain HTML.
                  example: <p>The brand of the product.</p>
                type:
                  $ref: '#/components/schemas/AttributeType'
                categoryIds:
                  type: array
                  items:
                    type: integer
                  description: >
                    The list of category IDs in which the attribute will be
                    available.

                    If `null` the attribute will be available everywhere.
                  example:
                    - 123
                    - 456
                parentId:
                  type: integer
                  description: 'The ID of the parent attribute (the group), or `null`.'
                isDisplayedOnProduct:
                  type: boolean
                  description: >
                    If `true` the attribute will be returned in the list of
                    attributes

                    in the *Catalog*. That means the attribute will be displayed
                    on the

                    product page.
                isRequired:
                  type: boolean
                  description: >
                    If `true` the attribute must be filled when creating or
                    updating a product.
                isOnlyEditableByAdmin:
                  type: boolean
                  description: >
                    If `true` the attribute can only be changed by an
                    administrator (not vendors).
                isASearchFilter:
                  type: boolean
                  description: >
                    If `true` the attribute will be available as a search filter
                    and will

                    appear in the search facets.
                isIndexedForTextSearch:
                  type: boolean
                  description: >
                    If `true` the attribute's value will be indexed for the
                    product search.


                    For example if the attribute is a brand, and a product has
                    "Apple" as the

                    attribute value, then searching for "Apple" will allow to
                    find the product.
                isUsedForRecommendations:
                  type: boolean
                  description: >
                    If `true` the attribute will be used by the recommendation engine.
                status:
                  type: string
                  enum:
                    - A
                    - D
                  description: |
                    Status of the attribute:

                    - `A`: the attribute is enabled
                    - `D`: the attribute is disabled
                position:
                  type: integer
                  description: Position of the attribute (used to sort attributes).
        description: The data for the attribute.
        required: true
  '/pim/attributes/{attributeId}':
    parameters:
      - $ref: '#/components/parameters/attributeId'
    get:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Get an attribute
      description: Retrieve an attribute by its ID.
      responses:
        '200':
          description: The attribute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Attribute'
        '404':
          description: Attribute not found
    put:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Update an attribute
      description: Update an attribute
      responses:
        '201':
          description: Attribute added
        '400':
          description: 'Invalid argument : see error message in the body'
        '404':
          description: Attribute not found
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                id:
                  type: integer
                name:
                  type: string
                  example: Brand
                code:
                  type: string
                  example: brand
                description:
                  type: string
                  example: <p>These are the brands.</p>
                categoryIds:
                  type: array
                  items:
                    type: integer
                  example:
                    - 123
                    - 456
                parentId:
                  type: integer
                isDisplayedOnProduct:
                  type: boolean
                isRequired:
                  type: boolean
                isOnlyEditableByAdmin:
                  type: boolean
                isASearchFilter:
                  type: boolean
                isIndexedForTextSearch:
                  type: boolean
                isUsedForRecommendations:
                  type: boolean
                status:
                  type: string
                  enum:
                    - A
                    - D
                position:
                  type: integer
        description: >
          The data for the attribute.


          **For more information on each field** see the documentation for *Get
          an attribute*.
        required: true
    delete:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Delete an attribute
      description: Delete an attribute and its variants.
      responses:
        '204':
          description: The attribute was deleted.
        '404':
          description: The attribute was not found.
  '/pim/attributes/{attributeId}/variants':
    parameters:
      - $ref: '#/components/parameters/attributeId'
    post:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Create an attribute variant
      description: Create a new variant for the given attribute.
      responses:
        '201':
          description: Variant created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Variant'
        '400':
          description: 'Invalid argument : see error message in the body'
      requestBody:
        $ref: '#/components/requestBodies/Variant'
  '/pim/attributes/{attributeId}/variants/{attributeVariantId}':
    parameters:
      - $ref: '#/components/parameters/attributeId'
      - $ref: '#/components/parameters/attributeVariantId'
    put:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Update an attribute variant
      description: Update a variant of a given attribute.
      responses:
        '201':
          description: Variant added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Variant'
        '400':
          description: 'Invalid argument : see error message in the body'
        '404':
          description: Attribute or variant not found
      requestBody:
        $ref: '#/components/requestBodies/Variant'
    delete:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Delete an attribute variant
      description: Delete a variant of a given attribute.
      responses:
        '204':
          description: Variant deleted
        '404':
          description: Variant not found
  /taxes:
    get:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Get taxes
      description: List all the taxes available.
      responses:
        '200':
          description: Tax
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    tax_id:
                      type: integer
                      description: Tax ID.
                    tax:
                      type: string
                      description: Tax name.
                      example: TVA 20%
  '/products/{productId}/video':
    parameters:
      - $ref: '#/components/parameters/productId'
    post:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Add a video to a product
      description: >
        Add a video to the given product.


        If the product already has a video, that video will be deleted.
      requestBody:
        content:
          x-www-form-urlencoded:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: Video url.
      responses:
        '200':
          description: Video added to product.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Video id.
                    example: 414375b2-61cb-4260-b82b-4a2636cb5673
        '404':
          description: The product was not found.
    delete:
      tags:
        - PIM
      security:
        - apiKey: []
      summary: Delete the video attached to a product
      description: Delete the video attached to the given product.
      responses:
        '204':
          description: Video removed.
        '404':
          description: Video not found.