TikTok Shop API — Products

naftiko: 1.0.0-alpha2
info:
  label: TikTok Shop API — Products
  description: 'TikTok Shop API — Products. 4 operations. Lead operation: List Products. Self-contained Naftiko capability
    covering one Tiktok business surface.'
  tags:
  - Tiktok
  - Products
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TIKTOK_API_KEY: TIKTOK_API_KEY
capability:
  consumes:
  - type: http
    namespace: shop-products
    baseUri: https://open-api.tiktokglobalshop.com
    description: TikTok Shop API — Products business capability. Self-contained, no shared references.
    resources:
    - name: product-202309-products
      path: /product/202309/products
      operations:
      - name: listproducts
        method: GET
        description: List Products
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page_size
          in: query
          type: integer
          description: Number of products per page
        - name: page_token
          in: query
          type: string
          description: Pagination token for next page
        - name: status
          in: query
          type: string
          description: Filter by product status
    - name: product-202309-products-upload_files
      path: /product/202309/products/upload_files
      operations:
      - name: uploadproductfile
        method: POST
        description: Upload Product File
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: product-202309-products-product_id
      path: /product/202309/products/{product_id}
      operations:
      - name: getproduct
        method: GET
        description: Get Product
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: product_id
          in: path
          type: string
          description: Product unique identifier
          required: true
      - name: updateproduct
        method: PUT
        description: Update Product
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: product_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: x-tts-access-token
      value: '{{env.TIKTOK_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: shop-products-rest
    port: 8080
    description: REST adapter for TikTok Shop API — Products. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/product/202309/products
      name: product-202309-products
      description: REST surface for product-202309-products.
      operations:
      - method: GET
        name: listproducts
        description: List Products
        call: shop-products.listproducts
        with:
          page_size: rest.page_size
          page_token: rest.page_token
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/product/202309/products/upload-files
      name: product-202309-products-upload-files
      description: REST surface for product-202309-products-upload_files.
      operations:
      - method: POST
        name: uploadproductfile
        description: Upload Product File
        call: shop-products.uploadproductfile
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/product/202309/products/{product-id}
      name: product-202309-products-product-id
      description: REST surface for product-202309-products-product_id.
      operations:
      - method: GET
        name: getproduct
        description: Get Product
        call: shop-products.getproduct
        with:
          product_id: rest.product_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateproduct
        description: Update Product
        call: shop-products.updateproduct
        with:
          product_id: rest.product_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shop-products-mcp
    port: 9090
    transport: http
    description: MCP adapter for TikTok Shop API — Products. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-products
      description: List Products
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shop-products.listproducts
      with:
        page_size: tools.page_size
        page_token: tools.page_token
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: upload-product-file
      description: Upload Product File
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shop-products.uploadproductfile
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-product
      description: Get Product
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shop-products.getproduct
      with:
        product_id: tools.product_id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-product
      description: Update Product
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: shop-products.updateproduct
      with:
        product_id: tools.product_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.