Deze workflow demonstreert de API-calls die nodig zijn om specifieke zendingen te isoleren in een aangewezen stack. Door zendingen aan te maken, een doel-stack te creëren en het PATCH-endpoint te gebruiken met de juiste identificatoren (ShpTag, StackCSID) kun je de groepering van zendingen effectief beheren voordat verdere verwerking plaatsvindt, zoals het genereren van EDI.
Vereisten:
- Toegang tot de Ship API met geldige inloggegevens (Client ID/Secret of gebruikersnaam/wachtwoord).
- De Postman-collectie "Ship API - 2.0 Examples".
- Een geconfigureerde omgeving. Zie het artikel over Postman voor het instellen van de omgeving:
Postman Collection - Succesvolle authenticatie (voer het juiste verzoek uit in de map "Authorization").
Workflowstappen:
-
Testzendingen aanmaken (requests:
1. Create Test Shipment 1,2. Create Test Shipment 2):-
Actie: Maak nieuwe zendingen aan via het
POST /shipServer/{{ID}}/shipments-endpoint. - Waarom: Je hebt bestaande zendingen nodig om te verplaatsen. Bij aanmaak worden ze meestal in een standaard stack geplaatst die gekoppeld is aan het gekozen product/subcarrier.
-
Belangrijke output: Noteer de
ShpTag(unieke zending-ID) die voor elke zending wordt teruggegeven.
-
Actie: Maak nieuwe zendingen aan via het
-
(Optioneel) Beschikbare stacks ophalen (request:
3. Get Available Stacks (Optional Check)):-
Actie: Haal een lijst op van alle bestaande stacks via
GET /shipServer/{{ID}}/stacks. -
Waarom: Om de huidige stacks en hun
StackCSIDte bekijken voordat je een nieuwe aanmaakt of een bestaande doel-stack kiest.
-
Actie: Haal een lijst op van alle bestaande stacks via
-
Nieuwe doel-stack aanmaken (request:
4. Create New Target Stack):-
Actie: Maak een nieuwe, lege stack aan via
POST /shipServer/{{ID}}/stacks. Je moet deSubcarrierConceptIDopgeven (te vinden in de response van het aanmaken van zendingen of Get Stacks) en een gewensteStackName. - Waarom: Om een specifieke bestemming te creëren voor de zendingen die je wilt verplaatsen.
-
Belangrijke output: Noteer de
StackCSID(unieke stack-ID) van de nieuw aangemaakte stack.
-
Actie: Maak een nieuwe, lege stack aan via
-
Zendingen verplaatsen (request:
5. Move Test Shipments to New Target Stack):-
Actie: Werk de stack-toewijzing bij voor specifieke zendingen via
PATCH /shipServer/{{ID}}/stacks/shipments. - Waarom: Dit is de kernstap waarin zendingen worden verplaatst.
-
Belangrijke input: Geef de doel-
StackCSID(uit stap 3) en een array vanShipmentTags(uit stap 1) op voor de zendingen die je wilt verplaatsen.
-
Actie: Werk de stack-toewijzing bij voor specifieke zendingen via
-
Opschonen (requests:
6. Cleanup...,7. Cleanup...,8. Cleanup...):-
Actie: Verwijder de testzendingen (
DELETE /shipServer/{{ID}}/shipments/:shipmentTag) en de nieuw aangemaakte stack (DELETE /shipServer/{{ID}}/stacks/:stackCSID). - Waarom: Om tijdelijke testdata uit het systeem te verwijderen nadat de verplaatsing is geverifieerd.
-
Actie: Verwijder de testzendingen (