När en kund slutför checkout kan du skapa en partial shipment i nShift Checkout. En delvis försändelse innehåller leveransvalet (transportör/tjänst, utlämningsställe etc.), men den måste fortfarande slutföras (bokas) i nShift Ship för att generera sändningsnummer och etiketter.
Översikt
Detta är det typiska end-to-end-flödet:
- Skapa en delleverans i Checkout (Checkout API).
- Boka försändelsen i nShift Ship med hjälp av Post Shipment‑begäran för att generera etiketter och ett försändelsenummer.
Steg 1: Skapa den delvisa försändelsen i Checkout
När kunden har valt ett leveransalternativ, skapa en delvis försändelse med hjälp av Checkout API-dokumentationen: Create Partial Shipment.
Viktigt: Se till att du sparar identifieraren som du senare kommer att använda för att hitta ordern/försändelsen. Detta är vanligtvis orderID.
Steg 3: Slutför försändelsen genom att boka den i nShift Ship
För att slutföra en delvis försändelse bokar du den med metoden Post Shipment i Ship API. Detta skapar/bokar försändelsen och returnerar fraktetiketten.
| Viktig anmärkning: Du måste ha ShipAdvisor Import aktiverat i din Ship-konfiguration för att kunna slutföra delvisa försändelser från Checkout. Utan detta kan Ship inte matcha orderID med den delvisa försändelsen från Checkout. Konfigurationsposten ShipAdvisor Import måste aktiveras av nShift Customer Service för API- och Cloud-kunder. |
Vad du behöver inkludera för att boka korrekt
En bokad försändelse kräver ett komplett “data object” (mottagare, transportörprodukt/tjänst, paket/vikter etc.). Följande krävs, men endast den information som inte ingår i den delvisa försändelsen behövs för att slutföra försändelsen. I praktiken innehåller den delvisa försändelsen (från Checkout) vanligtvis inte allt som behövs för att slutföra bokningen.
- OrderID: läggs till i Options och hämtar data från den delvisa försändelsen från Checkout
-
Carrier service:
ProdConceptID -
Order number:
OrderNo -
Addresses: mottagare (
Kind: 1) och avsändare (Kind: 2) -
Packages / lines: till exempel vikter/dimensioner i
Lines - Goodstypes: krävs av vissa transportörer
-
Label format options: till exempel
"Labels": "ZPLGK" - Customs details: behövs vid försändelser över tullgränser
Varje transportör har sina egna specifikationer och krav – läs mer här: Identifiera obligatoriska fält vid bokning av försändelser
För mer information om att boka en försändelse, se How to - Book a Shipment
Exempel på begäran (ett paket)
Detta exempel visar en försändelse som innehåller adressinformation. Vanligtvis ingår adressuppgifter i den delvisa försändelsen från Checkout och behövs inte, men vissa transportörer kan kräva extra information beroende på sina krav.
curl -s -X POST "{{URL}}/ShipServer/{{ACTOR_ID}}/Shipments" \
-H "Authorization: {{TOKEN}}" \
-H "Content-Type: application/json" \
--data-raw "{
\"data\": {
\"OrderNo\": \"Test Shipment 1\",
\"Addresses\": [{
\"Kind\": 1,
\"Name1\": \"Test Receiver Name1\",
\"Street1\": \"Test Road 1\",
\"PostCode\": 7400,
\"City\": \"Herning\",
\"CountryCode\": \"DK\",
\"Phone\": \"12341234\",
\"Mobile\": \"12341234\",
\"Email\": \"noreply@nshift.com\",
\"Attention\": \"Test Attention\"
},{
\"Kind\": 2,
\"Name1\": \"Test Sender Name1\",
\"Street1\": \"Test Road 1\",
\"PostCode\": 6400,
\"City\": \"Sønderborg\",
\"CountryCode\": \"DK\",
\"Phone\": \"12341234\",
\"Mobile\": \"12341234\",
\"Email\": \"noreply@nshift.com\",
\"Attention\": \"Test Attention\"
}],
\"Lines\":[{
\"Number\": 1,
\"PkgWeight\": 10000,
\"Height\": 100,
\"Length\": 100,
\"Width\": 100,
\"GoodsTypeID\": 13
}]
},
\"options\": { \"Labels\": \"ZPLGK\" \"OrderID\":\"order123\" }
}"
Vad du får tillbaka
Svaret innehåller försändelseidentifierare (t.ex. sändningsnummer) och etikett-/dokumentinnehåll som du kan skriva ut eller vidarebefordra till efterföljande system.
Flödesschema som illustrerar en Checkout-integration med nShift Ship: