VTex Orders API — Invoice

naftiko: 1.0.0-alpha2
info:
  label: VTex Orders API — Invoice
  description: 'VTex Orders API — Invoice. 2 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-invoice
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Orders API — Invoice business capability. Self-contained, no shared references.
    resources:
    - name: api-oms-pvt-orders-orderId-invoice
      path: /api/oms/pvt/orders/{orderId}/invoice
      operations:
      - name: invoicenotification
        method: POST
        description: VTex Order invoice notification
        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: orderId
          in: path
          type: string
          description: Unique code that identifies the order whose invoice is being sent.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-oms-pvt-orders-orderId-invoice-invoiceNumber
      path: /api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}
      operations:
      - name: updatepartialinvoicesendtrackingnumber
        method: PATCH
        description: VTex Update order's partial invoice (send tracking number)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          description: Type of the content being sent.
          required: true
        - name: Accept
          in: header
          type: string
          description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
          required: true
        - name: orderId
          in: path
          type: string
          description: Unique code that identifies the order whose invoice is being sent.
          required: true
        - name: invoiceNumber
          in: path
          type: string
          description: Number that identifies the invoice.
          required: true
        - 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-invoice-rest
    port: 8080
    description: REST adapter for VTex Orders API — Invoice. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/oms/pvt/orders/{orderid}/invoice
      name: api-oms-pvt-orders-orderid-invoice
      description: REST surface for api-oms-pvt-orders-orderId-invoice.
      operations:
      - method: POST
        name: invoicenotification
        description: VTex Order invoice notification
        call: orders-invoice.invoicenotification
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          orderId: rest.orderId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/oms/pvt/orders/{orderid}/invoice/{invoicenumber}
      name: api-oms-pvt-orders-orderid-invoice-invoicenumber
      description: REST surface for api-oms-pvt-orders-orderId-invoice-invoiceNumber.
      operations:
      - method: PATCH
        name: updatepartialinvoicesendtrackingnumber
        description: VTex Update order's partial invoice (send tracking number)
        call: orders-invoice.updatepartialinvoicesendtrackingnumber
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          orderId: rest.orderId
          invoiceNumber: rest.invoiceNumber
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: orders-invoice-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Orders API — 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-invoice.invoicenotification
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        orderId: tools.orderId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-update-order-s-partial-invoice
      description: VTex Update order's partial invoice (send tracking number)
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: orders-invoice.updatepartialinvoicesendtrackingnumber
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        orderId: tools.orderId
        invoiceNumber: tools.invoiceNumber
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.