VTex Catalog API — Sales Channel

naftiko: 1.0.0-alpha2
info:
  label: VTex Catalog API — Sales Channel
  description: 'VTex Catalog API — Sales Channel. 2 operations. Lead operation: VTex Get Sales channel by ID. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Sales Channel
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: catalog-sales-channel
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Catalog API — Sales Channel business capability. Self-contained, no shared references.
    resources:
    - name: api-catalog_system-pub-saleschannel-salesChannelId
      path: /api/catalog_system/pub/saleschannel/{salesChannelId}
      operations:
      - name: saleschannelbyid
        method: GET
        description: VTex Get Sales channel by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: salesChannelId
          in: path
          type: string
          required: true
    - name: api-catalog_system-pvt-saleschannel-list
      path: /api/catalog_system/pvt/saleschannel/list
      operations:
      - name: saleschannellist
        method: GET
        description: VTex Get Sales channel list
        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: catalog-sales-channel-rest
    port: 8080
    description: REST adapter for VTex Catalog API — Sales Channel. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/catalog-system/pub/saleschannel/{saleschannelid}
      name: api-catalog-system-pub-saleschannel-saleschannelid
      description: REST surface for api-catalog_system-pub-saleschannel-salesChannelId.
      operations:
      - method: GET
        name: saleschannelbyid
        description: VTex Get Sales channel by ID
        call: catalog-sales-channel.saleschannelbyid
        with:
          salesChannelId: rest.salesChannelId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-system/pvt/saleschannel/list
      name: api-catalog-system-pvt-saleschannel-list
      description: REST surface for api-catalog_system-pvt-saleschannel-list.
      operations:
      - method: GET
        name: saleschannellist
        description: VTex Get Sales channel list
        call: catalog-sales-channel.saleschannellist
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-sales-channel-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Catalog API — Sales Channel. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-get-sales-channel-id
      description: VTex Get Sales channel by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-sales-channel.saleschannelbyid
      with:
        salesChannelId: tools.salesChannelId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-sales-channel-list
      description: VTex Get Sales channel list
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-sales-channel.saleschannellist
      outputParameters:
      - type: object
        mapping: $.