POST

Query Order Payment Requests


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 1,000 order payment requests, given the provided paging, filtering, and sorting.

Query Order Payment Requests runs with these defaults, which you can override:

  • _createdDate is sorted in DESC order
  • cursorPaging.limit is 100

To learn about working with Query endpoints, see API Query Language, and Sorting and Paging.

PropertyFiltersSort
id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteNone
orderId$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteNone
source.appId$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteNone
source.externalId$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteNone
paymentGatewayOrderId$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteNone
title$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
description$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
status$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
orderNumber$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
expirationDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
createdDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
updatedDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
amount.amount$eq, $gt, $gte, $lt, $lteSort: ASC, DESC
Permissions
Manage eCommerce - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/v1/order-payment-requests/query

Errors

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

Did this help?