Using filters to retrieve multiple results from an endpoint

Use an in operator with the filter parameter in your query strings to retrieve multiple results from the customers, orders, payments, and other filterable endpoints without having to fetch the items one at a time.

Query syntax
The full query syntax is {{baseUrl}}/v3/merchants/{{mId}}/{{category}}?filter=id in ('UUID','UUID2','...UUID100')

// Get a specific list of payments

https://sandbox.dev.clover.com/v3/merchants/J0W118EPG42WE1/payments?filter=id in ('CAB2S7XMQWXZ0',
'09C7AVKDN0Y6M','9DMB0EN7MTGG6','4RFE9NFRW3ZW2','0ZNYGJSGLAHE8', 'HASPS123ZSKPM','B3VFPNG321218',
'D1SVMJP0CY8HH','AWRE3VEAKRD1Q')

📘

NOTE

There is no minimum number of items for a request; however, Clover recommends retrieving no more than 100 items per query to avoid hitting limits and performance issues.


Did this page help you?