Shopify Admin REST API — Orders

naftiko: 1.0.0-alpha2
info:
  label: Shopify Admin REST API — Orders
  description: 'Shopify Admin REST API — Orders. 4 operations. Lead operation: List Orders. Self-contained Naftiko capability
    covering one Shopify Admin business surface.'
  tags:
  - Shopify Admin
  - Orders
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHOPIFY_ADMIN_API_KEY: SHOPIFY_ADMIN_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-orders
    baseUri: https://{store_name}.myshopify.com/admin/api/2024-10
    description: Shopify Admin REST API — Orders business capability. Self-contained, no shared references.
    resources:
    - name: orders.json
      path: /orders.json
      operations:
      - name: listorders
        method: GET
        description: List Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: The maximum number of results to show
        - name: status
          in: query
          type: string
          description: Filter orders by status
        - name: financial_status
          in: query
          type: string
          description: Filter orders by financial status
        - name: fulfillment_status
          in: query
          type: string
          description: Filter orders by fulfillment status
    - name: orders-order_id}.json
      path: /orders/{order_id}.json
      operations:
      - name: getorder
        method: GET
        description: Get Order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_id
          in: path
          type: integer
          description: The ID of the order
          required: true
      - name: updateorder
        method: PUT
        description: Update Order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_id
          in: path
          type: integer
          description: The ID of the order
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orders-order_id-cancel.json
      path: /orders/{order_id}/cancel.json
      operations:
      - name: cancelorder
        method: POST
        description: Cancel Order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_id
          in: path
          type: integer
          description: The ID of the order to cancel
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: X-Shopify-Access-Token
      value: '{{env.SHOPIFY_ADMIN_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: rest-orders-rest
    port: 8080
    description: REST adapter for Shopify Admin REST API — Orders. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/orders-json
      name: orders-json
      description: REST surface for orders.json.
      operations:
      - method: GET
        name: listorders
        description: List Orders
        call: rest-orders.listorders
        with:
          limit: rest.limit
          status: rest.status
          financial_status: rest.financial_status
          fulfillment_status: rest.fulfillment_status
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orders/order-id-json
      name: orders-order-id-json
      description: REST surface for orders-order_id}.json.
      operations:
      - method: GET
        name: getorder
        description: Get Order
        call: rest-orders.getorder
        with:
          order_id: rest.order_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateorder
        description: Update Order
        call: rest-orders.updateorder
        with:
          order_id: rest.order_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orders/{order-id}/cancel-json
      name: orders-order-id-cancel-json
      description: REST surface for orders-order_id-cancel.json.
      operations:
      - method: POST
        name: cancelorder
        description: Cancel Order
        call: rest-orders.cancelorder
        with:
          order_id: rest.order_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-orders-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shopify Admin REST API — Orders. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-orders
      description: List Orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-orders.listorders
      with:
        limit: tools.limit
        status: tools.status
        financial_status: tools.financial_status
        fulfillment_status: tools.fulfillment_status
      outputParameters:
      - type: object
        mapping: $.
    - name: get-order
      description: Get Order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-orders.getorder
      with:
        order_id: tools.order_id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-order
      description: Update Order
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-orders.updateorder
      with:
        order_id: tools.order_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-order
      description: Cancel Order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-orders.cancelorder
      with:
        order_id: tools.order_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.