VTEX Indices API

openapi: 3.2.0
info:
  title: VTex Master Data API - v2 Indices API
  description: '>ℹ️ Master Data v2 is not compatible with data entities from previous versions, such as CL and AD.'
  contact: {}
  version: '1.0'
servers:
- url: https://{accountName}.{environment}.com.br
  description: VTEX server URL.
  variables:
    accountName:
      description: Name of the VTEX account. Used as part of the URL
      default: apiexamples
    environment:
      description: Environment to use. Used as part of the URL.
      enum:
      - vtexcommercestable
      default: vtexcommercestable
security:
- appKey: []
  appToken: []
- VtexIdclientAutCookie: []
tags:
- name: Indices
paths:
  /api/dataentities/{dataEntityName}/indices:
    get:
      tags:
      - Indices
      summary: VTex Get indices
      description: 'Returns the list of indices by data entity.


        ## Permissions


        Any user or application key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:


        | **Product** | **Category** | **Resource** |

        | --------------- | ----------------- | ----------------- |

        | Dynamic Storage | Index | **View index details** |

        | Dynamic Storage | Index | **List index** |

        | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |


        There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see Authentication overview.


        >❗ To prevent integrations from having excessive permissions, consider the best practices for managing app keys when assigning License Manager roles to integrations.'
      operationId: Getindices
      parameters:
      - $ref: '#/components/parameters/dataEntityName'
      - $ref: '#/components/parameters/Content-Type'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                description: Array with information about indices.
                items:
                  $ref: '#/components/schemas/Index'
              example:
              - name: fullName
                acronym: Newsletter
                isGlobal: false
                multiple: false
                fields: firstName,lastName
      deprecated: false
    put:
      tags:
      - Indices
      summary: VTex Create index
      description: 'Creates an index.


        ## Permissions


        Any user or application key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:


        | **Product** | **Category** | **Resource** |

        | --------------- | ----------------- | ----------------- |

        | Dynamic Storage | Index | **Edit index** |

        | Dynamic Storage | Index | **Create index** |

        | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |


        There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see Authentication overview.


        >❗ To prevent integrations from having excessive permissions, consider the best practices for managing app keys when assigning License Manager roles to integrations.'
      operationId: Putindices
      parameters:
      - $ref: '#/components/parameters/dataEntityName'
      requestBody:
        description: Request body for creating an index
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutindicesRequest'
            example:
              name: indexName
              multiple: false
              fields: fieldName
        required: true
      responses:
        '200':
          description: OK
      deprecated: false
  /api/dataentities/{dataEntityName}/indices/{index_name}:
    get:
      tags:
      - Indices
      summary: VTex Get index by name
      description: 'Retrieves an index.


        ## Permissions


        Any user or application key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:


        | **Product** | **Category** | **Resource** |

        | --------------- | ----------------- | ----------------- |

        | Dynamic Storage | Index | **View index details** |

        | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |


        There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see Authentication overview.


        >❗ To prevent integrations from having excessive permissions, consider the best practices for managing app keys when assigning License Manager roles to integrations.'
      operationId: Getindexbyname
      parameters:
      - $ref: '#/components/parameters/dataEntityName'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/index_name'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Index'
              example:
                name: fullName
                acronym: Newsletter
                isGlobal: false
                multiple: false
                fields: firstName,lastName
      deprecated: false
    delete:
      tags:
      - Indices
      summary: VTex Delete index by name
      description: 'Deletes an index.


        ## Permissions


        Any user or application key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:


        | **Product** | **Category** | **Resource** |

        | --------------- | ----------------- | ----------------- |

        | Dynamic Storage | Index | **Remove index** |

        | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |


        There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see Authentication overview.


        >❗ To prevent integrations from having excessive permissions, consider the best practices for managing app keys when assigning License Manager roles to integrations.'
      operationId: Deleteindexbyname
      parameters:
      - $ref: '#/components/parameters/dataEntityName'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/index_name'
      responses:
        '204':
          description: No Content
      deprecated: false
components:
  schemas:
    Index:
      type: object
      description: Index information.
      properties:
        name:
          type: string
          description: Index name.
        acronym:
          type: string
          description: Data entity name.
        isGlobal:
          type: boolean
          description: Defines whether the index is global (`true`) or not (`false`).
          deprecated: true
        multiple:
          type: boolean
          description: Determines whether the values need to be unique. If `false`, values must be unique.
        fields:
          type: string
          description: Comma-separated fields of the index.
    PutindicesRequest:
      title: PutindicesRequest
      required:
      - name
      - multiple
      - fields
      type: object
      description: Request body object.
      properties:
        name:
          description: Name to identify the index.
          type: string
          example: indexName
        multiple:
          description: Determines whether the values need to be unique. If false, values must be unique.
          type: boolean
          example: false
        fields:
          description: Comma-separated fields of the index.
          type: string
          example: fieldName
  parameters:
    Content-Type:
      name: Content-Type
      in: header
      description: Type of the content being sent.
      required: true
      style: simple
      schema:
        type: string
        example: application/json
    index_name:
      name: index_name
      in: path
      description: Name of the index.
      required: true
      style: simple
      schema:
        type: string
        example: '{{index_name}}'
    dataEntityName:
      name: dataEntityName
      in: path
      required: true
      description: Name of the data entity.
      schema:
        type: string
        example: Newsletter
  securitySchemes:
    appKey:
      type: apiKey
      in: header
      name: X-VTEX-API-AppKey
      description: Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
    appToken:
      type: apiKey
      in: header
      name: X-VTEX-API-AppToken
      description: Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
    VtexIdclientAutCookie:
      type: apiKey
      in: header
      name: VtexIdclientAutCookie
      description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'