VTex Legacy Search API — Offers

naftiko: 1.0.0-alpha2
info:
  label: VTex Legacy Search API — Offers
  description: 'VTex Legacy Search API — Offers. 2 operations. Lead operation: VTex Search Product offers. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Offers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: legacy-search-offers
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Legacy Search API — Offers business capability. Self-contained, no shared references.
    resources:
    - name: api-catalog_system-pub-products-offers-productId
      path: /api/catalog_system/pub/products/offers/{productId}
      operations:
      - name: get
        method: GET
        description: VTex Search Product offers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - 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: productId
          in: path
          type: string
          description: Product unique number identifier.
          required: true
    - name: api-catalog_system-pub-products-offers-productId-sku-skuId
      path: /api/catalog_system/pub/products/offers/{productId}/sku/{skuId}
      operations:
      - name: get
        method: GET
        description: VTex Search SKU offers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - 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: productId
          in: path
          type: string
          description: Product unique number identifier.
          required: true
        - name: skuId
          in: path
          type: string
          description: Product unique number identifier.
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: legacy-search-offers-rest
    port: 8080
    description: REST adapter for VTex Legacy Search API — Offers. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/catalog-system/pub/products/offers/{productid}
      name: api-catalog-system-pub-products-offers-productid
      description: REST surface for api-catalog_system-pub-products-offers-productId.
      operations:
      - method: GET
        name: get
        description: VTex Search Product offers
        call: legacy-search-offers.get
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          productId: rest.productId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-system/pub/products/offers/{productid}/sku/{skuid}
      name: api-catalog-system-pub-products-offers-productid-sku-skuid
      description: REST surface for api-catalog_system-pub-products-offers-productId-sku-skuId.
      operations:
      - method: GET
        name: get
        description: VTex Search SKU offers
        call: legacy-search-offers.get
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          productId: rest.productId
          skuId: rest.skuId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: legacy-search-offers-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Legacy Search API — Offers. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: vtex-search-product-offers
      description: VTex Search Product offers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: legacy-search-offers.get
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        productId: tools.productId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-search-sku-offers
      description: VTex Search SKU offers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: legacy-search-offers.get
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        productId: tools.productId
        skuId: tools.skuId
      outputParameters:
      - type: object
        mapping: $.