VTEX · Schema

SkuSeller

Object containing related SKU sellers data.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
SellerId string SKU seller ID. This is the ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the
StockKeepingUnitId integer SKU ID.
SellerStockKeepingUnitId string SKU ID for the SKU seller.
IsActive boolean Defines if the SKU is active.
FreightCommissionPercentage number Registered value for Seller Freight Commission.
ProductCommissionPercentage number Registered value for Seller product Commission.
View JSON Schema on GitHub

JSON Schema

vtex-skuseller-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SkuSeller",
  "title": "SkuSeller",
  "required": [
    "SellerId",
    "StockKeepingUnitId",
    "SellerStockKeepingUnitId",
    "IsActive",
    "FreightCommissionPercentage",
    "ProductCommissionPercentage"
  ],
  "type": "object",
  "description": "Object containing related SKU sellers data.",
  "properties": {
    "SellerId": {
      "type": "string",
      "description": "SKU seller ID. This is the ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID."
    },
    "StockKeepingUnitId": {
      "type": "integer",
      "format": "int32",
      "description": "SKU ID."
    },
    "SellerStockKeepingUnitId": {
      "type": "string",
      "description": "SKU ID for the SKU seller."
    },
    "IsActive": {
      "type": "boolean",
      "description": "Defines if the SKU is active."
    },
    "FreightCommissionPercentage": {
      "type": "number",
      "description": "Registered value for Seller Freight Commission."
    },
    "ProductCommissionPercentage": {
      "type": "number",
      "description": "Registered value for Seller product Commission."
    }
  },
  "example": {
    "SellerId": "1",
    "StockKeepingUnitId": 2001773,
    "SellerStockKeepingUnitId": "2001773",
    "IsActive": true,
    "FreightCommissionPercentage": 0,
    "ProductCommissionPercentage": 0
  }
}