> ## 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. # Creator promotion details > Returns one creator's results in one target collaboration, per product: commission rates (`targetRateBps`, `openRateBps` and the ads rates, in 1/10000ths, so 2200 = 22%), whether the creator added the product to their showcase, and how many promo videos and LIVEs they made for it. Rows also carry `title`, `imageUrl`, `price`, `promotionPrice` and `productStatusCode` (1 active, 2 sold out, 3 deactivated by seller, 4 deactivated by platform, 5 rejected, 6 deleted). `creatorOpenId` is required and `invitationId` is optional. Narrow to one product with `query` plus `queryType` (`PRODUCT_ID` or `PRODUCT_NAME`), and filter by showcase status with `addedType` (`ALL`, `ADDED` or `NOT_ADDED`). Not paged. Read live from TikTok, so the shop has to be connected through TikTok's official API. ## OpenAPI ````yaml api-reference/tik-tok-shop-openapi.json GET /tik_tok_shop/target_collabs/{collaborationId}/promotion_details 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/target_collabs/{collaborationId}/promotion_details: get: summary: Creator promotion details description: >- Returns one creator's results in one target collaboration, per product: commission rates (`targetRateBps`, `openRateBps` and the ads rates, in 1/10000ths, so 2200 = 22%), whether the creator added the product to their showcase, and how many promo videos and LIVEs they made for it. Rows also carry `title`, `imageUrl`, `price`, `promotionPrice` and `productStatusCode` (1 active, 2 sold out, 3 deactivated by seller, 4 deactivated by platform, 5 rejected, 6 deleted). `creatorOpenId` is required and `invitationId` is optional. Narrow to one product with `query` plus `queryType` (`PRODUCT_ID` or `PRODUCT_NAME`), and filter by showcase status with `addedType` (`ALL`, `ADDED` or `NOT_ADDED`). Not paged. Read live from TikTok, so the shop has to be connected through TikTok's official API. parameters: - name: collaborationId in: path required: true schema: type: string description: >- Target collaboration id, sent as invitation_group_id. INFERRED (not yet probed) to be the same id: TikTok's web surface uses it that way. - name: creatorOpenId in: query required: true schema: type: string description: The creator's TikTok open id. - name: invitationId in: query required: false schema: type: string description: The creator's invitation id inside the collab, when known. Optional. - name: query in: query required: false schema: type: string description: Narrow to one product by id or by name. Requires queryType. - name: queryType in: query required: false schema: type: string enum: - PRODUCT_ID - PRODUCT_NAME description: What `query` matches. Requires query. - name: addedType in: query required: false schema: type: string enum: - ALL - ADDED - NOT_ADDED description: >- ADDED = only products the creator added to their showcase, NOT_ADDED = the rest. - 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: Per-product results content: application/json: schema: type: object required: - products properties: products: type: array items: type: object properties: productId: type: string nullable: true title: type: string nullable: true imageUrl: type: string nullable: true price: type: object nullable: true properties: min: type: object nullable: true properties: amount: type: string nullable: true currency: type: string nullable: true max: type: object nullable: true properties: amount: type: string nullable: true currency: type: string nullable: true promotionPrice: type: object nullable: true properties: min: type: object nullable: true properties: amount: type: string nullable: true currency: type: string nullable: true max: type: object nullable: true properties: amount: type: string nullable: true currency: type: string nullable: true productStatusCode: type: string nullable: true description: >- TikTok's product status: 1 active, 2 sold out, 3 deactivated by seller, 4 deactivated by platform, 5 rejected, 6 deleted. commission: type: object description: 'Rates in 1/10000ths: 2200 = 22%.' properties: targetRateBps: type: integer nullable: true description: This collab's commission. openRateBps: type: integer nullable: true description: The product's open collaboration commission. targetAdsRateBps: type: integer nullable: true description: This collab's ads commission. previousTargetRateBps: type: integer nullable: true description: The collab commission before the last change. previousTargetAdsRateBps: type: integer nullable: true description: The ads commission before the last change. effectiveAtMs: type: integer nullable: true description: >- When the commission took effect, epoch MILLISECONDS. adsEffectiveAtMs: type: integer nullable: true description: >- When the ads commission took effect, epoch MILLISECONDS. isCommissionEffective: type: boolean nullable: true addedToShowcase: type: boolean nullable: true description: The creator added this product to their showcase. videoCount: type: integer nullable: true description: >- Promo videos the creator posted for it in this collab. liveCount: type: integer nullable: true description: LIVEs the creator did for it in this collab. example: products: - productId: '1729000000000000001' title: Vitamin C serum imageUrl: https://p16-oec-va.ibyteimg.com/example.image price: min: amount: '24.99' currency: USD max: amount: '24.99' currency: USD promotionPrice: null productStatusCode: '1' commission: targetRateBps: 2200 openRateBps: 1000 targetAdsRateBps: null previousTargetRateBps: null previousTargetAdsRateBps: null effectiveAtMs: 1756684800000 adsEffectiveAtMs: null isCommissionEffective: true addedToShowcase: true videoCount: 2 liveCount: 1 '400': description: >- Missing creatorOpenId, an unknown queryType or addedType, or query without queryType (or the reverse) 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.