Dieser Workflow zeigt die API-Aufrufe, die erforderlich sind, um bestimmte Sendungen in eine definierte Stack zu isolieren. Durch das Erstellen von Sendungen, das Anlegen einer Ziel-stack und die Verwendung des PATCH-Endpunkts mit den richtigen Identifikatoren (ShpTag, StackCSID) können Sie die Gruppierung von Sendungen vor der weiteren Verarbeitung, wie z. B. der EDI-Generierung, effektiv verwalten.
Voraussetzungen:
- Zugriff auf die Ship API mit gültigen Zugangsdaten (Client ID/Secret oder Benutzername/Passwort).
- Die Postman-Sammlung "Ship API - 2.0 Examples".
- Eine konfigurierte Umgebung. Siehe den Artikel zu Postman, um die Umgebung einzurichten:
Postman Collection - Erfolgreiche Authentifizierung (führen Sie die entsprechende Anfrage im Ordner "Authorization" aus).
Workflow-Schritte:
-
Testsendungen erstellen (Requests:
1. Create Test Shipment 1,2. Create Test Shipment 2):-
Aktion: Erstellen Sie neue Sendungen über den Endpunkt
POST /shipServer/{{ID}}/shipments. - Warum: Sie benötigen bestehende Sendungen, um sie zu verschieben. Nach der Erstellung landen sie in der Regel in einer Standard-stack, die dem gewählten Produkt/Subcarrier zugeordnet ist.
-
Wichtiges Ergebnis: Notieren Sie den
ShpTag(eindeutige Sendungs-ID), der für jede Sendung zurückgegeben wird.
-
Aktion: Erstellen Sie neue Sendungen über den Endpunkt
-
(Optional) Verfügbare Stacks abrufen (Request:
3. Get Available Stacks (Optional Check)):-
Aktion: Rufen Sie eine Liste aller vorhandenen Stacks über
GET /shipServer/{{ID}}/stacksab. -
Warum: Um die aktuellen Stacks und deren
StackCSIDzu sehen, bevor Sie eine neue erstellen oder eine bestehende Ziel-stack auswählen.
-
Aktion: Rufen Sie eine Liste aller vorhandenen Stacks über
-
Neue Ziel-stack erstellen (Request:
4. Create New Target Stack):-
Aktion: Erstellen Sie eine neue, leere Stack über
POST /shipServer/{{ID}}/stacks. Sie müssenSubcarrierConceptID(zu finden in der Antwort der Sendungserstellung oder im Get Stacks-Response) sowie einen gewünschtenStackNameangeben. - Warum: Um ein spezifisches Ziel für die Sendungen zu erstellen, die Sie verschieben möchten.
-
Wichtiges Ergebnis: Notieren Sie den
StackCSID(eindeutige Stack-ID) der neu erstellten Stack.
-
Aktion: Erstellen Sie eine neue, leere Stack über
-
Sendungen verschieben (Request:
5. Move Test Shipments to New Target Stack):-
Aktion: Aktualisieren Sie die Stack-Zuordnung für bestimmte Sendungen über
PATCH /shipServer/{{ID}}/stacks/shipments. - Warum: Dies ist der zentrale Schritt, bei dem die Sendungen verschoben werden.
-
Wichtige Eingaben: Geben Sie die Ziel-
StackCSID(aus Schritt 3) sowie ein Array vonShipmentTags(aus Schritt 1) für die zu verschiebenden Sendungen an.
-
Aktion: Aktualisieren Sie die Stack-Zuordnung für bestimmte Sendungen über
-
Bereinigung (Requests:
6. Cleanup...,7. Cleanup...,8. Cleanup...):-
Aktion: Löschen Sie die Testsendungen (
DELETE /shipServer/{{ID}}/shipments/:shipmentTag) und die neu erstellte Stack (DELETE /shipServer/{{ID}}/stacks/:stackCSID). - Warum: Um temporäre Testdaten nach der Überprüfung des Verschiebevorgangs aus dem System zu entfernen.
-
Aktion: Löschen Sie die Testsendungen (