VTEX · Schema

EvaluatePolicyRequest

Object with policy conditions.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
resource string Scope on which this policy must be evaluated.
context object Conditions that the policy needs to satisfy.
View JSON Schema on GitHub

JSON Schema

vtex-evaluatepolicyrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EvaluatePolicyRequest",
  "title": "EvaluatePolicyRequest",
  "required": [
    "resource",
    "context"
  ],
  "type": "object",
  "description": "Object with policy conditions.",
  "properties": {
    "resource": {
      "description": "Scope on which this policy must be evaluated.",
      "title": "resource",
      "type": "string",
      "example": "vrn:vtex.promotions-alert:aws-us-east-1:kamila:master:/_v/promotions_alert"
    },
    "context": {
      "type": "object",
      "description": "Conditions that the policy needs to satisfy.",
      "title": "context",
      "example": {
        "brandId": "2000001",
        "discountPercentage": "91.00"
      },
      "additionalProperties": true
    }
  }
}