VTex Marketplace API — Seller Commissions

naftiko: 1.0.0-alpha2
info:
  label: VTex Marketplace API — Seller Commissions
  description: 'VTex Marketplace API — Seller Commissions. 4 operations. Lead operation: VTex List Seller Commissions by seller
    ID. Self-contained Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Seller Commissions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: marketplace-seller-commissions
    baseUri: https://{accountName}.{environment}.com.br/api
    description: VTex Marketplace API — Seller Commissions business capability. Self-contained, no shared references.
    resources:
    - name: seller-register-pvt-sellers-sellerId-commissions
      path: /seller-register/pvt/sellers/{sellerId}/commissions
      operations:
      - name: listsellercommissions
        method: GET
        description: VTex List Seller Commissions by seller ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: bulkupsertsellercommissions
        method: PUT
        description: VTex Upsert Seller Commissions in bulk
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: seller-register-pvt-sellers-sellerId-commissions-categoryId
      path: /seller-register/pvt/sellers/{sellerId}/commissions/{categoryId}
      operations:
      - name: removesellercommissions
        method: DELETE
        description: VTex Remove Seller Commissions by Category ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: retrievesellercommissions
        method: GET
        description: VTex Get Seller Commissions by Category ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountName
          in: path
          type: string
          description: Name of the VTEX account that belongs to the marketplace. All data extracted, and changes added will
            be posted into this account.
          required: true
        - name: environment
          in: path
          type: string
          description: Environment to use. Used as part of the URL.
          required: true
        - name: Accept
          in: header
          type: string
          description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
          required: true
        - name: Content-Type
          in: header
          type: string
          description: Describes the type of the content being sent.
          required: true
        - name: sellerId
          in: path
          type: string
          description: A string that identifies the seller in the marketplace. This ID must be created by the marketplace.
          required: true
        - name: categoryId
          in: path
          type: string
          description: ID of the category in which the comission was applied
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: marketplace-seller-commissions-rest
    port: 8080
    description: REST adapter for VTex Marketplace API — Seller Commissions. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/seller-register/pvt/sellers/{sellerid}/commissions
      name: seller-register-pvt-sellers-sellerid-commissions
      description: REST surface for seller-register-pvt-sellers-sellerId-commissions.
      operations:
      - method: GET
        name: listsellercommissions
        description: VTex List Seller Commissions by seller ID
        call: marketplace-seller-commissions.listsellercommissions
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: bulkupsertsellercommissions
        description: VTex Upsert Seller Commissions in bulk
        call: marketplace-seller-commissions.bulkupsertsellercommissions
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/seller-register/pvt/sellers/{sellerid}/commissions/{categoryid}
      name: seller-register-pvt-sellers-sellerid-commissions-categoryid
      description: REST surface for seller-register-pvt-sellers-sellerId-commissions-categoryId.
      operations:
      - method: DELETE
        name: removesellercommissions
        description: VTex Remove Seller Commissions by Category ID
        call: marketplace-seller-commissions.removesellercommissions
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: retrievesellercommissions
        description: VTex Get Seller Commissions by Category ID
        call: marketplace-seller-commissions.retrievesellercommissions
        with:
          accountName: rest.accountName
          environment: rest.environment
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          sellerId: rest.sellerId
          categoryId: rest.categoryId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: marketplace-seller-commissions-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Marketplace API — Seller Commissions. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: vtex-list-seller-commissions-seller
      description: VTex List Seller Commissions by seller ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-seller-commissions.listsellercommissions
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-upsert-seller-commissions-bulk
      description: VTex Upsert Seller Commissions in bulk
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: marketplace-seller-commissions.bulkupsertsellercommissions
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-remove-seller-commissions-category
      description: VTex Remove Seller Commissions by Category ID
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: marketplace-seller-commissions.removesellercommissions
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-seller-commissions-category
      description: VTex Get Seller Commissions by Category ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-seller-commissions.retrievesellercommissions
      with:
        accountName: tools.accountName
        environment: tools.environment
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        sellerId: tools.sellerId
        categoryId: tools.categoryId
      outputParameters:
      - type: object
        mapping: $.