VTEX · Schema

responseSellerCommissionsID

Object with the category properties and the commission percentage applied to it.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
categoryId string Marketplace's Category ID that the product belongs to, configured in the Catalog.
categoryName string Category name with applied commission.
categoryFullPath array Full path to the SKU's category.
productCommissionPercentage number Percentage of the comission applied to the product in decimals.
freightCommissionPercentage number Percentage of the comission applied to the freight in decimals.
View JSON Schema on GitHub

JSON Schema

vtex-responsesellercommissionsid-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/responseSellerCommissionsID",
  "title": "responseSellerCommissionsID",
  "type": "object",
  "description": "Object with the category properties and the commission percentage applied to it.",
  "properties": {
    "categoryId": {
      "type": "string",
      "description": "Marketplace's Category ID that the product belongs to, configured in the Catalog.",
      "example": "51"
    },
    "categoryName": {
      "type": "string",
      "description": "Category name with applied commission.",
      "example": "Clothes"
    },
    "categoryFullPath": {
      "type": "array",
      "description": "Full path to the SKU's category.",
      "items": {
        "type": "string",
        "example": "2.0"
      },
      "example": [
        "2.0",
        "Boys",
        "Clothes"
      ]
    },
    "productCommissionPercentage": {
      "type": "number",
      "description": "Percentage of the comission applied to the product in decimals.",
      "example": 7.75
    },
    "freightCommissionPercentage": {
      "type": "number",
      "description": "Percentage of the comission applied to the freight in decimals.",
      "example": 2.33
    }
  },
  "example": {
    "categoryId": "51",
    "categoryName": "Clothes",
    "categoryFullPath": [
      "2.0",
      "Boys",
      "Clothes"
    ],
    "productCommissionPercentage": 7.75,
    "freightCommissionPercentage": 2.33
  }
}