VTEX · Schema

SkuComplement

CommerceE-CommerceRetailMarketplacePayments
View JSON Schema on GitHub

JSON Schema

vtex-skucomplement-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SkuComplement",
  "title": "SkuComplement",
  "required": [
    "Id",
    "SkuId",
    "ParentSkuId",
    "ComplementTypeId"
  ],
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "Id": {
        "type": "integer",
        "description": "SKU complement's unique numerical identifier."
      },
      "SkuId": {
        "type": "integer",
        "description": "ID of the SKU which will be inserted as a complement in the parent SKU."
      },
      "ParentSkuId": {
        "type": "integer",
        "description": "ID of the parent SKU, where the complement will be inserted."
      },
      "ComplementTypeId": {
        "type": "integer",
        "description": "Complement type ID. This represents the type of the complement. The possible values are: `1` for **Accessory**; `2` for  **Suggestion**; `3` for **Similar product**; `5` for **Show together**.",
        "enum": [
          1,
          2,
          3,
          4,
          5
        ]
      }
    }
  },
  "example": [
    {
      "Id": 61,
      "SkuId": 7,
      "ParentSkuId": 1,
      "ComplementTypeId": 1
    }
  ]
}