Get progress rewards list
GET/v1/partnership/reports/progress-reward
List progress-reward compensation records, including the qualification period, tier movement, compensation amount, and commission percentages by account category. Use the compensation identifier to request its order-level calculation details.
Required scopes:
- read:
partnership.all:readorpartnership.all.
Runtime restrictions:
- The partner associated with the API key must be known to the progress-reward service. Otherwise, the operation returns
NotFound.
Rules:
- The response includes compensation records with a recorded payment status update, including rejected payments. The presence of a record or payment_date does not confirm a successful payout.
- Records are returned in descending payment-date order. This operation does not support pagination or filters.
Rate limits:
- This operation counts toward the shared limit of 600 requests per 60 seconds per partner, across all of the partner's API keys and all Partnership API operations.
Consistency and recovery notes:
- This read operation can be retried. Results may change as report data is updated. Keep the same filters and ordering when reading additional pages, where pagination is supported.
Possible errors:
ThrottledServiceTransportErrorErrorAuthenticationFailedPermissionDeniedValidationErrorNotFound
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
- 502
- 503
- 504
Successful response.
Bad request or validation error. The response uses either the numeric request-processing error response or the Partnership string-code error response.
Authentication failed. Authentication processing errors use numeric codes; a Partnership operation authentication error uses a string code.
Operation is not permitted for the authenticated API key, partner, or operation scope.
Requested resource was not found or is not visible to the authenticated partner.
Rate limit exceeded.
Response Headers
Seconds to wait before retrying when the API provides a throttle wait time.
The API or a service required by the operation could not complete the request.
The API could not complete the request to the Partnership service.
A required service is temporarily unavailable or the request deadline was exceeded.
A service required by the Partnership operation could not be reached or timed out.