REreacherapp
Affiliate Orders

Affiliate order lines: creator, content and commission per order

Changed on

One row per order x SKU from Affiliate Center -> Orders: which creator drove it, through which content (video / LIVE / showcase), under which commission model and rates, and the estimated vs actual commission side by side. Filter by an order-created date window, creator handle, content ID or type, product, SKU, order status or settled state — the same filters as the Affiliate Center UI. Estimated amounts are set when the order is created; actual amounts and commission_paid_at fill in as TikTok settles, typically weeks later, so recent windows keep moving — read data_status for freshness. Defaults to the last 30 complete days.

post/affiliate/transactions

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/affiliate/transactions
  • 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 on the order CREATED date (YYYY-MM-DD), in the shop's Affiliate Center timezone. Defaults to 30 days before end_date.

end_datestring date nullable

Inclusive window end (YYYY-MM-DD). Defaults to yesterday — the current day is still accumulating.

creator_handlestring nullable

Filter to one creator by TikTok username. A leading '@' is ignored; case-insensitive.

content_idstring nullable

Filter to the video, LIVE or showcase that drove the sale (TikTok content ID).

content_typestring nullable

Filter by content type, case-insensitive. Values TikTok ships: Video, Livestream, Showcase, Affiliate Product Page.

product_idstring nullable

Filter to one product.

sku_idstring nullable

Filter to one SKU.

order_statusstring nullable

Filter by TikTok's own commission status, case-insensitive. Values seen: Pending, Settled, Ineligible, Awaiting payment.

settledboolean nullable

True = only lines whose commission has settled, False = everything else (pending, ineligible, awaiting payment). Unsettled amounts still move.

limitinteger

Page size.

offsetinteger

Page offset. Capped at 100,000: deeper pages still scan and sort everything before them, so narrow the date window instead.

Response

Successful Response

shop_idinteger required
seller_idstring required
start_datestring required

Resolved inclusive window start (order-created date).

end_datestring required

Resolved inclusive window end.

totalinteger required
limitinteger required
offsetinteger required

Changes

  • 8a05d3dfc50aRevision changes
    • warning

      added the new awaiting_first_export enum value to the // response property for the response status

    • warning

      added the new not_enabled enum value to the // response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      removed the no_permission enum value from the // response property for the response status

  • 291230805105Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the / response's property type changed from string to no type for 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 subschema #2 to the / response property anyOf list for the response status

    • info

      response property total deprecated

    • info

      response property transactions deprecated