VTEX · Capability

VTex Catalog API — Gift List

VTex Catalog API — Gift List. 1 operations. Lead operation: VTex Get Gift list. Self-contained Naftiko capability covering one Vtex business surface.

Run with Naftiko VtexGift List

What You Can Do

GET
Getgiftlist — VTex Get Gift list
/v1/api/addon/pvt/giftlist/get/{listid}

MCP Tools

vtex-get-gift-list

VTex Get Gift list

read-only idempotent

Capability Spec

catalog-gift-list.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: VTex Catalog API — Gift List
  description: 'VTex Catalog API — Gift List. 1 operations. Lead operation: VTex Get Gift list. Self-contained Naftiko capability
    covering one Vtex business surface.'
  tags:
  - Vtex
  - Gift List
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: catalog-gift-list
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Catalog API — Gift List business capability. Self-contained, no shared references.
    resources:
    - name: api-addon-pvt-giftlist-get-listId
      path: /api/addon/pvt/giftlist/get/{listId}
      operations:
      - name: getgiftlist
        method: GET
        description: VTex Get Gift list
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: listId
          in: path
          type: integer
          description: Gift list unique numerical identifier.
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: catalog-gift-list-rest
    port: 8080
    description: REST adapter for VTex Catalog API — Gift List. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/addon/pvt/giftlist/get/{listid}
      name: api-addon-pvt-giftlist-get-listid
      description: REST surface for api-addon-pvt-giftlist-get-listId.
      operations:
      - method: GET
        name: getgiftlist
        description: VTex Get Gift list
        call: catalog-gift-list.getgiftlist
        with:
          listId: rest.listId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-gift-list-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Catalog API — Gift List. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: vtex-get-gift-list
      description: VTex Get Gift list
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-gift-list.getgiftlist
      with:
        listId: tools.listId
      outputParameters:
      - type: object
        mapping: $.