naftiko: 1.0.0-alpha2
info:
  label: TikTok Shop API — Orders
  description: 'TikTok Shop API — Orders. 2 operations. Lead operation: List Orders. Self-contained Naftiko capability covering
    one Tiktok business surface.'
  tags:
  - Tiktok
  - Orders
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TIKTOK_API_KEY: TIKTOK_API_KEY
capability:
  consumes:
  - type: http
    namespace: shop-orders
    baseUri: https://open-api.tiktokglobalshop.com
    description: TikTok Shop API — Orders business capability. Self-contained, no shared references.
    resources:
    - name: order-202309-orders
      path: /order/202309/orders
      operations:
      - name: listorders
        method: GET
        description: List Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page_size
          in: query
          type: integer
        - name: page_token
          in: query
          type: string
        - name: order_status
          in: query
          type: string
          description: Filter by order status
        - name: create_time_ge
          in: query
          type: integer
          description: Filter orders created after this Unix timestamp
        - name: create_time_lt
          in: query
          type: integer
          description: Filter orders created before this Unix timestamp
    - name: order-202309-orders-order_id
      path: /order/202309/orders/{order_id}
      operations:
      - name: getorder
        method: GET
        description: Get Order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_id
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: x-tts-access-token
      value: '{{env.TIKTOK_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: shop-orders-rest
    port: 8080
    description: REST adapter for TikTok Shop API — Orders. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/order/202309/orders
      name: order-202309-orders
      description: REST surface for order-202309-orders.
      operations:
      - method: GET
        name: listorders
        description: List Orders
        call: shop-orders.listorders
        with:
          page_size: rest.page_size
          page_token: rest.page_token
          order_status: rest.order_status
          create_time_ge: rest.create_time_ge
          create_time_lt: rest.create_time_lt
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/order/202309/orders/{order-id}
      name: order-202309-orders-order-id
      description: REST surface for order-202309-orders-order_id.
      operations:
      - method: GET
        name: getorder
        description: Get Order
        call: shop-orders.getorder
        with:
          order_id: rest.order_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shop-orders-mcp
    port: 9090
    transport: http
    description: MCP adapter for TikTok Shop 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: shop-orders.listorders
      with:
        page_size: tools.page_size
        page_token: tools.page_token
        order_status: tools.order_status
        create_time_ge: tools.create_time_ge
        create_time_lt: tools.create_time_lt
      outputParameters:
      - type: object
        mapping: $.
    - name: get-order
      description: Get Order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shop-orders.getorder
      with:
        order_id: tools.order_id
      outputParameters:
      - type: object
        mapping: $.