VTEX · Example Payload

Vtex Get Correction Search Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Get Correction Search 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": "get-correction-search",
  "method": "GET",
  "path": "/correction_search",
  "summary": "VTex Get attempt of correction of a misspelled term",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "correction": {
          "correction": true,
          "misspelled": true,
          "text": "mountain bike",
          "highlighted": "mountain <em>bike</em>"
        }
      }
    }
  ]
}