DOCS

Catalog API

Opbyg dit Verified Account-katalog programmatisk, direkte fra dit eget system.

Catalog API er en af tre måder at opbygge dit Verified Account-katalog på, og det er muligheden for forsendere med udviklerressourcer og et system, der allerede indeholder deres produktdata—et ERP-, WMS-, PIM-system eller en forsendelsesplatform. Det system forbliver den autoritative kilde og skriver produkter direkte til Zonos i stedet for at synkronisere fra en kanalintegration eller uploade en CSV-fil. Hvis du sælger via en understøttet kanal, eller hvis du helst ikke vil skrive kode, opbygger de to muligheder det samme katalog med mindre arbejde.

Varer, der oprettes via API'et, behandles præcis som varer fra enhver anden kilde—når en vare først er i dit katalog, er det ligegyldigt for Zonos, hvordan den kom derind. Hver vare klassificeres til toldformål, hvis du ikke har angivet en HS-kode, screenes for krav fra amerikanske Partner Government Agencies (PGA) og bruges til at beregne told og afgifter på de forsendelser, den indgår i.

Én del af det ligger uden for API'et. Når PGA-screeningen markerer en vare som Needs attention, skal det compliance-spørgeskema, der ligger bag markeringen, besvares og bekræftes i Dashboard—der findes ikke noget API til det, og Zonos udfylder på forhånd, hvad der kan udfyldes, så det meste af arbejdet består i at gennemgå og bekræfte. Den person, der bygger integrationen, er som regel ikke den samme, som rydder markeringerne, så planlæg, at nogen i din organisation gennemgår dem i Dashboard, når dit katalog er indlæst. Markerede varer blokeres ikke fra at blive sendt, men ved at rydde markeringerne, før du sender, undgår du, at en forsendelse bliver tilbageholdt ved den amerikanske grænse.

Sådan fungerer det 

  1. Opret en katalogvare for hvert produkt, du sender.

  2. Sørg for, at hver vare har en identifikator, som dit postselskab videregiver.

  3. Når dine forsendelsesdata når Zonos, matches hver linje tilbage til din katalogvare, og varens produktdata anvendes i beregningen.

Opret katalogvarer 

catalogItemCreate accepterer en liste, så du kan sende mange produkter i en enkelt anmodning.

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}

Afsendelse af det samme produkt to gange

Hvis du sender et produkt, hvis SKU eller produkt-id allerede findes, opdaterer Zonos det produkt i stedet for at tilføje et nyt. Genforsøg og gentagne kørsler er sikre.

Bagsiden er, at to forskellige produkter med samme SKU eller produkt-id bliver slået sammen til ét. Tjek dine data for dubletter før en masseindlæsning.

Felter

Felt↕Påkrævet↕Beskrivelse↕
skuJa*Din unikke identifikator for produktet. *Hvert produkt skal have en SKU eller et produkt-id, eller begge.
productIdJa*Din platforms identifikator for produktet. *Hvert produkt skal have en SKU eller et produkt-id, eller begge.
nameJaProduktnavnet.
customsDescriptionAnbefaletHvad produktet er, i klare vendinger, til tolderklæringen. Brug "Bomulds-t-shirt", ikke "Summer Vibes Tee".
countryOfOriginAnbefaletDen 2-bogstavs ISO-kode for, hvor produktet er fremstillet. Nødvendig for at beregne told nøjagtigt.
measurementsAnbefaletVægt og dimensioner, der bruges til fragtberegning og toldindberetning.
hsCodeNejDen universelle 6-cifrede HS-kode. Hvis du udelader den, klassificerer Zonos produktet ud fra navn og beskrivelse.
amountNejProduktets pris som et tal.
currencyCodeNejDen 3-bogstavs ISO-kode for prisens valuta. Påkrævet, når du angiver amount.
itemTypeNejPHYSICAL_GOOD, DIGITAL_GOOD, SERVICE, SUBSCRIPTION, BUNDLE eller PARTIAL_ITEM. Forhindrer, at ikke-fysiske varer deklareres som handelsvarer.
provinceOfOriginNejDen stat eller provins, hvor produktet har oprindelse. Kræves af nogle destinationslande.
productCompositionNejEn liste af {material, percentage}. Tekstiler kan ikke klassificeres ud over 6 cifre uden den.
catalogItemUrlNejEt link til produktsiden på dit website. Forbedrer klassificeringens nøjagtighed.
imageUrlNejEn offentligt tilgængelig URL til produktbilledet. Forbedrer klassificeringens nøjagtighed.

Gør dine varer matchbare 

Zonos forbinder hver forsendelseslinje med en katalogvare ved hjælp af dine identifikatorer i denne rækkefølge: produkt-id, derefter SKU og til sidst navn. Hold de identifikatorer, du bruger, nøjagtige og konsistente mellem dit katalog og de data, du sender til dit fragtselskab.

Postforsendelser har en yderligere begrænsning. Zonos modtager et begrænset sæt felter fra postselskaber, og på mange ruter er tolderklæringens varebeskrivelse det eneste felt, der indeholder noget produktspecifikt. En beskrivelse, der er identisk på tværs af hele dit katalog, kan ikke i sig selv identificere noget.

Tilføj dit produkt-id eller din SKU til slutningen af den toldbeskrivelse, du sender til dit fragtselskab.

Men's bifold wallet, cowhide leather - 123456

Den tilføjede identifikator skal matche productId eller sku på den tilsvarende katalogvare nøjagtigt.

Beskrivelsesfelter er korte. Indsendelser til Canada Post tillader for eksempel omkring 49 tegn, så forkort den beskrivende del, hvis dine identifikatorer er lange. Identifikatoren er vigtigere end teksten.

Det er ikke påkrævet at sætte varens customsDescription til den samme streng, som du sender til dit fragtselskab, men det gør de to sider direkte sammenlignelige, når en linje ikke matcher, og du skal finde ud af hvorfor.

Matchning mislykkes typisk, når:

  • Identifikatoren mangler i beskrivelsen.
  • Identifikatoren ikke svarer til nogen productId eller sku i dit katalog.
  • Identifikatoren afkortes af fragtselskabets tegngrænse.
  • Formateringen ændrer sig mellem forsendelser.

Denne funktionalitet er stadig under færdiggørelse og kan ændre sig før lancering.

Opdater katalogvarer 

catalogItemUpdate bruger den samme inputtype som oprettelse. Send kun de felter, du vil ændre.

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

Bemærk: Udeladte felter forbliver uændrede, hvilket gør delvise opdateringer sikre. At sende null rydder ikke en værdi, det ignoreres. Du kan overskrive en værdi med en anden, men du kan ikke tømme den via API'et. Kontakt din Zonos-repræsentant, hvis et felt skal ryddes.

Læs dine varer tilbage 

catalogItem-forespørgslen accepterer id, productId eller sku. Brug den til at bekræfte, hvilke data Zonos har for et produkt.

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}

Slet katalogvarer 

catalogItemDelete tager Zonos-katalogvare-id'er, ikke dine SKU'er eller produkt-id'er. Find først id'et med catalogItem-forespørgslen.

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

Relateret 

  • Kanalintegrationer — Synkroniser dit katalog automatisk fra en understøttet salgskanal.
  • CSV-import — Upload katalogvarer med et regneark i stedet for at skrive kode.
  • PGA-tjek — Screen dine katalogvarer for krav fra amerikanske myndigheder (PGA).
  • Sådan fungerer Catalog — Hvad Zonos gør med dine produktdata.
GraphQL API ReferenceTypes, inputs, and operations used in this guide
Book en demo

Var denne side nyttig?