Magento Widerrufsbutton nun auch mit Rest-Api Anbindung

Seit der Version 2.2.0 ist eine Rest-Api für unsere Widerrufsbutton Erweiterung enthalten. Diese API-Anbindung erlaubt das automatische verarbeiten von Widerrufen. Per Rest-API können die Widerrufe im Shop abgerufen werden. Die Widerrufe selbst können dann z.B. in Ihrem ERP oder andere System automatisiert weiter verarbeitet werden.

Hier nähere Informationen zur Rest-API der Widerrufs-Erweiterung

Alle diese Informationen finden Sie auch in der Readme-Datei der Erweiterung

Endpoint: GET /V1/withdrawal/:contractWithdrawalId

Dieser erlaubt es Details zum widerrufenen Auftrag abzurufen über die Widerrufs-ID

URL: /rest/V1/withdrawal/:contractWithdrawalId

Example: /rest/V1/withdrawal/100
Example response:

{
    "id": "1",
    "order_increment_id": "000000001",
    "hash": "be1efa3fbb02e919f9078ec33f4e20374fe8e263e332706e39e2df1e21a42709",
    "source": 3,
    "customer_email": "customer@konvis.de",
    "holder_name": "John Doe",
    "scope": 1,
    "email_sent": 0,
    "status": 0,
    "store_id": 2,
    "created_at": "2026-06-25 16:55:53",
    "updated_at": "2026-06-25 16:55:53" 
}

Wenn es keinen entsprechende Item gibt, gibt die API einen 404 Fehler zurück und die Fehlermeldung "Contract Withdrawal with ID "%1" does not exist."

Endpoint: GET /V1/withdrawal/search

Dieser endpoint erlaubt es nach Widerrufen zu suchen basierend auf unterschiedlichen Kriterien. Wir verwenden die buil-In Search Kriterien von Adobe für diesen Zweck: https://developer.adobe.com/commerce/webapi/rest/use-rest/performing-searches

URL: /rest/V1/withdrawal/search
Example request:

Search by order increment ID:

GET /rest/V1/withdrawal/search?
searchCriteria[filterGroups][0][filters][0][field]=order_increment_id&
searchCriteria[filterGroups][0][filters][0][value]=000000001&
searchCriteria[filterGroups][0][filters][0][conditionType]=eq

Example response:

{
    "items": [
        {
            "order_increment_id": "000000001",
            "hash": "be1efa3fbb02e919f9078ec33f4e20374fe8e263e332706e39e2df1e21a42709",
            "source": 3,
            "customer_email": "customer@konvis.de",
            "holder_name": "John Doe",
            "scope": 1,
            "email_sent": 0,
            "status": 0,
            "store_id": 2,
            "created_at": "2026-06-25 16:55:53",
            "updated_at": "2026-06-25 16:55:53" 
        }
    ],
    "search_criteria": {
        "filter_groups": [
            {
                "filters": [
                    {
                        "field": "order_increment_id",
                        "value": "000000001",
                        "condition_type": "eq" 
                    }
                ]
            }
        ]
    },
    "total_count": 1
}

Get all withdrawal contracts:
Example request:

GET /rest/V1/withdrawal/search?searchCriteria

Example response:

{
    "items": [
        {
            "id": "1",
            "order_increment_id": "000000001",
            "hash": "be1efa3fbb02e919f9078ec33f4e20374fe8e263e332706e39e2df1e21a42709",
            "source": 3,
            "customer_email": "customer@konvis.de",
            "holder_name": "John Doe",
            "scope": 1,
            "email_sent": 0,
            "status": 0,
            "store_id": 2,
            "created_at": "2026-06-25 16:55:53",
            "updated_at": "2026-06-25 16:55:53" 
        },
        {
            "id": "2",
            "order_increment_id": "000040293",
            "hash": "8dd9663aea166e809071dfd00429c752d45768ecfbebbcbb1f984914db733a85",
            "source": 3,
            "customer_email": "customer@konvis.de",
            "holder_name": "John Doe",
            "note": "Test note",
            "scope": 2,
            "email_sent": 0,
            "status": 0,
            "store_id": 2,
            "created_at": "2026-06-26 14:48:10",
            "updated_at": "2026-06-26 14:48:10",
            "items": [
                {
                    "contract_id": 2,
                    "sku": "100200",
                    "name": "Product",
                    "qty_requested": "33.0000",
                    "created_at": "2026-06-26 14:48:10" 
                }
            ]
        }
    ],
    "search_criteria": {
        "filter_groups": []
    },
    "total_count": 2
}

Wenn kein Item gefunden wurde gibt die API ein leeres Array zurück. Somit das selbe Verhalten wie andere Magento 2 APIs verwenden, die Suchkritieren verwenden

[]

Wo kann die Magento Erweiterung für Widerruf gekauft werden?

Hier geht es zu ausführlichen Informationen der Widerrufsbutton-Erweiterung. Dort sehen Sie den aktuellen Stand der Entwicklung im Changelog. Die Erweiterung wird laufend verbessert und weiterentwickelt. Falls Funktionen fehlen sollten, sprechen Sie uns gerne an.