VTEX · Example Payload

Vtex Getindexbyname Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getindexbyname Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "Getindexbyname",
  "method": "GET",
  "path": "/api/dataentities/{dataEntityName}/indices/{index_name}",
  "summary": "VTex Get index by name",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "name": "fullName",
        "acronym": "Newsletter",
        "isGlobal": false,
        "multiple": false,
        "fields": "firstName,lastName"
      }
    }
  ]
}