Anleitung zur API-Integration

Benutzerhandbuch zur Integration von PULPO WMS über API in Ihr ERP oder eine andere Software

M
Verfasst von Mariana Preciado Arias
Vor über einer Woche aktualisiert

Einführung

Dieses Dokument gibt Pulpo WMS Kunden einige Richtlinien zur Integration von ERP-Systemen. Zum besseren Verständnis ist es notwendig, die Swagger-Dokumentationen zu kennen.

(Siehe Getting started with Swagger UI für weitere Informationen)

Es gibt 2 verschiedene Arten der Datenübertragung:

  • Vom ERP zum Pulpo WMS über die Integration

  • Vom Pulpo WMS zum ERP:

    • Über die Integration

    • Anmeldung bei einem Webhook von PulpoWMS zu ERP (Echtzeit-Updates)

Entity-Übersicht

Das nächste Diagramm zeigt eine Übersicht über die wichtigsten Entitäten in Pulpo WMS. Beachten Sie, dass nicht alle Zuordnungen dargestellt sind.

Allgemeine API-Integration

Beschreibung, wie man sich am Pulpo WMS autorisiert, um weitere API-Aufrufe tätigen zu können.

Autorisierung

Die Autorisierung in Pulpo WMS erfolgt mit einem Oauth-Token, der in den Headern der späteren API-Aufrufe verwendet wird.

Ein Token ist 1 Stunde lang gültig.

Bitte fordern Sie nicht für jeden API-Aufruf ein neues Token an. Das System wird Ihre IP für eine gewisse Zeit sperren und es wird sich falsch verhalten.

Bitte implementieren Sie eine Fallback-Strategie für Fehlerszenarien

Beispiel-Anfrage

Antwort

Verwendung

Grunddaten

Um die meisten Daten erstellen zu können, benötigt die API die tenant_id. Um diese und andere Grunddaten zu erhalten, verwenden Sie bitte den folgenden Endpunkt:

Beachten Sie, dass Lager einem Benutzer zugewiesen werden müssen, um Vorgänge in jedem Lager ausführen zu können.

Rufen Sie Informationen zu einem oder mehreren Lagern ab.

Suche

Um nach mehreren Werten zu suchen, verwenden Sie bitte Klammern.

Zum Beispiel sucht diese Abfrage nach den Produkten 1456 und 1457:

/api/v1/inventory/products?id[]=1456&id[]=1457

Datenübertragung von Ihrem ERP zu Pulpo WMS

Folgende Daten werden üblicherweise vom ERP-System zum Pulpo WMS synchronisiert.

  • Wir empfehlen die folgende Umsetzung:

  • Ein regelmäßiger Job zur Synchronisation von Produkten, der die Lieferanten on the fly anlegt

  • Ein regelmäßiger Job zur Synchronisation von Bestellungen, der die Lieferanten on the fly anlegt

  • Ein regelmäßiger Job zur Synchronisation von Kundenaufträgen, der die Kunden on the fly" anlegt

Third parties - Kunden und Lieferanten

Produkte

Verkaufsaufträge

Bestellungen

Datenübertragung von Pulpo WMS zu Ihrem ERP

Folgende Daten werden üblicherweise vom Pulpo WMS System zum ERP-System synchronisiert.

Wir empfehlen folgende Implementierung für den in pulpo abgedeckten Standardprozess:

Wir empfehlen folgende Implementierung für den in pulpo abgedeckten Standardprozess:

  • Für die Bestandssynchronisation registrieren Sie die folgenden Webhooks mit der folgenden Funktionalität:

  • counting_task_finished: je nach Antwort wird der Bestand in Ihrem ERP-System hinzugefügt oder reduziert

  • eingehende_Ware_erstellt: erhöht den Bestand in Ihrem ERP-System

  • sales_order_finished: Lagerbestand in Ihrem ERP-System reduzieren

  • Vorsicht bei der Überprüfung, welche Produkte tatsächlich das Lager verlassen haben

  • Für Auftragsaktualisierungen registrieren Sie die folgenden Webhooks mit der folgenden Funktionalität:

    • sales_order_finished: aktualisiert den Status des Auftrags und registriert bei Bedarf Serien oder Chargen.

    • purchase_order_finished: Aktualisieren des Auftragsstatus und Registrieren von Serien oder Chargen, falls erforderlich

  • Für die Etikettenerstellung registrieren Sie die folgenden Webhooks mit der folgenden Funktionalität

    • packing_order_finished

    • Verpackungsboxen abfragen, um die Informationen über die Sendung zu erhalten

    • die Etiketten im externen System generieren

    • die Etiketten und shipment_tracking an jeden Karton anhängen. Pro Karton ist nur ein Etikett erlaubt

Beachten Sie, dass abhängig von der Individualität Ihres Prozesses diese Empfehlung modifiziert werden muss.

Bestand

Webhooks

Über Webhooks können Sie Echtzeitdaten von Pulpo WMS an ein anderes System weitergeben, indem Sie eine API registrieren, die eine bestimmte Nutzlast empfängt und verarbeitet

Hat dies Ihre Frage beantwortet?