Detta arbetsflöde demonstrerar de API-anrop som krävs för att isolera specifika sändningar i en angiven stack. Genom att skapa sändningar, skapa en mål-stack och använda PATCH-endpointen med rätt identifierare (ShpTag, StackCSID) kan du effektivt hantera gruppering av sändningar före vidare bearbetning, såsom generering av EDI.
Förutsättningar:
- Tillgång till Ship API med giltiga inloggningsuppgifter (Client ID/Secret eller användarnamn/lösenord).
- Postman-samlingen "Ship API - 2.0 Examples".
- En konfigurerad miljö. Se artikeln om Postman för hur du ställer in miljön:
Postman Collection - Lyckad autentisering (kör rätt förfrågan i mappen "Authorization").
Arbetsflödessteg:
-
Skapa testsändningar (förfrågningar:
1. Create Test Shipment 1,2. Create Test Shipment 2):-
Åtgärd: Skapa nya sändningar med endpointen
POST /shipServer/{{ID}}/shipments. - Varför: Du behöver befintliga sändningar för att kunna flytta dem. När de skapas placeras de vanligtvis i en standard stack som är kopplad till vald produkt/undertransportör.
-
Viktig output: Notera
ShpTag(unik sändningsidentifierare) som returneras för varje sändning.
-
Åtgärd: Skapa nya sändningar med endpointen
-
(Valfritt) Hämta tillgängliga stacks (förfrågan:
3. Get Available Stacks (Optional Check)):-
Åtgärd: Hämta en lista över alla befintliga stacks via
GET /shipServer/{{ID}}/stacks. -
Varför: För att se aktuella stacks och deras
StackCSIDinnan du skapar en ny eller väljer en befintlig mål-stack.
-
Åtgärd: Hämta en lista över alla befintliga stacks via
-
Skapa ny mål-stack (förfrågan:
4. Create New Target Stack):-
Åtgärd: Skapa en ny, tom stack via
POST /shipServer/{{ID}}/stacks. Du måste angeSubcarrierConceptID(finns i svaret från skapande av sändning eller Get Stacks) samt ett önskatStackName. - Varför: För att skapa en specifik destination för de sändningar du vill flytta.
-
Viktig output: Notera
StackCSID(unik stack-identifierare) för den nyskapade stacken.
-
Åtgärd: Skapa en ny, tom stack via
-
Flytta sändningar (förfrågan:
5. Move Test Shipments to New Target Stack):-
Åtgärd: Uppdatera stack-kopplingen för specifika sändningar via
PATCH /shipServer/{{ID}}/stacks/shipments. - Varför: Detta är huvudsteget där sändningarna flyttas.
-
Viktiga input: Ange mål-
StackCSID(från steg 3) samt en lista medShipmentTags(från steg 1) för de sändningar du vill flytta.
-
Åtgärd: Uppdatera stack-kopplingen för specifika sändningar via
-
Rensning (förfrågningar:
6. Cleanup...,7. Cleanup...,8. Cleanup...):-
Åtgärd: Ta bort testsändningarna (
DELETE /shipServer/{{ID}}/shipments/:shipmentTag) och den nya stacken (DELETE /shipServer/{{ID}}/stacks/:stackCSID). - Varför: För att rensa bort tillfälliga testdata från systemet efter att flytten har verifierats.
-
Åtgärd: Ta bort testsändningarna (