VTex Orders API — User Orders

naftiko: 1.0.0-alpha2
info:
  label: VTex Orders API — User Orders
  description: 'VTex Orders API — User Orders. 2 operations. Lead operation: VTex Retrieve user''s orders. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - User 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-user-orders
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Orders API — User Orders business capability. Self-contained, no shared references.
    resources:
    - name: api-oms-user-orders
      path: /api/oms/user/orders
      operations:
      - name: userorderslist
        method: GET
        description: VTex Retrieve user's orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: clientEmail
          in: query
          type: string
          description: Customer email.
          required: true
        - name: page
          in: query
          type: string
          description: Page number for result pagination.
          required: true
        - name: per_page
          in: query
          type: string
          description: Page quantity for result pagination.
          required: true
        - 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: api-oms-user-orders-orderId
      path: /api/oms/user/orders/{orderId}
      operations:
      - name: userorderdetails
        method: GET
        description: VTex Retrieve user order details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: clientEmail
          in: query
          type: string
          description: Customer email.
          required: true
        - 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: Order ID is a unique code that identifies an order.
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: orders-user-orders-rest
    port: 8080
    description: REST adapter for VTex Orders API — User Orders. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/oms/user/orders
      name: api-oms-user-orders
      description: REST surface for api-oms-user-orders.
      operations:
      - method: GET
        name: userorderslist
        description: VTex Retrieve user's orders
        call: orders-user-orders.userorderslist
        with:
          clientEmail: rest.clientEmail
          page: rest.page
          per_page: rest.per_page
          Content-Type: rest.Content-Type
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/oms/user/orders/{orderid}
      name: api-oms-user-orders-orderid
      description: REST surface for api-oms-user-orders-orderId.
      operations:
      - method: GET
        name: userorderdetails
        description: VTex Retrieve user order details
        call: orders-user-orders.userorderdetails
        with:
          clientEmail: rest.clientEmail
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          orderId: rest.orderId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: orders-user-orders-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Orders API — User Orders. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: vtex-retrieve-user-s-orders
      description: VTex Retrieve user's orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: orders-user-orders.userorderslist
      with:
        clientEmail: tools.clientEmail
        page: tools.page
        per_page: tools.per_page
        Content-Type: tools.Content-Type
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-retrieve-user-order-details
      description: VTex Retrieve user order details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: orders-user-orders.userorderdetails
      with:
        clientEmail: tools.clientEmail
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        orderId: tools.orderId
      outputParameters:
      - type: object
        mapping: $.