- Skicka in ordrar: ditt system skickar signerade webhook-händelser till kanalens egen ingest-URL, eller anropar REST API:t (officiella SDK:er finns).
- Få svar tillbaka: prenumerera på Zippendos utgående webhooks (
shipment.dispatched,tracking.updatedmed flera) för att ta emot spårningsnummer och statusändringar.
1. Skapa kanalen
Klicka på Orderkanaler i app.zippendo.com, öppna fliken Katalog och klicka på Skapa kanal på kortet Egen kanal. Eller skapa den via API:t:2. Skapa signeringsnyckeln
Klicka på Skapa nyckel på kanalens inställningssida, eller anropaPOST /orgs/{orgId}/order-channels/{channelId}/webhook-secret. Svaret innehåller ingest-URL:en och nyckeln:
3. Skicka in ordrar
Skicka enPOST till ingest-URL:en med två headers:
Orderdata (order.created / order.updated)
Båda ämnena beter sig likadant: ordern upsertas på externalId, så omleveranser och uppdateringar i fel ordning är säkra. Skicka den som ditt system tycker är enklast.
Annulleringsdata (order.cancelled)
Anslutningstest (ping)
Alla signerade kroppar med X-Zippendo-Topic: ping returnerar 200 { "received": true } utan att ändra några data. Använd det för att kontrollera din signeringskod.
Svar
Vad som händer med en inskickad order
- Ordern upsertas i kanalen (och ärver kanalens varumärke, om det finns något).
- En fraktregel avgörs: den uttryckliga
serviceCode, annars kanalens kopplingar för leveranssätt matchade motshippingMethodTitle. - En försändelse skapas. Försändelser med en matchad regel är redo att skickas. När bara en Standardavsändaradress är angiven skapas ett utkast i stället.
- Om Skicka försändelser automatiskt är på för kanalen skickas en försändelse med en matchad regel till transportören direkt, och fraktetiketten hamnar i Zippendo (automatisk utskrift på regeln gäller).
REST som alternativ
Om du hellre vill ha förfrågan/svar än webhooks skapar du ordrar via API:t med en API-token:- En dubblett av
externalIdpå samma kanal returnerar409 ORDER_EXISTS. Behandla det som “redan mottagen”. - Om du anger
shippingRuleIdellershippingMethodTitle(eller slår på Skicka försändelser automatiskt för kanalen) skapas försändelsen i samma anrop, precis som vid en push. - Orderkanaler ingår i det publika API:t, så SDK:erna täcker varje steg: skapa kanalen, skapa nyckeln, skicka in ordrar och lista försändelser.
Få tillbaka spårning
Zippendo meddelar ditt system via utgående webhooks: prenumerera påshipment.dispatched och tracking.updated under Inställningar → Webhooks. Försändelser har ditt ordernummer som sin reference, och datan innehåller orderId för uppslag.
Nästa steg
Utgående webhooks
Ta emot spårnings- och statushändelser och verifiera våra signaturer.
API-referens
Varje endpoint för orderkanaler och ordrar, med exempel.