VTEX · Schema

Matcher

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
MatcherId	string	Identifies the matching entity. It can be either VTEX's matcher, or an external matcher developed by partners, for example. The `matcherId`'s value can be obtained through the [Get SKU Suggestion by I
hook-base-address	string	The chosen Matcher's url. It is the endpoint that the Received SKUs module calls, to send new suggestions for the Matcher's review.
IsActive	boolean	Whether the matcher is active in the account (`true`), or not (`false`).
UpdatesNotificationEndpoint	string	The Received SKUs module uses this endpoint to send updates about a suggestion, to the chosen Matcher.
Description	string	Insert in this field any notes about the approval. This field is optional.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Matcher",
  "title": "Matcher",
  "required": [
    "MatcherId",
    "hook-base-address",
    "IsActive",
    "UpdatesNotificationEndpoint"
  ],
  "type": "object",
  "properties": {
    "MatcherId": {
      "type": "string",
      "description": "Identifies the matching entity. It can be either VTEX's matcher, or an external matcher developed by partners, for example. The `matcherId`'s value can be obtained through the [Get SKU Suggestion by ID](https://developers.vtex.com/vtex-rest-api/reference/getsuggestion) endpoint.",
      "default": "vtex-matcher"
    },
    "hook-base-address": {
      "type": "string",
      "description": "The chosen Matcher's url. It is the endpoint that the Received SKUs module calls, to send new suggestions for the Matcher's review.",
      "default": "http://simple-suggestion-matcher.vtex.com.br"
    },
    "IsActive": {
      "type": "boolean",
      "description": "Whether the matcher is active in the account (`true`), or not (`false`).",
      "default": true
    },
    "UpdatesNotificationEndpoint": {
      "type": "string",
      "description": "The Received SKUs module uses this endpoint to send updates about a suggestion, to the chosen Matcher.",
      "nullable": true,
      "default": null
    },
    "Description": {
      "type": "string",
      "description": "Insert in this field any notes about the approval. This field is optional.",
      "nullable": true,
      "default": null
    }
  }
}