VTex Orders API - PII data architecture — Orders

naftiko: 1.0.0-alpha2
info:
  label: VTex Orders API - PII data architecture — Orders
  description: 'VTex Orders API - PII data architecture — Orders. 4 operations. Lead operation: VTex List orders. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Orders
  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-orders
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Orders API - PII data architecture — Orders business capability. Self-contained, no shared references.
    resources:
    - name: api-orders-extendsearch-orders
      path: /api/orders/extendsearch/orders
      operations:
      - name: listorders2
        method: POST
        description: VTex List orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-orders-pvt-document-orderId
      path: /api/orders/pvt/document/{orderId}
      operations:
      - name: getorder2
        method: GET
        description: VTex Get order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-orders-pvt-document-orderId-actions-start-handling
      path: /api/orders/pvt/document/{orderId}/actions/start-handling
      operations:
      - name: starthandling2
        method: POST
        description: VTex Start handling order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-orders-pvt-document-orderId-cancel
      path: /api/orders/pvt/document/{orderId}/cancel
      operations:
      - name: cancelorder2
        method: POST
        description: VTex Cancel order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: orders-pii-orders-rest
    port: 8080
    description: REST adapter for VTex Orders API - PII data architecture — Orders. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/api/orders/extendsearch/orders
      name: api-orders-extendsearch-orders
      description: REST surface for api-orders-extendsearch-orders.
      operations:
      - method: POST
        name: listorders2
        description: VTex List orders
        call: orders-pii-orders.listorders2
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/orders/pvt/document/{orderid}
      name: api-orders-pvt-document-orderid
      description: REST surface for api-orders-pvt-document-orderId.
      operations:
      - method: GET
        name: getorder2
        description: VTex Get order
        call: orders-pii-orders.getorder2
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/orders/pvt/document/{orderid}/actions/start-handling
      name: api-orders-pvt-document-orderid-actions-start-handling
      description: REST surface for api-orders-pvt-document-orderId-actions-start-handling.
      operations:
      - method: POST
        name: starthandling2
        description: VTex Start handling order
        call: orders-pii-orders.starthandling2
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/orders/pvt/document/{orderid}/cancel
      name: api-orders-pvt-document-orderid-cancel
      description: REST surface for api-orders-pvt-document-orderId-cancel.
      operations:
      - method: POST
        name: cancelorder2
        description: VTex Cancel order
        call: orders-pii-orders.cancelorder2
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: orders-pii-orders-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Orders API - PII data architecture — Orders. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: vtex-list-orders
      description: VTex List orders
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: orders-pii-orders.listorders2
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-order
      description: VTex Get order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: orders-pii-orders.getorder2
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-start-handling-order
      description: VTex Start handling order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: orders-pii-orders.starthandling2
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-cancel-order
      description: VTex Cancel order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: orders-pii-orders.cancelorder2
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.