MatchMultiple

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MatchMultiple",
  "title": "MatchMultiple",
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "itemId",
      "versionId",
      "matchId",
      "matcherId",
      "categoryId",
      "sellerId"
    ],
    "properties": {
      "itemId": {
        "type": "string",
        "description": "This field can be used to link any string that identifies that SKU. Its most common use is the seller's SKU ID.",
        "example": "1234567"
      },
      "versionId": {
        "type": "string",
        "description": "Whenever an SKU Suggestion is updated or changed, a new version of the original one is created. All versions are logged, so you can search for previous our current states of SKU suggestions. This field is the `versionId` associated to the version you choose to search for. You can get this field's value through the [Get SKU Suggestion by ID](https://developers.vtex.com/vtex-rest-api/reference/getsuggestion). through the `latestVersionId` field.",
        "example": "v.2"
      },
      "matchId": {
        "type": "string",
        "description": "Whenever an SKU suggestion is matched, it is associated to a unique ID. Fill in this field with the `matchId` you wish to filter by. The `matchId`'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"
      },
      "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"
      },
      "categoryId": {
        "type": "integer",
        "format": "int32",
        "nullable": true,
        "description": "Marketplace's Category ID that the product belongs to, configured in the Catalog. It should be the category chosen for the received SKU to be matched with. The `categoryId` is already mapped through the [Get SKU Suggestion by ID](https://developers.vtex.com/vtex-rest-api/reference/getsuggestion). You can choose to keep the same suggested `categoryID`, or overwrite it with another value in this request. This field is nulled when the inserted value is 0.",
        "example": 12
      },
      "brandId": {
        "type": "integer",
        "format": "int32",
        "nullable": true,
        "description": "Marketplace's Brand ID that the product belongs to, configured in the Catalog. It should be the brand chosen for the received SKU to be matched with. The `brandId` is already mapped through the [Get SKU Suggestion by ID](https://developers.vtex.com/vtex-rest-api/reference/getsuggestion). This field is nulled when the inserted value is 0, and is mandatory for the `newproduct` action.",
        "example": 1234567
      },
      "skuRef": {
        "type": "string",
        "nullable": true,
        "description": "Fill in this field on your request when the matched item is an SKU. This field is mandatory for the `skuassociation` action.",
        "example": "123 sku ref"
      },
      "productRef": {
        "type": "string",
        "description": "Fill in this field on your request when the matched item is a product. This field is mandatory for the `productassociation` action.",
        "example": "123 product ref",
        "nullable": true
      },
      "sellerId": {
        "type": "string",
        "description": "A string that identifies the seller in the marketplace. This ID must be created by the marketplace and informed to the seller before the integration is built.",
        "example": "seller123"
      }
    }
  }
}