VTex Marketplace API — Seller Invite

naftiko: 1.0.0-alpha2
info:
  label: VTex Marketplace API — Seller Invite
  description: 'VTex Marketplace API — Seller Invite. 7 operations. Lead operation: VTex Invite Seller Lead. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Seller Invite
  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-invite
    baseUri: https://{accountName}.{environment}.com.br/api
    description: VTex Marketplace API — Seller Invite business capability. Self-contained, no shared references.
    resources:
    - name: seller-register-pvt-seller-leads
      path: /seller-register/pvt/seller-leads
      operations:
      - name: createsellerlead
        method: POST
        description: VTex Invite Seller Lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: listsellerleads
        method: GET
        description: VTex List Seller Leads
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: seller-register-pvt-seller-leads-sellerLeadId
      path: /seller-register/pvt/seller-leads/{sellerLeadId}
      operations:
      - name: acceptsellerlead
        method: PUT
        description: VTex Accept Seller Lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: retrievesellerlead
        method: GET
        description: VTex Get Seller Lead's Data by Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: removesellerlead
        method: DELETE
        description: VTex Delete Seller Lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: seller-register-pvt-seller-leads-sellerLeadId-seller
      path: /seller-register/pvt/seller-leads/{sellerLeadId}/seller
      operations:
      - name: createsellerfromsellerlead
        method: PUT
        description: VTex Create Seller From Lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: seller-register-pvt-seller-leads-sellerLeadId-status
      path: /seller-register/pvt/seller-leads/{sellerLeadId}/status
      operations:
      - name: resendsellerleadrequest
        method: PUT
        description: VTex Resend Seller Lead Invite
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: marketplace-seller-invite-rest
    port: 8080
    description: REST adapter for VTex Marketplace API — Seller Invite. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/seller-register/pvt/seller-leads
      name: seller-register-pvt-seller-leads
      description: REST surface for seller-register-pvt-seller-leads.
      operations:
      - method: POST
        name: createsellerlead
        description: VTex Invite Seller Lead
        call: marketplace-seller-invite.createsellerlead
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listsellerleads
        description: VTex List Seller Leads
        call: marketplace-seller-invite.listsellerleads
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/seller-register/pvt/seller-leads/{sellerleadid}
      name: seller-register-pvt-seller-leads-sellerleadid
      description: REST surface for seller-register-pvt-seller-leads-sellerLeadId.
      operations:
      - method: PUT
        name: acceptsellerlead
        description: VTex Accept Seller Lead
        call: marketplace-seller-invite.acceptsellerlead
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: retrievesellerlead
        description: VTex Get Seller Lead's Data by Id
        call: marketplace-seller-invite.retrievesellerlead
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: removesellerlead
        description: VTex Delete Seller Lead
        call: marketplace-seller-invite.removesellerlead
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/seller-register/pvt/seller-leads/{sellerleadid}/seller
      name: seller-register-pvt-seller-leads-sellerleadid-seller
      description: REST surface for seller-register-pvt-seller-leads-sellerLeadId-seller.
      operations:
      - method: PUT
        name: createsellerfromsellerlead
        description: VTex Create Seller From Lead
        call: marketplace-seller-invite.createsellerfromsellerlead
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/seller-register/pvt/seller-leads/{sellerleadid}/status
      name: seller-register-pvt-seller-leads-sellerleadid-status
      description: REST surface for seller-register-pvt-seller-leads-sellerLeadId-status.
      operations:
      - method: PUT
        name: resendsellerleadrequest
        description: VTex Resend Seller Lead Invite
        call: marketplace-seller-invite.resendsellerleadrequest
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: marketplace-seller-invite-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Marketplace API — Seller Invite. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-invite-seller-lead
      description: VTex Invite Seller Lead
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: marketplace-seller-invite.createsellerlead
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-list-seller-leads
      description: VTex List Seller Leads
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-seller-invite.listsellerleads
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-accept-seller-lead
      description: VTex Accept Seller Lead
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: marketplace-seller-invite.acceptsellerlead
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-seller-lead-s-data
      description: VTex Get Seller Lead's Data by Id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-seller-invite.retrievesellerlead
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-seller-lead
      description: VTex Delete Seller Lead
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: marketplace-seller-invite.removesellerlead
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-create-seller-lead
      description: VTex Create Seller From Lead
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: marketplace-seller-invite.createsellerfromsellerlead
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-resend-seller-lead-invite
      description: VTex Resend Seller Lead Invite
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: marketplace-seller-invite.resendsellerleadrequest
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.