VTex Catalog API - Seller Portal — SKU

naftiko: 1.0.0-alpha2
info:
  label: VTex Catalog API - Seller Portal — SKU
  description: 'VTex Catalog API - Seller Portal — SKU. 2 operations. Lead operation: VTex Search for SKU. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - SKU
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: catalog-api-seller-portal-sku
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Catalog API - Seller Portal — SKU business capability. Self-contained, no shared references.
    resources:
    - name: api-catalog-seller-portal-skus-_search
      path: /api/catalog-seller-portal/skus/_search
      operations:
      - name: searchsku
        method: GET
        description: VTex Search for SKU
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: from
          in: query
          type: string
          description: The first page of the interval of the product list.
        - name: to
          in: query
          type: string
          description: The last page of the interval of the product list.
        - name: id
          in: query
          type: integer
          description: SKU unique idenfier number.
        - name: externalid
          in: query
          type: integer
          description: SKU reference unique identifier number in the store.
    - name: api-catalog-seller-portal-skus-ids
      path: /api/catalog-seller-portal/skus/ids
      operations:
      - name: listsku
        method: GET
        description: VTex Get List of SKUs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: from
          in: query
          type: string
          description: The first page of the interval of the product list.
        - name: to
          in: query
          type: string
          description: The last page of the interval of the product list.
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: catalog-api-seller-portal-sku-rest
    port: 8080
    description: REST adapter for VTex Catalog API - Seller Portal — SKU. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/catalog-seller-portal/skus/search
      name: api-catalog-seller-portal-skus-search
      description: REST surface for api-catalog-seller-portal-skus-_search.
      operations:
      - method: GET
        name: searchsku
        description: VTex Search for SKU
        call: catalog-api-seller-portal-sku.searchsku
        with:
          from: rest.from
          to: rest.to
          id: rest.id
          externalid: rest.externalid
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-seller-portal/skus/ids
      name: api-catalog-seller-portal-skus-ids
      description: REST surface for api-catalog-seller-portal-skus-ids.
      operations:
      - method: GET
        name: listsku
        description: VTex Get List of SKUs
        call: catalog-api-seller-portal-sku.listsku
        with:
          from: rest.from
          to: rest.to
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-api-seller-portal-sku-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Catalog API - Seller Portal — SKU. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-search-sku
      description: VTex Search for SKU
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-api-seller-portal-sku.searchsku
      with:
        from: tools.from
        to: tools.to
        id: tools.id
        externalid: tools.externalid
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-list-skus
      description: VTex Get List of SKUs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-api-seller-portal-sku.listsku
      with:
        from: tools.from
        to: tools.to
      outputParameters:
      - type: object
        mapping: $.