VTEX · Schema

SaveaccountconfigRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
Score object
Matchers array Matchers for approving and rejecting SKUs received from sellers.
SpecificationsMapping array This attribute maps product and SKU specifications.
MatchFlux string This field determines the type of approval configuration applied to SKUs received from a seller. The possible values include: - `default` where the Matcher reviews the SKU, and approves it based on it
View JSON Schema on GitHub

JSON Schema

vtex-saveaccountconfigrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SaveaccountconfigRequest",
  "title": "SaveaccountconfigRequest",
  "required": [
    "Score",
    "Matchers",
    "SpecificationsMapping",
    "MatchFlux"
  ],
  "type": "object",
  "properties": {
    "Score": {
      "$ref": "#/components/schemas/Score"
    },
    "Matchers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Matcher"
      },
      "description": "Matchers for approving and rejecting SKUs received from sellers."
    },
    "SpecificationsMapping": {
      "type": "array",
      "description": "This attribute maps product and SKU specifications.",
      "items": {
        "type": "string",
        "default": "                    \"SellerId\": \"sellerID\",\n                    \"Mapping\": {\n                        \"Choose voltage\": \"Voltage\",\n                        \"Choose size\": \"Size\",\n                        \"Choose volume\": \"Volume\",\n                        \"Choose type\": \"Type\"\n                    }"
      }
    },
    "MatchFlux": {
      "type": "string",
      "description": "This field determines the type of approval configuration applied to SKUs received  from a seller. The possible values include: \n\n- `default` where the Matcher reviews the SKU, and approves it based on its score \n\n- `manual` for manual approvals through the Received SKU UI or Match API \n\n- `autoApprove` for every SKU received from a given seller to be approved automatically, regardless of the Matcher Score.",
      "default": "autoApprove"
    }
  },
  "example": {
    "Score": {
      "Approve": 80,
      "Reject": 30
    },
    "Matchers": [
      {
        "MatcherId": "vtex-matcher",
        "hook-base-address": "http://simple-suggestion-matcher.vtex.com.br",
        "IsActive": true,
        "UpdatesNotificationEndpoint": null,
        "Description": null
      }
    ],
    "SpecificationsMapping": [],
    "MatchFlux": "AutoApprove"
  }
}