P&L

Buyer-side payment breakdown

Changed on

What the CUSTOMER paid for each order x SKU, as opposed to what the seller earned: subtotal before and after discount, which party funded each discount, shipping, retail delivery fee and tax.

Paired to order lines on (order, SKU) to get a paid date, since this sheet carries none of its own. TikTok does not guarantee that pairing is 1:1, so a payment row with no matching order line falls outside the window rather than being invented into it.

post/pnl/customer-payments

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/pnl/customer-payments
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Request body

start_datestring date nullable

Inclusive paid-date window start.

end_datestring date nullable

Inclusive paid-date window end.

product_idstring nullable

Filter to one product.

sku_idstring nullable

Filter to one SKU.

limitinteger

Page size.

offsetinteger

Page offset.

Response

Successful Response

shop_idinteger required
seller_idstring required
totalinteger required
limitinteger required
offsetinteger required

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