VTEX · Example Payload

Vtex Validatedocumentbyclusters Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Validatedocumentbyclusters 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

{
  "operationId": "Validatedocumentbyclusters",
  "method": "POST",
  "path": "/api/dataentities/{dataEntityName}/documents/{id}/clusters",
  "summary": "VTex Validate document by clusters",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": [
        {
          "name": "male",
          "rule": "gender=male"
        },
        {
          "name": "complex",
          "rule": "((gender=male AND percent=0.35) AND any is null) AND (name=*go*)"
        },
        {
          "name": "complex2",
          "rule": "((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)"
        },
        {
          "name": "createdIn",
          "rule": "createdIn between 2015-10-28 AND 2015-10-30"
        }
      ]
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "name": "male",
          "isValid": false
        },
        {
          "name": "complex",
          "isValid": false
        },
        {
          "name": "complex2",
          "isValid": false
        },
        {
          "name": "createdIn",
          "isValid": false
        }
      ]
    }
  ]
}