POST

Query Marketplace Payouts


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 100 marketplace payouts, given the provided paging, filtering, and sorting.

Query Marketplace Payouts runs with these defaults, which you can override:

  • createdDate is sorted in DESC order
  • paging.limit is 100
  • paging.offset is 0

To learn about working with Query methods, see API Query Language, Sorting and Paging, and Field Projection.

PropertyFiltersSort
id$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithSort: ASC, DESC
createdDate$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteSort: ASC, DESC
transactionDate$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteSort: ASC, DESC
amount$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteSort: ASC, DESC
transactionAmount$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteSort: ASC, DESC
paymentSharePercent$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteSort: ASC, DESC
listing$existsSort: ASC, DESC
listing.id$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithSort: ASC, DESC
listing.type$eq, $ne, $in, $existsSort: ASC, DESC
invoiceId$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithSort: ASC, DESC
Authentication

You can only call this method when authenticated as a Wix user or by using an account level API key.

Permissions
SCOPE.PARTNERS.REVSHARE
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/partners/marketplace/v1/marketplace-payouts/query

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?