VTex Marketplace API — Notification

naftiko: 1.0.0-alpha2
info:
  label: VTex Marketplace API — Notification
  description: 'VTex Marketplace API — Notification. 2 operations. Lead operation: VTex Notify marketplace of inventory update.
    Self-contained Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Notification
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: marketplace-notification
    baseUri: https://{accountName}.{environment}.com.br/api
    description: VTex Marketplace API — Notification business capability. Self-contained, no shared references.
    resources:
    - name: notificator-sellerId-changenotification-skuId-inventory
      path: /notificator/{sellerId}/changenotification/{skuId}/inventory
      operations:
      - name: inventorynotification
        method: POST
        description: VTex Notify marketplace of inventory update
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: notificator-sellerId-changenotification-skuId-price
      path: /notificator/{sellerId}/changenotification/{skuId}/price
      operations:
      - name: pricenotification
        method: POST
        description: VTex Notify marketplace of price update
        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-notification-rest
    port: 8080
    description: REST adapter for VTex Marketplace API — Notification. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/notificator/{sellerid}/changenotification/{skuid}/inventory
      name: notificator-sellerid-changenotification-skuid-inventory
      description: REST surface for notificator-sellerId-changenotification-skuId-inventory.
      operations:
      - method: POST
        name: inventorynotification
        description: VTex Notify marketplace of inventory update
        call: marketplace-notification.inventorynotification
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notificator/{sellerid}/changenotification/{skuid}/price
      name: notificator-sellerid-changenotification-skuid-price
      description: REST surface for notificator-sellerId-changenotification-skuId-price.
      operations:
      - method: POST
        name: pricenotification
        description: VTex Notify marketplace of price update
        call: marketplace-notification.pricenotification
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: marketplace-notification-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Marketplace API — Notification. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-notify-marketplace-inventory-update
      description: VTex Notify marketplace of inventory update
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: marketplace-notification.inventorynotification
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-notify-marketplace-price-update
      description: VTex Notify marketplace of price update
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: marketplace-notification.pricenotification
      outputParameters:
      - type: object
        mapping: $.