VTex Orders API - PII data architecture — Invoice

naftiko: 1.0.0-alpha2
info:
  label: VTex Orders API - PII data architecture — Invoice
  description: 'VTex Orders API - PII data architecture — Invoice. 1 operations. Lead operation: VTex Order invoice notification.
    Self-contained Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Invoice
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: orders-pii-invoice
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Orders API - PII data architecture — Invoice business capability. Self-contained, no shared references.
    resources:
    - name: api-orders-pvt-document-orderId-invoices
      path: /api/orders/pvt/document/{orderId}/invoices
      operations:
      - name: invoicenotification2
        method: POST
        description: VTex Order invoice notification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: orders-pii-invoice-rest
    port: 8080
    description: REST adapter for VTex Orders API - PII data architecture — Invoice. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/api/orders/pvt/document/{orderid}/invoices
      name: api-orders-pvt-document-orderid-invoices
      description: REST surface for api-orders-pvt-document-orderId-invoices.
      operations:
      - method: POST
        name: invoicenotification2
        description: VTex Order invoice notification
        call: orders-pii-invoice.invoicenotification2
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: orders-pii-invoice-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Orders API - PII data architecture — Invoice. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: vtex-order-invoice-notification
      description: VTex Order invoice notification
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: orders-pii-invoice.invoicenotification2
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.