REreacherapp
Shop Report

Client-report snapshot: every report field, or why it is missing

Changed on

One call for a shop's client report over a window: Shop Performance Score, the six SPS health metrics, the shop's add-to-cart total, fulfillment risk (on-time dispatch, seller-fault cancellations, handling time, non-buyer-fault returns), and violations, account health and creator health. Every field has available; when false, unavailable_reason and detail say why (region, not synced, no data in the window, not collected yet, or a temporary read failure) and drill_down_tool names where the detail lives. Window: a preset (default 30d) or start_date/end_date, max 365 days. Single-shop only.

post/shop-report/snapshot

Request

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

Request body

presetstring nullable

Relative window ending at the shop's newest settled day: <n>d (1-999), <n>m (1-99) or all, always capped at 365 days. Mutually exclusive with explicit dates; defaults to 30d when neither is given.

start_datestring date nullable

Inclusive window start (YYYY-MM-DD).

end_datestring date nullable

Inclusive window end (YYYY-MM-DD).

Response

Successful Response

shop_idinteger required
regionstring nullable

The shop's market; null when it could not be read.

start_datestring required
end_datestring required

Changes

  • ae1fba149199Revision changes
    • 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 the optional property / to the response with the status

  • c97a73893555Revision changes
    • info

      added the optional property / to the response with the status