REreacherapp
GMV Max

List GMV Max campaigns

Changed on

List all GMV Max (TikTok Smart+) campaigns for the shop(s) addressed by x-shop-id. Returns cached campaign metadata last synced from TikTok by the portal — call the portal's sync endpoints to refresh. Supports multi-shop (x-shop-id: all or comma-separated).

get/gmv-max/campaigns

Request

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

Query parameters

pageinteger
page_sizeinteger

Campaigns per page (default = max, above today's whole table); check pagination.total_pages for multi-shop keys.

Response

Successful Response

currencystring nullable

ISO currency code when a single shop was addressed; null for multi-shop lists (see each row's currency).

shops_queriedstring[] nullable

Shop names included when querying multiple shops (x-shop-id: all or comma-separated).

Changes

  • 291230805105Revision changes
    • info

      api operation id list_campaigns_gmv_max_campaigns_get removed and replaced with gmv_max_campaigns_list

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter page_size

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added subschema #1 to the // response property anyOf list for the response status

    • info

      added subschema #1 to the // response property anyOf list for the response status

    • info

      response property data/items/roas_bid deprecated