REreacherapp
P&L

Settlement adjustments

Changed on

Credits, clawbacks and manual corrections TikTok posts against a statement rather than an order. They never appear on order rows, so a P&L built only from /pnl/orders silently omits them — net_amount is the figure to carry across.

Windowed on the date TikTok raised the adjustment. settled_date is null until it reaches a payout.

post/pnl/adjustments

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/pnl/adjustments
  • 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).

end_datestring date nullable

Inclusive window end (YYYY-MM-DD).

limitinteger

Page size.

offsetinteger

Page offset.

Response

Successful Response

shop_idinteger required
seller_idstring required
totalinteger required
limitinteger required
offsetinteger required
net_amountnumber required

Sum of every adjustment matching the window, before paging — the number to carry into a P&L, since these never appear on order rows.

Changes

  • 291230805105Revision changes
    • 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 subschema #1 subschema #2 to the / response property anyOf list for the response status

    • info

      response property total deprecated