VTex Marketplace API — Sales Channel Mapping

naftiko: 1.0.0-alpha2
info:
  label: VTex Marketplace API — Sales Channel Mapping
  description: 'VTex Marketplace API — Sales Channel Mapping. 2 operations. Lead operation: VTex Upsert Sales Channel Mapping.
    Self-contained Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Sales Channel Mapping
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: marketplace-sales-channel-mapping
    baseUri: https://{accountName}.{environment}.com.br/api
    description: VTex Marketplace API — Sales Channel Mapping business capability. Self-contained, no shared references.
    resources:
    - name: seller-register-pvt-sellers-sellerId-sales-channel-mapping
      path: /seller-register/pvt/sellers/{sellerId}/sales-channel/mapping
      operations:
      - name: upsertmapping
        method: PUT
        description: VTex Upsert Sales Channel Mapping
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: retrievemapping
        method: GET
        description: VTex Get Sales Channel Mapping Data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: marketplace-sales-channel-mapping-rest
    port: 8080
    description: REST adapter for VTex Marketplace API — Sales Channel Mapping. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/seller-register/pvt/sellers/{sellerid}/sales-channel/mapping
      name: seller-register-pvt-sellers-sellerid-sales-channel-mapping
      description: REST surface for seller-register-pvt-sellers-sellerId-sales-channel-mapping.
      operations:
      - method: PUT
        name: upsertmapping
        description: VTex Upsert Sales Channel Mapping
        call: marketplace-sales-channel-mapping.upsertmapping
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: retrievemapping
        description: VTex Get Sales Channel Mapping Data
        call: marketplace-sales-channel-mapping.retrievemapping
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: marketplace-sales-channel-mapping-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Marketplace API — Sales Channel Mapping. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: vtex-upsert-sales-channel-mapping
      description: VTex Upsert Sales Channel Mapping
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: marketplace-sales-channel-mapping.upsertmapping
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-sales-channel-mapping
      description: VTex Get Sales Channel Mapping Data
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-sales-channel-mapping.retrievemapping
      outputParameters:
      - type: object
        mapping: $.