VTEX · Schema

BulkUpsertSellerCommissionsRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
categoryId string Marketplace's Category ID that the product belongs to, configured in the Catalog.
categoryFullPath string Full path to the SKU's category. It should be written as {department}/{category}. For example: if the department is **Appliances** and the category is **Oven**, the full path should be 'Appliances/Ove
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-bulkupsertsellercommissionsrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BulkUpsertSellerCommissionsRequest",
  "title": "BulkUpsertSellerCommissionsRequest",
  "required": [
    "categoryId",
    "categoryFullPath",
    "productCommissionPercentage",
    "freightCommissionPercentage"
  ],
  "type": "object",
  "properties": {
    "categoryId": {
      "type": "string",
      "description": "Marketplace's Category ID that the product belongs to, configured in the Catalog.",
      "example": "6"
    },
    "categoryFullPath": {
      "type": "string",
      "nullable": true,
      "description": "Full path to the SKU's category. It should be written as {department}/{category}. For example: if the department is **Appliances** and the category is **Oven**, the full path should be 'Appliances/Oven'.",
      "example": "Appliances/Oven"
    },
    "productCommissionPercentage": {
      "type": "number",
      "description": "Percentage of the comission applied to the product in decimals.",
      "example": 9.85
    },
    "freightCommissionPercentage": {
      "type": "number",
      "description": "Percentage of the comission applied to the freight in decimals.",
      "example": 2.43
    }
  },
  "example": [
    {
      "categoryId": "6",
      "categoryFullPath": null,
      "productCommissionPercentage": 9.85,
      "freightCommissionPercentage": 2.43
    },
    {
      "categoryId": "51",
      "categoryFullPath": "Appliances/Oven",
      "productCommissionPercentage": 7.85,
      "freightCommissionPercentage": 3.43
    }
  ]
}