API för egen kanal

En egen kanal låter din egen webbutik, ditt affärssystem eller ditt lagersystem skicka ordrar direkt in i Zippendo, när det inte finns någon färdig anslutning för det. Den här sidan går igenom varje kontroll i skapa-fönstret och kanalinställningarna, och hur en utvecklare skickar en order. Genomgången klick för klick är Anslut orderkanaler. Den fullständiga referensen för payload är Egna kanaler. Klicka på Orderkanaler i sidofältet och sedan på fliken Katalog. Kortet Egen kanal lyder Anslut din egen webbutik eller ditt affärssystem. Dess knapp är Skapa kanal.

Katalogen för orderkanaler med kortet Egen kanal och knappen Skapa kanal — Kortet Egen kanal i katalogen

Skapa kanalen

Klicka på Skapa kanal. Fönstret Skapa egen kanal öppnas: En orderkanal för din egen webbutik eller ditt affärssystem.

Fönstret Skapa egen kanal med Kanalens namn ifyllt som My webshop, Skapa kanal och Avbryt — Skapa egen kanal: ange ett Kanalens namn

Fält	Obligatoriskt	Vad du anger
Kanalens namn	Ja	Ett namn som du känner igen, till exempel ”My webshop”. Skapa kanal förblir inaktiv tills du anger ett.
Varumärke	Nej	Visas bara när din organisation har varumärken. Ordrar från den här kanalen tillhör det här varumärket.

Klicka på Skapa kanal (den visar Skapar…). Du ser Orderkanalen har skapats, och Zippendo öppnar den nya kanalens inställningar. Om du ser Det gick inte att skapa orderkanalen försöker du igen. Avbryt stänger fönstret.

Ordermottagning

Inställningssidan har kanalens namn som rubrik, med Din egen integration: skicka ordrar till mottagnings-URL:en eller använd API:et och SDK:erna. Visa dokumentationen öppnar referensen Egna kanaler.

Kortet Ordermottagning: Ditt system skickar signerade ordrar till mottagnings-URL:en nedan. Signera den råa bodyn i varje anrop med HMAC-SHA256 och signeringsnyckeln.

Kontroll	Vad den gör
Mottagnings-URL	Adressen som ditt system skickar ordrar till, på formen `https://api.zippendo.com/webhooks/order-channels/<channel id>`. Kopiera den från din egen kanal. Kopiera visar Har kopierats till urklipp., eller Det gick inte att kopiera till urklipp.
Skapa nyckel	Skapar signeringsnyckeln. Visar Skapar…, sedan Signeringsnyckeln har skapats. eller Det gick inte att skapa signeringsnyckeln.
Ersätt nyckel	Ersätter en befintlig nyckel. Zippendo ber dig bekräfta: ditt system avvisas tills det signerar med den nya nyckeln.
Återkalla	Stänger av nyckeln. Alla ordrar som ditt system skickar avvisas tills du skapar en ny nyckel. Visar Signeringsnyckeln har återkallats. eller Det gick inte att återkalla signeringsnyckeln.
Aktiv signeringsnyckel skapad	Följs av datum och tid då den nuvarande nyckeln skapades.

Kanalen tar bara emot ordrar när det finns en signeringsnyckel. Det finns inget separat reglage för att slå på ordermottagning. Efter Skapa nyckel eller Ersätt nyckel visas nyckeln en enda gång:

Ordermottagning med engångsnyckeln för signering, Kopiera, Återkalla och Ersätt nyckel — Kopiera signeringsnyckeln nu. Den visas bara en gång

Kopiera nyckeln nu. Den visas bara en gång. Om du ersätter den senare slutar den nuvarande nyckeln att fungera direkt. Nyckeln börjar med zwhs_. Spara den i ditt systems konfiguration.

Skicka en order

Skicka en POST till Mottagnings-URL med två headers:

Header	Värde
`X-Zippendo-Topic`	`order.created`, `order.updated`, `order.cancelled` eller `ping`
`X-Zippendo-Signature`	HMAC-SHA256 av den råa request-bodyn, hex-kodad, med signeringsnyckeln som nyckel

order.created och order.updated skapar eller uppdaterar båda ordern utifrån dess externalId. Bodyn för order.cancelled är { "externalId": "…" }. ping returnerar 200 { "received": true } utan att ändra något.

import crypto from "node:crypto"

const body = JSON.stringify(order)
const signature = crypto.createHmac("sha256", process.env.ZIPPENDO_WEBHOOK_SECRET)
  .update(body)
  .digest("hex")

await fetch(webhookUrl, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-Zippendo-Topic": "order.created",
    "X-Zippendo-Signature": signature
  },
  body
})

Obligatoriska payload-fält: externalId, orderNumber och orderLines (minst en rad med name och quantity). Valfria: customerName, customerEmail, shippingAddress, subtotalAmount, totalAmount, currency, notes, shippingMethodTitle och serviceCode. Fullständig fälttabell: Egna kanaler.

Status	Betydelse
`200`	Godkänd och bearbetad
`400`	Saknat eller okänt topic, en payload som inte klarade valideringen, eller Kanalen är aktiverad är av
`401`	Signaturkontrollen misslyckades: fel nyckel, saknad header eller ingen nyckel skapad än
`404`	Okänd kanal
`429`	För många ordrar på en gång. Försök igen efter fördröjningen i `Retry-After`
`5xx`	Bearbetningen misslyckades. Försök igen: det är säkert att skicka samma order på nytt

Föredrar du förfrågan och svar? Skapa ordrar med POST /orgs/{orgId}/orders, med orderChannelId, och en API-token. En andra order med samma externalId på samma kanal returnerar 409 ORDER_EXISTS. Om du vill få tillbaka spårningsnummer och statusändringar prenumererar du på din organisations webhooks (shipment.dispatched, tracking.updated). En egen kanal har ingen egen spårningscallback och ingen skärm för mappning av leveranssätt. En order som du skickar visas under Ordrar. Dess status kan vara Fel när Zippendo importerade ordern men inte kunde skapa en försändelse som är redo att skickas, till exempel för att ingen fraktregel matchade eller adressen är ofullständig. Ordern tillhör fortfarande kanalen.

Orderlistan med en order som kom in via en egen kanal — En order som skickats av ditt system på sidan Ordrar

Drift

Inställning	Sparas	Vad den gör
Kanalen är aktiverad	Direkt	Slår på eller av kanalen. När den är avstängd avvisar Zippendo alla ordrar som skickas till kanalen.
Skicka försändelser automatiskt	Med Spara ändringar	Skickar försändelsen till transportören automatiskt när en inkommande order matchar en fraktregel. Av som standard.
Varumärke	Direkt	Ordrar från den här kanalen tillhör det här varumärket. Listan visas bara när din organisation har varumärken.
Standardavsändaradress	Med Spara ändringar	Avsändaren för försändelser när ingen fraktregel matchar ordern. Om ingen är sparad än står det Inga adresser än i listan.
Senast mottagna order	Skrivskyddad	När kanalen senast tog emot en order, eller Aldrig.

Spara ändringar (Sparar…) sparar Skicka försändelser automatiskt och Standardavsändaradress. Du ser Orderkanalen har uppdaterats, eller Det gick inte att uppdatera orderkanalen.

Stäng av en kanal

Stäng av Kanalen är aktiverad. På fliken Ansluten står det då Inaktiverad på kanalens rad i kortet Egen kanal. Egna kanaler ligger alltid kvar på fliken Ansluten och blir aldrig kvarlämnade kanaler.

Sidan Orderkanaler med en egen kanal markerad som Inaktiverad — En egen kanal som är avstängd

Kvarlämnade Shopify- eller WooCommerce-kanaler, markerade Ingen aktiv anslutning och Frånkopplad, är något annat. Se Inställningar för orderkanaler.

Radera

Under Farozon hittar du Radera kanal: Radera den här egna kanalen. Din integration kan inte längre skicka ordrar till den.

Klicka på Radera och bekräfta: Radera den här egna kanalen? Dess mottagnings-URL slutar ta emot ordrar direkt. Du ser Orderkanalen har raderats, eller Det gick inte att radera orderkanalen.

Relaterat

Anslut orderkanaler

Skapa kanalen från katalogen och öppna sedan Ordrar.

Referens för egna kanaler

Fullständig payload, avbryt, ping och REST-exempel.

Inställningar för orderkanaler

Sidan Orderkanaler, varumärken och kvarlämnade kanaler.

Skapa en API-token

En token för POST /orgs/{orgId}/orders i stället för signerade push-anrop.

Översikt

Försändelser

Ordrar och orderkanaler

Transportörer

Anslut en transportör

Anslut en integration

Utskrift

Automatisering

Konto

Sök och dashboard

API och händelser

API för egen kanal

Skapa kanalen

Ordermottagning

Skicka en order

Drift

Stäng av en kanal

Radera

Relaterat

Anslut orderkanaler

Referens för egna kanaler

Inställningar för orderkanaler

Skapa en API-token

​Skapa kanalen

​Ordermottagning

​Skicka en order

​Drift

​Stäng av en kanal

​Radera

​Relaterat

Anslut orderkanaler

Referens för egna kanaler

Inställningar för orderkanaler

Skapa en API-token

Skapa kanalen

Ordermottagning

Skicka en order

Drift

Stäng av en kanal

Radera

Relaterat