VTEX · Example Payload

Vtex Policy Evaluate Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Policy Evaluate 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": "Policy_Evaluate",
  "method": "POST",
  "path": "/api/policy-engine/evaluate",
  "summary": "VTex Evaluate policies",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "resource": "vrn:vtex.promotions-alert:aws-us-east-1:kamila:master:/_v/promotions_alert",
        "context": {
          "brandId": "2000001",
          "discountPercentage": "91.00"
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "id": "SendSlackMessage",
          "metadata": {
            "channel": "C01NJFF35R6",
            "relatedUsers": [
              "URUNDC2NB"
            ],
            "alertDescription": "Avoid selling products from Berenice with a discount greater than 70%."
          }
        }
      ]
    }
  ]
}