Retrieves a paginated list of invoices for the authenticated user (based on the provided token). You can use pageSize and currentPage parameters to paginate through results.
If no pagination are provided, the API attempts to return all invoices, which may fail if the result set is large. In such cases, use searchCriteria to filter results by field or specify a smaller pageSize.
Sample Curl
curl --location 'https://mygatewayurl.com/V1/storeview/default/dashboard/invoices?searchCriteria[filterGroups][0][filters][0][value]=3&searchCriteria[filterGroups][0][filters][0][field]=order_id&searchCriteria[filterGroups][0][filters][0][conditionType]=eq&searchCriteria[currentPage]=1&searchCriteria[pageSize]=2'
Sort can be performed on entity_id ascending and descending. A higher entity_id is a newer invoice.
Sample Curl
curl --location 'https://mygatewayurl.com/V1/storeview/default/dashboard/invoices?searchCriteria[filterGroups][0][filters][0][value]=3&searchCriteria[filterGroups][0][filters][0][field]=order_id&searchCriteria[filterGroups][0][filters][0][conditionType]=eq&searchCriteria[sortOrders][0][field]=entity_id&searchCriteria[sortOrders][0][direction]=desc'
You can get the last five invoice by specifying 5 as page-size parameter.
Sample Curl
curl --location 'https://mygatewayurl.com/V1/storeview/default/dashboard/invoices?searchCriteria[currentPage]=1&searchCriteria[pageSize]=5&searchCriteria[filterGroups][0][filters][0][value]=3&searchCriteria[filterGroups][0][filters][0][field]=order_id&searchCriteria[filterGroups][0][filters][0][conditionType]=eq'
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||