VTex Orders API — Order Hook

naftiko: 1.0.0-alpha2
info:
  label: VTex Orders API — Order Hook
  description: 'VTex Orders API — Order Hook. 3 operations. Lead operation: VTex Get hook configuration. Self-contained Naftiko
    capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Order Hook
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: orders-order-hook
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Orders API — Order Hook business capability. Self-contained, no shared references.
    resources:
    - name: api-orders-hook-config
      path: /api/orders/hook/config
      operations:
      - name: gethookconfiguration
        method: GET
        description: VTex Get hook configuration
        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: clientEmail
          in: query
          type: string
          description: Customer email.
        - name: page
          in: query
          type: string
          description: Page number for result pagination.
        - name: per_page
          in: query
          type: string
          description: Page quantity for result pagination.
      - name: hookconfiguration
        method: POST
        description: VTex Create or update hook configuration
        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: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletehookconfiguration
        method: DELETE
        description: VTex Delete hook configuration
        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: Type of the content being sent.
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: orders-order-hook-rest
    port: 8080
    description: REST adapter for VTex Orders API — Order Hook. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/orders/hook/config
      name: api-orders-hook-config
      description: REST surface for api-orders-hook-config.
      operations:
      - method: GET
        name: gethookconfiguration
        description: VTex Get hook configuration
        call: orders-order-hook.gethookconfiguration
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          clientEmail: rest.clientEmail
          page: rest.page
          per_page: rest.per_page
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: hookconfiguration
        description: VTex Create or update hook configuration
        call: orders-order-hook.hookconfiguration
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletehookconfiguration
        description: VTex Delete hook configuration
        call: orders-order-hook.deletehookconfiguration
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: orders-order-hook-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Orders API — Order Hook. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: vtex-get-hook-configuration
      description: VTex Get hook configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: orders-order-hook.gethookconfiguration
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        clientEmail: tools.clientEmail
        page: tools.page
        per_page: tools.per_page
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-create-update-hook-configuration
      description: VTex Create or update hook configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: orders-order-hook.hookconfiguration
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-hook-configuration
      description: VTex Delete hook configuration
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: orders-order-hook.deletehookconfiguration
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
      outputParameters:
      - type: object
        mapping: $.