VTEX · Schema

PutindicesRequest

Request body object.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
name	string	Name to identify the index.
multiple	boolean	Determines whether the values need to be unique. If false, values must be unique.
fields	string	Comma-separated fields of the index.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/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"
    }
  }
}