Magento 2 API – How to Get Customer Order History

magento2ordersrest api

Get list of all previous orders of the customer using Customer token in API.

Best Answer

Solution 1

You can make your custom API for the same;

Using filter Builder you can use search criteria

$customerId = $this->userContext->getUserId();

$filter = $this->filterBuilder
               ->setField('customer_id')
               ->setValue($customerId)
               ->setConditionType('eq')
               ->create();
$this->searchCriteriaBuilder->addFilters([$filter]);

$searchCriteria = $this->searchCriteriaBuilder->create();

Solution 2

Magento is using resource Magento_Sales::sales because of this we can't access it using Customer's token so for the same we need to override Specific API with

<resource ref="self" />

And using this we can access all orders of specific customer using customer's Token in Magento API.

<route url="/V1/orders" method="GET">
        <service class="Magento\Sales\Api\OrderRepositoryInterface" method="getList"/>
        <resources>
            <resource ref="self" />
        </resources>
    </route>

Related Solutions

Magento 2 API – Get All Orders of Customer Using Customer’s Token

You should be able to filter out the orders of a single customer using the search query parameters like this:

https://<mage host>/rest/V1/orders/?searchCriteria[filterGroups][0][filters]
[0][field]=customer_id&searchCriteria[filterGroups][0][filters][0][value]=<customer_id>

This returns a list of orders on which you can loop and find out other information.

Magento 2 – How to Retrieve Customer Order History with REST API

To extend the rest API endpoint of orders(which is originally customer has no access) in order to access it using customer's token, You have to create a custom endpoint as well otherwise the endpoint /V1/orders will still inaccessible for the customer.
Check below example:

<?xml version="1.0"?>
<routes xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Webapi:etc/webapi.xsd">
    <route url="/V1/orders/custom" method="GET">
        <service class="Magento\Sales\Api\OrderRepositoryInterface" method="getList"/>
        <resources>
            <resource ref="self"/>
        </resources>
    </route>
</routes>

And you can use the custom endpoint /V1/orders/custom to get orders list of the customer using customer's token.

Best Answer

Related Solutions

Magento 2 API – Get All Orders of Customer Using Customer’s Token

Magento 2 – How to Retrieve Customer Order History with REST API

Related Topic