List of orders

GET https://{baseUrl}/V1/storeview/{store-view-code}/dashboard/orders

Get paginated list of orders for the authenticated user. Uses the provided token to identify the user. At least one 'searchCriteria' parameter is required.

You can specify:

• searchCriteria[pageSize] — Number of records per page.
• searchCriteria[currentPage] — Page number to retrieve.

The default page size attempts to return all results, which may fail if the result set is very large.

Sorting is supported only by the 'entity_id' field in both ascending and descending order:

• searchCriteria[sortOrders][0][field] — Sorting field name.
• searchCriteria[sortOrders][0][direction] — Sorting direction ('asc' or 'desc').

To get the last five orders, set 'pageSize' to 5 and sort by 'entity_id' in descending order.

Examples:

• Paginated request: curl --location 'https://mygatewayurl.com/V1/storeview/default/dashboard/orders?searchCriteria[currentPage]=1&searchCriteria[pageSize]=2'
• Sort by 'entity_id' descending: curl --location 'https://mygatewayurl.com/V1/storeview/default/dashboard/orders?searchCriteria[sortOrders][0][field]=entity_id&searchCriteria[sortOrders][0][direction]=desc'
• Get last 5 orders: curl --location 'https://mygatewayurl.com/V1/storeview/default/dashboard/orders?searchCriteria[currentPage]=1&searchCriteria[pageSize]=5&searchCriteria[sortOrders][0][field]=entity_id&searchCriteria[sortOrders][0][direction]=desc'