GMV Max

GMV Max campaign settings (normalized)

Changed on

The campaign's current settings, normalized from TikTok's raw campaign/gmv_max/info payload into a stable snake_case object: status, target_roas, daily_budget, schedule window, auto_budget_enabled, product_selection, roi_protection_enabled, affiliate_posts_enabled, and placements. Settings TikTok did not report are null. Single shop only — set x-shop-id to the campaign's owning shop. 404 if the campaign is not found in this shop.

source=synced (default) reads Reacher's last sync, which can be a few hours old. source=live reads the campaign from TikTok on this request — use it to confirm a change (e.g. a new target ROAS) took effect.

get/gmv-max/campaigns/{campaign_id}/settings

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/gmv-max/campaigns/{campaign_id}/settings
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Path parameters

campaign_idstring required

Query parameters

source'synced' | 'live'

synced = Reacher's last sync; live = read from TikTok now.

Response

Successful Response

currencystring required

ISO currency code for the shop's region.

source'synced' | 'live'

synced reads Reacher's last sync (refreshed every few hours); live was fetched from TikTok on this request.

fetched_atstring nullable

When the live settings were read from TikTok.

Changes

    • info

      added the new optional query request parameter source

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      endpoint added