GMV Max

Product-level GMV Max window totals + GMV Max Ads overview

Changed on

Per-product window totals for one shop, plus an account-level overview — the Seller Center GMV Max Ads overview card (total cost, SKU orders, cost per order, gross revenue, ROI).

Products carry per-product cost + GMV + SKU orders (SUMmed over the window) with cost_per_order and roi recomputed from the summed bases, and the owning campaign's name / status / budget / target ROI (= ROAS bid) joined in. Sorted by cost descending.

Overview is derived from the same per-product sums, so it reconciles with the product rows. (Note: product-level cost can differ slightly from the campaign-metrics cost — TikTok attributes them differently; CORE-4486.)

Single-shop only. Same window defaults/caps as the timeseries endpoint. Optionally filter to a single campaign_id.

post/gmv-max/products/summary

Request

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

Request body

start_datestring date nullable

Inclusive window start (YYYY-MM-DD). Defaults to 29 days before end_date.

end_datestring date nullable

Inclusive window end (YYYY-MM-DD). Defaults to yesterday.

campaign_idstring nullable

Restrict to a single GMV Max campaign.

Response

Successful Response

shop_idinteger required
currencystring required

ISO currency code for the shop's region.

start_datestring required
end_datestring required

Changes

    • info

      api operation id gmv_max_products_summary_gmv_max_products_summary_post removed and replaced with gmv_max_products_summary

    • 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

      response property overview/cost deprecated

    • info

      response property overview/roi deprecated

    • info

      response property products/items/cost deprecated

    • info

      response property products/items/roi deprecated

    • info

      response property products/items/target_roi deprecated