DOCS

Katalog-API

Bauen Sie Ihren Katalog für das verifizierte Konto programmgesteuert auf – direkt aus Ihrem eigenen System.

Die Katalog-API ist eine von drei Möglichkeiten, Ihren Katalog für das verifizierte Konto aufzubauen – die Option für Versender mit Entwicklerressourcen und einem System, das ihre Produktdaten bereits enthält: ein ERP-, WMS-, PIM-System oder eine Versandplattform. Dieses System bleibt die maßgebliche Datenquelle und schreibt Produkte direkt an Zonos, statt sie über eine Kanalintegration zu synchronisieren oder eine CSV-Datei hochzuladen. Wenn Sie über einen unterstützten Kanal verkaufen oder lieber keinen Code schreiben möchten, bauen diese beiden Optionen denselben Katalog mit weniger Aufwand auf.

Über die API erstellte Artikel werden genauso behandelt wie Artikel aus jeder anderen Quelle – sobald ein Artikel in Ihrem Katalog ist, spielt es für Zonos keine Rolle, wie er dorthin gelangt ist. Jeder Artikel wird für den Zoll klassifiziert, falls Sie keinen HS-Code angegeben haben, auf Anforderungen US-amerikanischer Partner Government Agencies (PGA) geprüft und zur Berechnung von Zöllen und Steuern für die Sendungen verwendet, in denen er enthalten ist.

Ein Teil davon liegt außerhalb der API. Wenn die PGA-Prüfung einen Artikel als Needs attention markiert, muss der zugehörige Konformitätsfragebogen im Dashboard beantwortet und bestätigt werden – dafür gibt es keine API. Zonos füllt vorab aus, was möglich ist, sodass die meiste Arbeit im Prüfen und Bestätigen besteht. Die Person, die diese Integration entwickelt, ist in der Regel nicht diejenige, die diese Markierungen bearbeitet. Planen Sie daher ein, dass jemand in Ihrem Unternehmen sie nach dem Laden Ihres Katalogs im Dashboard abarbeitet. Markierte Artikel sind nicht für den Versand gesperrt, aber wenn Sie sie vor dem Versand klären, verhindern Sie, dass eine Sendung an der US-Grenze angehalten wird.

So funktioniert es 

  1. Erstellen Sie für jedes Produkt, das Sie versenden, einen Katalogartikel.

  2. Stellen Sie sicher, dass jeder Artikel eine Kennung enthält, die Ihr Postdienstleister weitergibt.

  3. Wenn Ihre Sendungsdaten bei Zonos eingehen, wird jede Position Ihrem Katalogartikel zugeordnet, und die Produktdaten dieses Artikels fließen in die Berechnung ein.

Katalogartikel erstellen 

catalogItemCreate akzeptiert eine Liste, sodass Sie viele Produkte in einer einzigen Anfrage senden können.

1mutation CatalogItemCreate($input: [CatalogItemInput!]!) {
2 catalogItemCreate(input: $input) {
3 id
4 itemKey
5 name
6 productId
7 sku
8 hsCode
9 customsDescription
10 countryOfOrigin
11 }
12}

Dasselbe Produkt zweimal senden

Wenn Sie ein Produkt senden, dessen SKU oder Produkt-ID bereits existiert, aktualisiert Zonos dieses Produkt, statt ein zweites hinzuzufügen. Wiederholte Anfragen und erneute Durchläufe sind daher unbedenklich.

Die Kehrseite: Zwei unterschiedliche Produkte mit derselben SKU oder Produkt-ID werden zu einem zusammengeführt. Prüfen Sie Ihre Daten vor einem Massenimport auf Duplikate.

Felder

Feld↕Erforderlich↕Beschreibung↕
skuJa*Ihre eindeutige Kennung für das Produkt. *Jedes Produkt benötigt eine SKU oder eine Produkt-ID oder beides.
productIdJa*Die Kennung Ihrer Plattform für das Produkt. *Jedes Produkt benötigt eine SKU oder eine Produkt-ID oder beides.
nameJaDer Produktname.
customsDescriptionEmpfohlenWas das Produkt ist, in einfachen Worten, für die Zollanmeldung. Verwenden Sie „Baumwoll-T-Shirt“, nicht „Summer Vibes Tee“.
countryOfOriginEmpfohlenDer zweistellige ISO-Code des Herstellungslands. Wird für eine genaue Zollberechnung benötigt.
measurementsEmpfohlenGewicht und Abmessungen, die für die Tarifierung der Versandkosten und die Zollanmeldung verwendet werden.
hsCodeNeinDer international einheitliche 6-stellige HS-Code. Wenn Sie ihn weglassen, klassifiziert Zonos das Produkt anhand seines Namens und seiner Beschreibung.
amountNeinDer Produktpreis als Zahl.
currencyCodeNeinDer dreistellige ISO-Code der Preiswährung. Erforderlich, wenn Sie amount angeben.
itemTypeNeinPHYSICAL_GOOD, DIGITAL_GOOD, SERVICE, SUBSCRIPTION, BUNDLE oder PARTIAL_ITEM. Verhindert, dass nicht physische Artikel als Handelsware angemeldet werden.
provinceOfOriginNeinDer Bundesstaat oder die Provinz, aus der das Produkt stammt. Von einigen Bestimmungsländern vorgeschrieben.
productCompositionNeinEine Liste von {material, percentage}. Ohne diese Angabe können Textilien nicht über 6 Stellen hinaus klassifiziert werden.
catalogItemUrlNeinEin Link zur Produktseite auf Ihrer Website. Verbessert die Genauigkeit der Klassifizierung.
imageUrlNeinEine öffentlich zugängliche URL für das Produktbild. Verbessert die Genauigkeit der Klassifizierung.

Artikel zuordenbar machen 

Zonos verknüpft jede Sendungsposition anhand Ihrer Kennungen mit einem Katalogartikel, und zwar in dieser Reihenfolge: Produkt-ID, dann SKU, dann Name. Halten Sie die von Ihnen verwendeten Kennungen zwischen Ihrem Katalog und den Daten, die Sie an Ihren Versanddienstleister senden, korrekt und konsistent.

Für Postsendungen gilt eine weitere Einschränkung. Zonos erhält von Postdienstleistern nur eine begrenzte Anzahl von Feldern, und auf vielen Versandrouten ist die Zollbeschreibung das einzige Feld mit produktspezifischen Angaben. Eine Beschreibung, die in Ihrem gesamten Katalog identisch ist, kann für sich allein nichts identifizieren.

Hängen Sie Ihre Produkt-ID oder SKU an die Zollbeschreibung an, die Sie an Ihren Versanddienstleister senden.

Men's bifold wallet, cowhide leather - 123456

Die angehängte Kennung muss exakt mit der productId oder sku des entsprechenden Katalogartikels übereinstimmen.

Beschreibungsfelder sind kurz. Bei Canada Post sind beispielsweise nur etwa 49 Zeichen zulässig. Kürzen Sie daher den beschreibenden Teil, wenn Ihre Kennungen lang sind. Die Kennung ist wichtiger als der Beschreibungstext.

Es ist nicht erforderlich, die customsDescription des Artikels auf dieselbe Zeichenfolge zu setzen, die Sie an Ihren Versanddienstleister senden. Dadurch lassen sich beide Seiten jedoch direkt vergleichen, wenn eine Position nicht zugeordnet wird und Sie die Ursache ermitteln müssen.

Die Zuordnung schlägt häufig fehl, wenn:

  • die Kennung in der Beschreibung fehlt.
  • die Kennung keiner productId oder sku in Ihrem Katalog entspricht.
  • die Kennung durch die Zeichenbegrenzung des Versanddienstleisters abgeschnitten wird.
  • sich die Formatierung zwischen Sendungen ändert.

Dieses Verhalten wird noch finalisiert und kann sich vor dem Start ändern.

Katalogartikel aktualisieren 

catalogItemUpdate verwendet denselben Eingabetyp wie das Erstellen. Senden Sie nur die Felder, die Sie ändern möchten.

1mutation CatalogItemUpdate($input: [CatalogItemInput!]!) {
2 catalogItemUpdate(input: $input) {
3 id
4 itemKey
5 hsCode
6 customsDescription
7 }
8}

Hinweis: Weggelassene Felder bleiben unverändert, sodass Teilaktualisierungen unbedenklich sind. Das Senden von null löscht keinen Wert, sondern wird ignoriert. Sie können einen Wert durch einen anderen überschreiben, ihn über die API aber nicht leeren. Wenden Sie sich an Ihren Zonos-Ansprechpartner, wenn ein Feld geleert werden muss.

Artikel abrufen 

Die Abfrage catalogItem akzeptiert id, productId oder sku. Damit können Sie überprüfen, welche Daten Zonos für ein Produkt gespeichert hat.

1query CatalogItem($sku: String!) {
2 catalogItem(sku: $sku) {
3 id
4 itemKey
5 name
6 customsDescription
7 hsCode
8 productId
9 sku
10 countryOfOrigin
11 }
12}

Katalogartikel löschen 

catalogItemDelete erwartet Zonos-Katalogartikel-IDs, nicht Ihre SKUs oder Produkt-IDs. Ermitteln Sie die ID zuerst mit der Abfrage catalogItem.

1mutation CatalogItemDelete($input: [ID!]!) {
2 catalogItemDelete(input: $input)
3}

Verwandte Themen 

  • Kanalintegrationen – Synchronisieren Sie Ihren Katalog automatisch aus einem unterstützten Vertriebskanal.
  • CSV-Import – Laden Sie Katalogartikel mit einer Tabelle hoch, statt Code zu schreiben.
  • PGA-Prüfungen – Prüfen Sie Ihre Katalogartikel auf Anforderungen von US-Behörden (PGA).
  • So funktioniert der Katalog – Was Zonos mit Ihren Produktdaten macht.
GraphQL API ReferenceTypes, inputs, and operations used in this guide

War diese Seite hilfreich?