TikTok Shop

One creator's results in one target collaboration, per product

GET/api/public/v1/tik_tok_shop/target_collabs/{collaborationId}/promotion_details
ConnectorAnswers empty results in the documented shape until the brand switches on this connection.

Operation id getTikTokShopPromotionDetails

Request

curl

curl "https://creator.growthdept.ai/api/public/v1/tik_tok_shop/target_collabs/<collaborationId>/promotion_details?creatorOpenId=string" \
  -H "Authorization: Bearer gdc_..."

Parameters

NameInTypeNotes
collaborationIdpathstringrequired
creatorOpenIdquerystringrequired
invitationIdquerystring
queryquerystring
queryTypequerystringOne of PRODUCT_IDPRODUCT_NAME
addedTypequerystringOne of ALLADDEDNOT_ADDED
organization_idqueryinteger

Responses

200Success

FieldTypeNotes
productsarray of objectrequired
products[].[].addedToShowcaseboolean, nullable
products[].[].commissionobject
products[].[].commission.adsEffectiveAtMsinteger, nullable
products[].[].commission.effectiveAtMsinteger, nullable
products[].[].commission.openRateBpsinteger, nullable
products[].[].commission.previousTargetAdsRateBpsinteger, nullable
products[].[].commission.previousTargetRateBpsinteger, nullable
products[].[].commission.targetAdsRateBpsinteger, nullable
products[].[].commission.targetRateBpsinteger, nullable
products[].[].imageUrlstring, nullable
products[].[].isCommissionEffectiveboolean, nullable
products[].[].liveCountinteger, nullable
products[].[].priceobject, nullable
products[].[].price.maxobject, nullable
products[].[].price.max.amountstring, nullable
products[].[].price.max.currencystring, nullable
products[].[].price.minobject, nullable
products[].[].price.min.amountstring, nullable
products[].[].price.min.currencystring, nullable
products[].[].productIdstring, nullable
products[].[].productStatusCodestring, nullable
products[].[].promotionPriceobject, nullable
products[].[].promotionPrice.maxobject, nullable
products[].[].promotionPrice.max.amountstring, nullable
products[].[].promotionPrice.max.currencystring, nullable
products[].[].promotionPrice.minobject, nullable
products[].[].promotionPrice.min.amountstring, nullable
products[].[].promotionPrice.min.currencystring, nullable
products[].[].titlestring, nullable
products[].[].videoCountinteger, nullable

Example

{
  "products": [
    {
      "addedToShowcase": true,
      "commission": {
        "adsEffectiveAtMs": 3,
        "effectiveAtMs": 3,
        "openRateBps": 3,
        "previousTargetAdsRateBps": 3,
        "previousTargetRateBps": 3,
        "targetAdsRateBps": 3,
        "targetRateBps": 3
      },
      "imageUrl": "https://example.com/p/1",
      "isCommissionEffective": true,
      "liveCount": 3,
      "price": {
        "max": {
          "amount": "string",
          "currency": "usd"
        },
        "min": {
          "amount": "string",
          "currency": "usd"
        }
      },
      "productId": "string",
      "productStatusCode": "MAYA15",
      "promotionPrice": {
        "max": {
          "amount": "string",
          "currency": "usd"
        },
        "min": {
          "amount": "string",
          "currency": "usd"
        }
      },
      "title": "string",
      "videoCount": 3
    }
  ]
}

Errors: 400401403404422429502with an error and usually a message. See errors.

Example values are made up from each field's type and name.