> ## Documentation Index
> Fetch the complete documentation index at: https://growi.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Unsettled transactions

> Lists orders and adjustments that TikTok hasn't settled yet, created on or after 2025-01-01. Every amount is TikTok's estimate and can change before settlement. Final numbers only come from the statement endpoints.

The response has `totalCount`, the sums `sumEstSettlementAmount`, `sumEstRevenueAmount`, `sumEstAdjustmentAmount` and `sumEstFeeAmount`, and `currency` (set only when every row on the page shares one). Each row has `type`, `orderId`, `orderCreateTime`, `orderDeliveryTime`, `unsettledReason`, the `est*` amounts with breakdown maps, and `estimatedSettlement`: a text rule such as days after delivery before the order is delivered, then a Unix-seconds string. Filter on order create time with `search_time_ge` (inclusive) and `search_time_lt` (exclusive), in Unix seconds. Newest first by default. `page_size` is 1 to 100; pass `nextPageToken` back as `page_token`. Read live from TikTok.



## OpenAPI

````yaml api-reference/tik-tok-shop-openapi.json GET /tik_tok_shop/finance/unsettled
openapi: 3.0.3
info:
  title: 'Growi API: TikTok Shop'
  version: 1.0.0
  description: >-
    Generated by scripts/gen_tik_tok_shop.rb from Growi's TikTok Shop route
    table.
servers:
  - url: https://api.growi.io/api/public/v1
security:
  - bearerAuth: []
paths:
  /tik_tok_shop/finance/unsettled:
    get:
      summary: Unsettled transactions
      description: >-
        Lists orders and adjustments that TikTok hasn't settled yet, created on
        or after 2025-01-01. Every amount is TikTok's estimate and can change
        before settlement. Final numbers only come from the statement endpoints.


        The response has `totalCount`, the sums `sumEstSettlementAmount`,
        `sumEstRevenueAmount`, `sumEstAdjustmentAmount` and `sumEstFeeAmount`,
        and `currency` (set only when every row on the page shares one). Each
        row has `type`, `orderId`, `orderCreateTime`, `orderDeliveryTime`,
        `unsettledReason`, the `est*` amounts with breakdown maps, and
        `estimatedSettlement`: a text rule such as days after delivery before
        the order is delivered, then a Unix-seconds string. Filter on order
        create time with `search_time_ge` (inclusive) and `search_time_lt`
        (exclusive), in Unix seconds. Newest first by default. `page_size` is 1
        to 100; pass `nextPageToken` back as `page_token`. Read live from
        TikTok.
      parameters:
        - name: search_time_ge
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 9999999999
          description: Unix seconds, inclusive lower bound on order create time.
        - name: search_time_lt
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 9999999999
          description: Unix seconds, exclusive upper bound. Must be after search_time_ge.
        - name: sort_order
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
            default: DESC
          description: DESC (newest first) unless set. TikTok's own default is ASC.
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
          description: Rows per page, 1 to 100. TikTok's default is 20.
        - name: page_token
          in: query
          required: false
          schema:
            type: string
          description: The nextPageToken from the previous page. Omit on the first page.
        - name: organization_id
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Use the TikTok Shop of this child brand (organization id) of your
            API key's organization
      responses:
        '200':
          description: >-
            { totalCount, currency, sumEstSettlementAmount, sumEstRevenueAmount,
            sumEstAdjustmentAmount, sumEstFeeAmount, transactions: [...],
            nextPageToken }
          content:
            application/json:
              example:
                totalCount: 31
                currency: USD
                sumEstSettlementAmount: 540.2
                sumEstRevenueAmount: 702.5
                sumEstAdjustmentAmount: 0
                sumEstFeeAmount: -162.3
                transactions:
                  - id: '7442000000000000001'
                    type: ORDER
                    status: UNSETTLED
                    currency: USD
                    estimatedSettlement: '1759363200'
                    unsettledReason: null
                    orderId: '576000000000000002'
                    orderCreateTime: 1758650000
                    orderDeliveryTime: 1758900000
                    adjustmentId: null
                    adjustmentOrderId: null
                    estAdjustmentAmount: null
                    estSettlementAmount: 17.49
                    estRevenueAmount: 24.99
                    revenueBreakdown:
                      subtotalBeforeDiscountAmount: 24.99
                    estShippingCostAmount: 0
                    shippingCostBreakdown: {}
                    estFeeTaxAmount: -7.5
                    feeTaxBreakdown:
                      fee:
                        affiliateCommissionAmount: -3.75
                        referralFeeAmount: -2
                        transactionFeeAmount: -1.75
                      tax: {}
                nextPageToken: b2Zmc2V0PTIw
        '400':
          description: >-
            Invalid params: a bad window, unknown sort_order, page_size out of
            range
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '403':
          description: >-
            The shop's TikTok authorization doesn't include this data (`code:
            scope_not_granted`), so the seller has to re-authorize the shop
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '404':
          description: >-
            `organization_id` isn't an active child brand of your organization,
            or the record you asked for doesn't exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '422':
          description: >-
            No TikTok Shop is connected for this organization. A parent
            organization whose shops sit on its child brands has to pass
            `organization_id`. Also returned when the shop isn't connected
            through TikTok's official API (`code: unsupported_on_web_only_shop`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '429':
          description: >-
            Rate limited: one call every 2 seconds and an hourly cap per API
            key. See `Retry-After` and the `X-RateLimit-*` headers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '502':
          description: >-
            TikTok refused or failed. `error` is a fixed message and `code`
            names the failure when there is one
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
components:
  schemas:
    TikTokShopError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: What went wrong
        code:
          type: string
          description: Machine-readable reason, when there is one
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.